@dvcol/neo-svelte/dist/skeletons/neo-skeleton-text.model.d.ts

Neomorphic ui library for svelte 5

import type { Snippet } from 'svelte';
import type { NeoSkeletonContainerProps } from './neo-skeleton-container.model.js';
import type { HTMLTransitionProps } from '../utils/action.utils.js';
import type { HTMLNeoBaseElement, HTMLRefProps } from '../utils/html-element.utils.js';
import type { SizeInput } from '../utils/style.utils.js';
export type NeoSkeletonTextProps = {
    /**
     * Snippet to display as the skeleton content.
     */
    children?: Snippet;
    /**
     * Whether to show the skeleton.
     */
    loading?: boolean;
    /**
     * Number of paragraphs to show.
     */
    paragraphs?: string | number;
    /**
     * Number of lines/words to show in each paragraph.
     */
    lines?: string | number | number[];
    /**
     * Number of lines/words to show in each paragraph if no lines are provided.
     *
     * @default 6 or 26 if `alt` is true
     */
    fallback?: number | string;
    /**
     * Whether to enable the skeleton container.
     */
    disabled?: boolean;
    /**
     * Whether to show the alternative style (with various text segments of different sizes).
     */
    alt?: boolean;
    /**
     * Whether to show the title.
     */
    title?: boolean;
    /**
     * Justify the text to fill the width of the container.
     */
    justify?: boolean;
    /**
     * Overrides the default flex value.
     */
    flex?: CSSStyleDeclaration['flex'];
    /**
     * Alignment strategy for the skeleton.
     */
    align?: CSSStyleDeclaration['alignSelf'];
    /**
     * Optional width constraints.
     */
    width?: SizeInput<'width'>;
    /**
     * Optional height constraints.
     */
    height?: SizeInput<'height'>;
    /**
     * Whether to add glass like transparency to the skeleton.
     */
    glass?: boolean;
    /**
     * Reverse the direction of the container.
     * Flow from right to left by default.
     */
    reverse?: boolean;
    /**
     * Props for the title div.
     */
    titleProps?: HTMLNeoBaseElement;
    /**
     * Props for the paragraph div.
     */
    paragraphProps?: HTMLNeoBaseElement;
    /**
     * Props to pass to the skeleton container.
     */
    containerProps?: Omit<NeoSkeletonContainerProps, 'children' | 'content' | 'containerProps'>;
    /**
     * Props to pass to the transition container.
     */
    transitionProps?: NeoSkeletonContainerProps['containerProps'];
} & Pick<HTMLTransitionProps, 'in' | 'out'> & HTMLRefProps & HTMLNeoBaseElement;