@rhds/elements
Version:
Red Hat Design System Elements
25 lines (24 loc) • 918 B
TypeScript
import { LitElement } from 'lit';
/**
* A skeleton displays an animated placeholder that mimics the structure and layout of actual content while it loads.
* It gives users a preview of what's coming and reduces perceived loading time.
*
* @summary A placeholder for content that is loading.
*
* @alias skeleton
*/
export declare class RhSkeleton extends LitElement {
static readonly styles: CSSStyleSheet[];
/** What shape the skeleton should be. Defaults to `body-copy`. */
type?: 'body-copy' | 'heading' | 'circle' | 'square' | 'rectangle';
/** What size the skeleton should be. Defaults to `md`.
* The `size` attribute is not valid on circle, square, or rectangle skeletons.
*/
size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl';
render(): import("lit-html").TemplateResult<1>;
}
declare global {
interface HTMLElementTagNameMap {
'rh-skeleton': RhSkeleton;
}
}