Skeleton
Provide a placeholder while you wait for content to load, or to visualize content that doesn't exist yet.
When to use
- When a resource needs long time to load.
- When the component contains lots of information, such as List or Card.
- Only works when loading data for the first time.
- Could be replaced by Spin in any situation, but can provide a better user experience.
Examples
API
Skeleton, Skeleton.Avatar, Skeleton.Button, Skeleton.Input, Skeleton.Image, and Skeleton.Node are exported from @ceebee/ui/client.
Skeleton
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
active | Show animation effect | boolean | false | — |
avatar | Show avatar placeholder | boolean | SkeletonAvatar | false | — |
loading | Display the skeleton when true | boolean | - | — |
paragraph | Show paragraph placeholder | boolean | SkeletonParagraphProps | true | — |
round | Show paragraph and title radius when true | boolean | false | — |
title | Show title placeholder | boolean | SkeletonTitleProps | true | — |
width | Set the width of title | number | string | - | — |
rows | Set the row count of paragraph | number | - | — |
width | Set the width of paragraph. When width is an Array, it can set the width of each row. Otherwise only set the last row width | number | string | Array<number | string> | - | — |
Skeleton.Avatar
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
active | Show animation effect, only valid when used avatar independently | boolean | false | — |
shape | Set the shape of avatar | circle | square | circle | — |
size | Set the size of avatar | number | large | medium | small | medium | — |
Skeleton.Button
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
active | Show animation effect | boolean | false | — |
block | Option to fit button width to its parent width | boolean | false | 4.17.0 |
shape | Set the shape of button | circle | round | square | default | - | — |
size | Set the size of button | large | medium | small | medium | — |
Skeleton.Input
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
active | Show animation effect | boolean | false | — |
size | Set the size of input | large | medium | small | medium | — |