Askr documentation
Generated API snapshot

@askrjs/themes/skeleton

Exports from the declarations published in @askrjs/themes. Signatures reflect the published artifact.

Exports

This entrypoint publishes 4 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.

Skeletontype

Skeleton: { (props: SkeletonProps): JSX.Element; (props: SkeletonAsChildProps): JSX.Element; }

Loading placeholder block with configurable width/height, hidden from assistive tech via aria-hidden, rendered as a <div> or merged onto a child via asChild.

SkeletonAsChildPropstype

SkeletonAsChildProps: SkeletonOwnProps & {
  asChild: true;
  children: JSXElement;
  ref?: Ref<unknown>;
}

Props for {@link Skeleton } rendered with asChild, merging its attributes onto a single child element.

asChild
asChild: true;
children
children: JSXElement;
height
height?: string | number | undefined;
ref
ref?: Ref<unknown>;
width
width?: string | number | undefined;

SkeletonOwnPropstype

SkeletonOwnProps: {
  children?: unknown;
  height?: string | number;
  width?: string | number;
}

Props shared by both {@link Skeleton } call signatures.

children
children?: unknown;
height
height?: string | number | undefined;
width
width?: string | number | undefined;

SkeletonPropstype

SkeletonProps: Omit<JSX.IntrinsicElements["div"], "children" | "ref"> & SkeletonOwnProps & {
  asChild?: false;
  ref?: Ref<HTMLDivElement>;
}

Props for {@link Skeleton } rendered as its default <div> element.

asChild
asChild?: false | undefined;
children
children?: unknown;
height
height?: string | number | undefined;
ref
ref?: Ref<HTMLDivElement>;
width
width?: string | number | undefined;