Leave Yamada UI a star

Star
Yamada UIYamada UIv1.7.2

Skeleton

Skeleton is a component that acts as a placeholder until content is loaded.

Source@yamada-ui/skeleton

Props

SkeletonProps

colorScheme

Description

The visual color appearance of the component.

Type

"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"

endColor

Description

The color at the animation end.

Type

UIValue<"border" | Color | ({} & string) | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | ... 318 more ... | "yellow.950">

fadeDuration

Description

The fadeIn duration in seconds. Requires isLoaded toggled to true in order to see the transition.

Type

string | number

Default

0.4

fitContent

Description

If true, the skeleton will take the width of it's children.

Type

boolean

Default

false

isFitContent

Deprecated

Description

If true, the skeleton will take the width of it's children.

Deprecated

Use fitContent instead.

Type

boolean

Default

false

isLoaded

Deprecated

Description

If true, it'll render its children with a nice fade transition.

Deprecated

Use loaded instead.

Type

boolean

Default

false

loaded

Description

If true, it'll render its children with a nice fade transition.

Type

boolean

Default

false

size

Description

The size of the Skeleton.

Type

string

speed

Description

The animation speed in seconds.

Type

string | number

Default

0.8

startColor

Description

The color at the animation start.

Type

UIValue<"border" | Color | ({} & string) | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | ... 318 more ... | "yellow.950">

variant

Description

The variant of the Skeleton.

Type

string

SkeletonCircleProps

endColor

Description

The color at the animation end.

Type

UIValue<"border" | Color | ({} & string) | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | ... 318 more ... | "yellow.950">

fadeDuration

Description

The fadeIn duration in seconds. Requires isLoaded toggled to true in order to see the transition.

Type

string | number

Default

0.4

fitContent

Description

If true, the skeleton will take the width of it's children.

Type

boolean

Default

false

isFitContent

Deprecated

Description

If true, the skeleton will take the width of it's children.

Deprecated

Use fitContent instead.

Type

boolean

Default

false

isLoaded

Deprecated

Description

If true, it'll render its children with a nice fade transition.

Deprecated

Use loaded instead.

Type

boolean

Default

false

loaded

Description

If true, it'll render its children with a nice fade transition.

Type

boolean

Default

false

speed

Description

The animation speed in seconds.

Type

string | number

Default

0.8

startColor

Description

The color at the animation start.

Type

UIValue<"border" | Color | ({} & string) | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | ... 318 more ... | "yellow.950">

SkeletonTextProps

endColor

Description

The color at the animation end.

Type

UIValue<"border" | Color | ({} & string) | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | ... 318 more ... | "yellow.950">

fadeDuration

Description

The fadeIn duration in seconds. Requires isLoaded toggled to true in order to see the transition.

Type

string | number

Default

0.4

fitContent

Description

If true, the skeleton will take the width of it's children.

Type

boolean

Default

false

isLoaded

Deprecated

Description

If true, it'll render its children with a nice fade transition.

Deprecated

Use loaded instead.

Type

boolean

Default

false

loaded

Description

If true, it'll render its children with a nice fade transition.

Type

boolean

Default

false

speed

Description

The animation speed in seconds.

Type

string | number

Default

0.8

startColor

Description

The color at the animation start.

Type

UIValue<"border" | Color | ({} & string) | "amber.50" | "amber.100" | "amber.200" | "amber.300" | "amber.400" | "amber.500" | "amber.600" | "amber.700" | "amber.800" | "amber.900" | ... 318 more ... | "yellow.950">

textHeight

Description

The CSS height property.

Type

UIValue<number | "px" | "-moz-initial" | "inherit" | "initial" | "revert" | "revert-layer" | "unset" | (string & {}) | "2xl" | "lg" | "md" | "sm" | "xl" | ({} & string) | "-moz-max-content" | ... 68 more ... | "xs">

Edit this page on GitHub

PreviousLoadingNextProgress