GitHub
/
ant-design
6
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

docs: format api popconfirm/result/skeleton/spin (#25390)

pull/25397/head
xrkffgg 4 years ago
committed by GitHub
parent
cbd93324cc
commit
a7a75eaeef
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 27 additions and 27 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 14
      components/popconfirm/index.en-US.md
  2. 8
      components/popconfirm/index.zh-CN.md
  3. 10
      components/result/index.en-US.md
  4. 2
      components/result/index.zh-CN.md
  5. 6
      components/skeleton/index.en-US.md
  6. 4
      components/skeleton/index.zh-CN.md
  7. 10
      components/spin/index.en-US.md

14
components/popconfirm/index.en-US.md
View File

@ -17,16 +17,16 @@ The difference with the `confirm` modal dialog is that it's more lightweight tha
| Param | Description | Type | Default value |
| --- | --- | --- | --- |
| cancelText | text of the Cancel button | string | `Cancel` |
| okText | text of the Confirm button | string | `OK` |
| cancelText | The text of the Cancel button | string | `Cancel` |
| okText | The text of the Confirm button | string | `OK` |
| okType | Button `type` of the Confirm button | string | `primary` |
| okButtonProps | The ok button props | [ButtonProps](/components/button/#API) | - |
| cancelButtonProps | The cancel button props | [ButtonProps](/components/button/#API) | - |
| title | title of the confirmation box | string\|ReactNode\|() => ReactNode | - |
| onCancel | callback of cancel | function(e) | - |
| onConfirm | callback of confirmation | function(e) | - |
| icon | customize icon of confirmation | ReactNode | `<ExclamationCircle />` |
| disabled | is show popconfirm when click its childrenNode | boolean | false |
| title | The title of the confirmation box | string \| ReactNode \| () => ReactNode | - |
| onCancel | A callback of cancel | function(e) | - |
| onConfirm | A callback of confirmation | function(e) | - |
| icon | Customize icon of confirmation | ReactNode | &lt;ExclamationCircle /> |
| disabled | Whether show popconfirm when click its childrenNode | boolean | false |
Consult [Tooltip's documentation](/components/tooltip/#API) to find more APIs.

8
components/popconfirm/index.zh-CN.md
View File

@ -18,15 +18,15 @@ cover: https://gw.alipayobjects.com/zos/alicdn/fjMCD9xRq/Popconfirm.svg
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| cancelText | 取消按钮文字 | string | 取消 |
| okText | 确认按钮文字 | string | 确定 |
| cancelText | 取消按钮文字 | string | `取消` |
| okText | 确认按钮文字 | string | `确定` |
| okType | 确认按钮类型 | string | `primary` |
| okButtonProps | ok 按钮 props | [ButtonProps](/components/button/#API) | - |
| cancelButtonProps | cancel 按钮 props | [ButtonProps](/components/button/#API) | - |
| title | 确认框的描述 | string\|ReactNode\|() => ReactNode | - |
| title | 确认框的描述 | string \| ReactNode \| () => ReactNode | - |
| onCancel | 点击取消的回调 | function(e) | - |
| onConfirm | 点击确认的回调 | function(e) | - |
| icon | 自定义弹出气泡 Icon 图标 | ReactNode | `<ExclamationCircle />` |
| icon | 自定义弹出气泡 Icon 图标 | ReactNode | &lt;ExclamationCircle /> |
| disabled | 点击 Popconfirm 子元素是否弹出气泡确认框 | boolean | false |
更多属性请参考 [Tooltip](/components/tooltip/#API)。

10
components/result/index.en-US.md
View File

@ -16,8 +16,8 @@ Use when important operations need to inform the user to process the results and
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| title | title string | ReactNode | - |
| subTitle | subTitle string | ReactNode | - |
| status | result status,decide icons and colors | `success` \| `error` \| `info` \| `warning` \| `404` \| `403` \| `500` | `info` |
| icon | custom back icon | ReactNode | - |
| extra | operating area | ReactNode | - |
| title | The title | ReactNode | - |
| subTitle | The subTitle | ReactNode | - |
| status | Result status, decide icons and colors | `success` \| `error` \| `info` \| `warning` \| `404` \| `403` \| `500` | `info` |
| icon | Custom back icon | ReactNode | - |
| extra | Operating area | ReactNode | - |

2
components/result/index.zh-CN.md
View File

@ -19,6 +19,6 @@ cover: https://gw.alipayobjects.com/zos/alicdn/9nepwjaLa/Result.svg
| --- | --- | --- | --- |
| title | title 文字 | ReactNode | - |
| subTitle | subTitle 文字 | ReactNode | - |
| status | 结果的状态,决定图标和颜色 | `success` \| `error` \| `info` \| `warning` \| `404` \| `403` \| `500` | `info` |
| status | 结果的状态，决定图标和颜色 | `success` \| `error` \| `info` \| `warning` \| `404` \| `403` \| `500` | `info` |
| icon | 自定义 icon | ReactNode | - |
| extra | 操作区 | ReactNode | - |

6
components/skeleton/index.en-US.md
View File

@ -23,16 +23,16 @@ Provide a placeholder while you wait for content to load, or to visualise conten
| --- | --- | --- | --- |
| active | Show animation effect | boolean | false |
| avatar | Show avatar placeholder | boolean \| [SkeletonAvatarProps](#SkeletonAvatarProps) | false |
| loading | Display the skeleton when `true` | boolean | - |
| loading | Display the skeleton when true | boolean | - |
| paragraph | Show paragraph placeholder | boolean \| [SkeletonParagraphProps](#SkeletonParagraphProps) | true |
| title | Show title placeholder | boolean \| [SkeletonTitleProps](#SkeletonTitleProps) | true |
| round | Show paragraph and title radius when `true` | boolean | false |
| round | Show paragraph and title radius when true | boolean | false |
### SkeletonAvatarProps
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| active | Show animation effect, only valid when used avatar independently. | boolean | false |
| active | Show animation effect, only valid when used avatar independently | boolean | false |
| size | Set the size of avatar | number \| `large` \| `small` \| `default` | - |
| shape | Set the shape of avatar | `circle` \| `square` | - |

4
components/skeleton/index.zh-CN.md
View File

@ -24,10 +24,10 @@ cover: https://gw.alipayobjects.com/zos/alicdn/KpcciCJgv/Skeleton.svg
| --- | --- | --- | --- |
| active | 是否展示动画效果 | boolean | false |
| avatar | 是否显示头像占位图 | boolean \| [SkeletonAvatarProps](#SkeletonAvatarProps) | false |
| loading | 为 `true` 时，显示占位图。反之则直接展示子组件 | boolean | - |
| loading | 为 true 时，显示占位图。反之则直接展示子组件 | boolean | - |
| paragraph | 是否显示段落占位图 | boolean \| [SkeletonParagraphProps](#SkeletonParagraphProps) | true |
| title | 是否显示标题占位图 | boolean \| [SkeletonTitleProps](#SkeletonTitleProps) | true |
| round | 为 `true` 时，段落和标题显示圆角 | boolean | false |
| round | 为 true 时，段落和标题显示圆角 | boolean | false |
### SkeletonAvatarProps

10
components/spin/index.en-US.md
View File

@ -15,12 +15,12 @@ When part of the page is waiting for asynchronous data or during a rendering pro
| Property | Description | Type | Default Value |
| --- | --- | --- | --- |
| delay | specifies a delay in milliseconds for loading state (prevent flush) | number (milliseconds) | - |
| delay | Specifies a delay in milliseconds for loading state (prevent flush) | number (milliseconds) | - |
| indicator | React node of the spinning indicator | ReactNode | - |
| size | size of Spin, options: `small`, `default` and `large` | string | `default` |
| spinning | whether Spin is spinning | boolean | true |
| tip | customize description content when Spin has children | string | - |
| wrapperClassName | className of wrapper when Spin has children | string | - |
| size | The size of Spin, options: `small`, `default` and `large` | string | `default` |
| spinning | Whether Spin is spinning | boolean | true |
| tip | Customize description content when Spin has children | string | - |
| wrapperClassName | The className of wrapper when Spin has children | string | - |
### Static Method

Write Preview
Loading…
Cancel
Save