mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-12-13 23:59:12 +08:00
Code Issues Actions 16 Packages Projects Releases Wiki Activity
ab5cab02f1
ant-design/components/skeleton/index.en-US.md
Rustin 7a5fc8bb19 feat: add skeleton avatar (#19898) 
* move avatar default props into skeleton

* #18237 complete skeleton avatar

* update skeleton avatar docs

* add more tests for skeleton avatar

* refactor class and props name

* revert Avatar props name

* combine avatar and button demo

* update demo and test snapshots

* move active props into element
2019-12-03 13:33:04 +08:00

2.3 KiB
Raw Blame History

category type title cols
Components Feedback Skeleton 1

Provide a placeholder while you wait for content to load, or to visualise 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.

API

Skeleton

Property Description Type Default
active Show animation effect boolean false
avatar Show avatar placeholder boolean | SkeletonAvatarProps false
loading Display the skeleton when true boolean -
paragraph Show paragraph placeholder boolean | SkeletonParagraphProps true
title Show title placeholder boolean | SkeletonTitleProps true

SkeletonAvatarProps

Property Description Type Default
active Show animation effect, only valid when used avatar independently. boolean false
size Set the size of avatar number | Enum{ 'large', 'small', 'default' } -
shape Set the shape of avatar Enum{ 'circle', 'square' } -

SkeletonTitleProps

Property Description Type Default
width Set the width of title number | string -

SkeletonParagraphProps

Property Description Type Default
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> -

SkeletonButtonProps

Property Description Type Default
active Show animation effect boolean false
size Set the size of button Enum{ 'large', 'small', 'default' } -
shape Set the shape of button Enum{ 'circle', 'round', 'default' } -