@workday/canvas-kit-react/dist/commonjs/skeleton/lib/skeleton.d.ts

The parent module that contains all Workday Canvas Kit React components

import * as React from 'react';
export interface SkeletonProps {
    /**
     * For accessibility reasons, `aria-label` is transformed into a text representation
     * (visually hidden, but announced by screen readers) of the loader.
     *
     * IMPORTANT: Since we take over the use of `aria-label` here, the attribute
     * does not get applied to the container element. We anticipate that this will change
     * in a future major version.
     * @default 'Loading'
     */
    'aria-label'?: string;
    children?: React.ReactNode;
}
/**
 * Skeleton subcomponents **must** be wrapped by the `Skeleton` container component.
 *
 * ```tsx
 * <Skeleton>
 *   <Skeleton.Header />
 *   <Skeleton.Text />
 * </Skeleton>
 * ```
 *
 * `Skeleton` places its children in a container element with `aria-hidden` set to `true` and
 * announces itself using a visually hidden element.
 */
export declare const Skeleton: import("@workday/canvas-kit-react/common").ElementComponent<"div", SkeletonProps> & {
    /**
     * `Skeleton.Header` renders a placeholder for header content such as headings.
     */
    Header: import("@workday/canvas-kit-react/common").ElementComponent<"div", import("./parts/skeletonHeader").SkeletonHeaderProps>;
    /**
     * `Skeleton.Text` renders a placeholder for text content such as paragraphs. Each placeholder
     * line has a width of `100%` and a fixed height of `21px`, with the last line having a width of
     * `60%` if there are multiple lines.
     */
    Text: import("@workday/canvas-kit-react/common").ElementComponent<"div", import("./parts/skeletonText").SkeletonTextProps>;
    /**
     * `Skeleton.Shape` renders a placeholder for graphic elements such as icons, avatars and small
     * images. Set the `height`, `width`, and `borderRadius` props of the `Skeleton.Shape` to create
     * various rectangular and circular shapes.
     */
    Shape: import("@workday/canvas-kit-react/common").ElementComponent<"div", import("./parts/skeletonShape").SkeletonShapeProps>;
};
//# sourceMappingURL=skeleton.d.ts.map