Skip to content

Commit e14ef11

Browse files
marcod1419agorovyi
authored andcommitted
docs(community-skeleton): add usage docs
1 parent a44b8ff commit e14ef11

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed
40.7 KB
Loading

packages/Skeleton/Skeleton.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
### Basic Usage
2+
3+
By default, `Skeleton` will be set to 100% width with a line height of 18px.
4+
15
```jsx
26
<Skeleton />
37
```
8+
9+
### Controlling Size
10+
11+
The height and width of the `Skeleton` can be customized to match the line height of the text that is being loaded. The `size` prop adjusts the line height, and the `characters` prop will adjust the width in increments of the selected `size`.
12+
13+
| `size` Option | Line Height |
14+
| ------------- | ----------- |
15+
| xs | 18px |
16+
| sm | 24px |
17+
| md | 36px |
18+
| lg | 48px |
19+
| xl | 64px |
20+
21+
```jsx
22+
<Skeleton characters={10} size="md" />
23+
```

0 commit comments

Comments
 (0)