Skeleton API

API documentation for Skeleton component

Skeleton#

Props#

Defines valid properties in Skeleton component.

name	type	default	description
ref	Ref<unknown>	null	The reference to the component instance.
pIf	boolean	true	Whether the component should be rendered.
style	CSSProperties \| ((instance?: SkeletonInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: SkeletonInstance) => string)	null	The class name to apply to the component.
as	string \| number \| bigint \| boolean \| ComponentClass<any, any> \| FunctionComponent<any> \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode, any, any> \| ReactPortal \| Promise<AwaitedReactNode>	null	The component type to render.
asChild	boolean	false	Whether the component should be rendered as a child component.
pt	SafeRecord<SkeletonPassThrough>	null	The pass-through props to pass to the component
ptOptions	PassThroughOptions	null	The pass-through options to pass to the component
unstyled	boolean	null	Whether the component should be rendered without classes.
dt	unknown	null	The design token to use for the component.
styles	StylesOptions<ComponentInstance>	null	The styles to use for the component.
children	ReactNode \| ((instance: SkeletonInstance) => ReactNode)	null	The children to render.
shape	"circle" \| "rectangle"	rectangle	Shape of the element.
size	string	null	Size of the Circle or Square.
width	string	100%	Width of the element.
height	string	1rem	Height of the element.
borderRadius	string	null	Border radius of the element, defaults to value from theme.
animation	"none" \| "wave"	wave	Type of the animation.
[key: string]	any	null
pt-{optionName}-*	-	null	Pass through attributes for customizing component. For more info, see Pass Through tab.

Interfaces#

PassThroughOptions

Defines passthrough(pt) options of Skeleton component.

name	type	default	description
root	SkeletonPassThroughType<HTMLAttributes<HTMLDivElement>>	null	Used to pass attributes to the root's DOM element.

Types#

Instance

Instance of Skeleton component.

values
ComponentInstance<SkeletonProps, SkeletonState, SkeletonExposes>

useSkeleton#

Types#

Instance

Instance of useSkeleton headless.

values
HeadlessInstance<useSkeletonProps, useSkeletonState, useSkeletonExposes>