@stihl-design-system/components
Version:
Welcome to the STIHL Design System react component library.
30 lines (29 loc) • 1.14 kB
TypeScript
import { HTMLAttributes, JSX } from 'react';
import { Theme } from '../../types';
import { SkeletonTextSize, SkeletonVariant } from './Skeleton.utils';
export interface SkeletonProps extends HTMLAttributes<HTMLDivElement> {
/** Number of text lines to render (multi-line variant only, minimum 2).
* @default 3
*/
textLineCount?: number;
/** Size token – determines the line height for single-line and multi-line variants.
* Required for `single-line` and `multi-line` variants.
* @default 'text-medium'
*/
textSize?: SkeletonTextSize;
/** Defines the theme.
* @default 'light'
*/
theme?: Theme;
/** Visual shape variant.
* @default 'single-line'
*/
variant?: SkeletonVariant;
}
/**
* A placeholder loading indicator that mimics the shape of content
* before it has loaded.
*
* Design in Figma: [Skeleton](https://www.figma.com/design/qXldpLO6gxHJNLdcXIPxYt/Core-Components-%F0%9F%92%A0?node-id=168-3943&t=UBsmFURFENnuYSW1-11)
*/
export declare const DSSkeleton: ({ className, textSize, textLineCount, theme, variant, ...rest }: SkeletonProps) => JSX.Element;