Skip to content

Commit

Permalink
docs(module:skeleton): update index.en-US.md (#7446)
Browse files Browse the repository at this point in the history
  • Loading branch information
arturovt committed May 26, 2022
1 parent 0c9287a commit 03c6153
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions components/skeleton/doc/index.en-US.md
Expand Up @@ -6,14 +6,14 @@ cols: 1
cover: https://gw.alipayobjects.com/zos/alicdn/KpcciCJgv/Skeleton.svg
---

Provide a placeholder while you wait for content to load, or to visualise content that doesn't exist yet.
Provide a placeholder while you wait for content to load or visualize content that doesn't exist yet.

## When To Use

- When resource need long time loading, like low network speed.
- The component contains much information, such as List or Card.
- When resource needs long time loading, like low network speed.
- The component contains information, such as a 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.
- Could be replaced by Spin in any situation but can provide a better user experience.

```ts
import { NzSkeletonModule } from 'ng-zorro-antd/skeleton';
Expand All @@ -28,30 +28,30 @@ import { NzSkeletonModule } from 'ng-zorro-antd/skeleton';
| `[nzActive]` | Show animation effect | `boolean` | `false` |
| `[nzAvatar]` | Show avatar placeholder | `boolean \| NzSkeletonAvatar` | `false` |
| `[nzLoading]` | Display the skeleton when `true` | `boolean` | - |
| `[nzParagraph]` | Show paragraph placeholder | `boolean \| NzSkeletonParagraph` | `true` |
| `[nzTitle]` | Show title placeholder | `boolean \| NzSkeletonTitle` | `true` |
| `[nzRound]` | Show paragraph and title radius when `true` | `boolean` | `false` |
| `[nzParagraph]` | Show the paragraph placeholder | `boolean \| NzSkeletonParagraph` | `true` |
| `[nzTitle]` | Show the title placeholder | `boolean \| NzSkeletonTitle` | `true` |
| `[nzRound]` | Show the paragraph and the title radius when `true` | `boolean` | `false` |


### NzSkeletonAvatar

| Property | Description | Type | Default |
| --- | --- | --- | --- |
| `size` | Set the size of avatar | `number |\ 'large' \| 'small' \| 'default'` | - |
| `shape` | Set the shape of avatar | `'circle' \| 'square'` | - |
| `size` | Set the avatar size | `number |\ 'large' \| 'small' \| 'default'` | - |
| `shape` | Set the avatar shape | `'circle' \| 'square'` | - |

### NzSkeletonTitle

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

### NzSkeletonParagraph

| 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>` | - |
| `rows` | Set the row count of the paragraph | `number` | - |
| `width` | Set the width of the 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>` | - |

### nz-skeleton-element [nzType="button"]

Expand Down

0 comments on commit 03c6153

Please sign in to comment.