Skip to content

Commit

Permalink
docs: documents can be converted to data (NG-ZORRO#2734)
Browse files Browse the repository at this point in the history
* docs: documents can be converted to data

- 使用【|】中文竖线符,表示 Union Types
    - 例如:【有四种选择 `success`、`info`、`warning`、`error`】**应**在【类型列】表示【`success|info|warning|error`】
- 【参数列】
    - 保持纯粹性
        - 例如:【`[nzValidateStatus]`(Reactive Forms)】**应**在【说明列】统一描述
- 【类型列】
    - **应**包含【``】代码包裹(保护 `TemplateRef<void>` 的有效性)
- 【默认值列】
    - 保持纯粹性
        - 例如:【`info`,`banner` 模式下默认值为 `warning`】**应**把额外描述放置【说明列】
    - 无默认值时**应**使用【-】替代,“无”应替代成【-】
- 站点样式:强制移除【类型列】所有 `code` 样式

## 完整示例

| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| `[nzBanner]` | 是否用作顶部公告 | `boolean` | `false` |
| `[nzCloseText]` | 自定义关闭按钮 | `string|TemplateRef<void>` | - |
| `[nzShowIcon]` | 是否显示辅助图标,`nzBanner` 模式下默认值为 `true` | `boolean` | `false` |
| `[nzType]` | 指定警告提示的样式,`nzBanner` 模式下默认值为 `warning` | `success丨info丨warning丨error` | `info` |
| `[nzValidateStatus]` | (Reactive Forms)会根据 FormControl 的状态自动生成校验状态 | `FormControl丨FormControlName` | `nz-form-control` 中包裹的第一个 `FormControl`  |
| `[nzValidateStatus]` | (Template-driven Forms)校验状态 | `success丨warning丨error丨validating` | - |

* chore: remove code style in Type column

* docs: fix missing & losing component name

* docs: update all

* chore: remove type and default column  code style

* chore: 移除中文竖线,全部使用英文全角坚线

* chore: 修正不同组件之间相互引用相同属性

* chore: fix losing nz-popover in english

* docs: remove 'or'
  • Loading branch information
cipchk authored and Ricbet committed Apr 9, 2020
1 parent 42e9e44 commit 49416ea
Show file tree
Hide file tree
Showing 107 changed files with 1,313 additions and 1,296 deletions.
6 changes: 3 additions & 3 deletions components/affix/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Please note that Affix should not cover other content on the page, especially wh

| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| `[nzOffsetBottom]` | Pixels to offset from bottom when calculating position of scroll | number | - |
| `[nzOffsetTop]` | Pixels to offset from top when calculating position of scroll | number | 0 |
| `[nzTarget]` | specifies the scrollable area dom node | `string, HTMLElement` | `window` |
| `[nzOffsetBottom]` | Pixels to offset from bottom when calculating position of scroll | `number` | - |
| `[nzOffsetTop]` | Pixels to offset from top when calculating position of scroll | `number` | `0` |
| `[nzTarget]` | specifies the scrollable area dom node | `stringHTMLElement` | `window` |
| `(nzChange)` | Callback for when affix state is changed | `EventEmitter<boolean>` | - |

**Note:** Children of `nz-affix` can not be `position: absolute`, but you can set `nz-affix` as `position: absolute`:
Expand Down
8 changes: 4 additions & 4 deletions components/affix/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ title: Affix

| 成员 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| `[nzOffsetBottom]` | 距离窗口底部达到指定偏移量后触发 | number | |
| `[nzOffsetTop]` | 距离窗口顶部达到指定偏移量后触发 | number | |
| `[nzTarget]` | 设置 `nz-affix` 需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数 | `string, HTMLElement` | `window` |
| `(nzChange)` | 固定状态改变时触发的回调函数 | `EventEmitter<boolean>` | |
| `[nzOffsetBottom]` | 距离窗口底部达到指定偏移量后触发 | `number` | - |
| `[nzOffsetTop]` | 距离窗口顶部达到指定偏移量后触发 | `number` | `0` |
| `[nzTarget]` | 设置 `nz-affix` 需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数 | `stringHTMLElement` | `window` |
| `(nzChange)` | 固定状态改变时触发的回调函数 | `EventEmitter<boolean>` | - |

**注意:**`nz-affix` 内的元素不要使用绝对定位,如需要绝对定位的效果,可以直接设置 `nz-affix` 为绝对定位:

Expand Down
16 changes: 8 additions & 8 deletions components/alert/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ Alert component for feedback.

| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| `[nzBanner]` | Whether to show as banner | boolean | false |
| `[nzClosable]` | Whether Alert can be closed | boolean | - |
| `[nzCloseText]` | Close text to show | string|`TemplateRef<void>` | - |
| `[nzDescription]` | Additional content of Alert | string|`TemplateRef<void>` | - |
| `[nzMessage]` | Content of Alert | string|`TemplateRef<void>` | - |
| `[nzShowIcon]` | Whether to show icon | boolean | false, in `nzBanner` mode default is true |
| `[nzIconType]` | Icon type, effective when `nzShowIcon` is `true` | `stringstring[]Set<string>{ [klass: string]: any; };` | - |
| `[nzType]` | Type of Alert styles, options: `success`, `info`, `warning`, `error` | string | `info`, in `banner` mode default is `warning` |
| `[nzBanner]` | Whether to show as banner | `boolean` | `false` |
| `[nzClosable]` | Whether Alert can be closed | `boolean` | - |
| `[nzCloseText]` | Close text to show | `string|TemplateRef<void>` | - |
| `[nzDescription]` | Additional content of Alert | `string|TemplateRef<void>` | - |
| `[nzMessage]` | Content of Alert | `string|TemplateRef<void>` | - |
| `[nzShowIcon]` | Whether to show icon, in `nzBanner` mode default is `true` | `boolean` | `false` |
| `[nzIconType]` | Icon type, effective when `nzShowIcon` is `true` | `stringstring[]Set<string>{ [klass: string]: any; }` | - |
| `[nzType]` | Type of Alert styles, in `nzBanner` mode default is `'warning'` | `'success'|'info'|'warning'|'error'` | `'info'` |
| `(nzOnClose)` | Callback when Alert is closed | `EventEmitter<void>` | - |
16 changes: 8 additions & 8 deletions components/alert/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ title: Alert

| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| `[nzBanner]` | 是否用作顶部公告 | boolean | false |
| `[nzClosable]` | 默认不显示关闭按钮 | boolean | |
| `[nzCloseText]` | 自定义关闭按钮 | string|`TemplateRef<void>` | |
| `[nzDescription]` | 警告提示的辅助性文字介绍 | string|`TemplateRef<void>` | |
| `[nzMessage]` | 警告提示内容 | string|`TemplateRef<void>` | |
| `[nzShowIcon]` | 是否显示辅助图标 | boolean | false,`nzBanner` 模式下默认值为 true |
| `[nzIconType]` | 自定义图标类型,`nzShowIcon``true` 时有效 | `stringstring[]Set<string>{ [klass: string]: any; };` | - |
| `[nzType]` | 指定警告提示的样式,有四种选择 `success``info``warning``error` | string | `info``banner` 模式下默认值为 `warning` |
| `[nzBanner]` | 是否用作顶部公告 | `boolean` | `false` |
| `[nzClosable]` | 默认不显示关闭按钮 | `boolean` | - |
| `[nzCloseText]` | 自定义关闭按钮 | `string|TemplateRef<void>` | - |
| `[nzDescription]` | 警告提示的辅助性文字介绍 | `string|TemplateRef<void>` | - |
| `[nzMessage]` | 警告提示内容 | `string|TemplateRef<void>` | - |
| `[nzShowIcon]` | 是否显示辅助图标`nzBanner` 模式下默认值为 `true` | `boolean` | `false` |
| `[nzIconType]` | 自定义图标类型,`nzShowIcon``true` 时有效 | `stringstring[]Set<string>{ [klass: string]: any; }` | - |
| `[nzType]` | 指定警告提示的样式,`nzBanner` 模式下默认值为 `'warning'` | `'success'|'info'|'warning'|'error'` | `'info'` |
| `(nzOnClose)` | 关闭时触发的回调函数 | `EventEmitter<void>` | - |
16 changes: 8 additions & 8 deletions components/anchor/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@ For displaying anchor hyperlinks on page and jumping between them.

| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| `[nzAffix]` | Fixed mode of Anchor | boolean | true |
| `[nzBounds]` | Bounding distance of anchor area | number | 5(px) |
| `[nzOffsetBottom]` | Pixels to offset from bottom when calculating position of scroll | number | - |
| `[nzOffsetTop]` | Pixels to offset from top when calculating position of scroll | number | 0 |
| `[nzShowInkInFixed]` | Whether show ink-balls in Fixed mode | boolean | false |
| `[nzTarget]` | Scrolling container | `string, HTMLElement` | `window` |
| `[nzAffix]` | Fixed mode of Anchor | `boolean` | `true` |
| `[nzBounds]` | Bounding distance of anchor area, unit: px | `number` | `5` |
| `[nzOffsetBottom]` | Pixels to offset from bottom when calculating position of scroll | `number` | - |
| `[nzOffsetTop]` | Pixels to offset from top when calculating position of scroll | `number` | `0` |
| `[nzShowInkInFixed]` | Whether show ink-balls in Fixed mode | `boolean` | `false` |
| `[nzTarget]` | Scrolling container | `stringHTMLElement` | `window` |
| `(nzClick)` | Click of Anchor item | `EventEmitter<string>` | - |
| `(nzScroll)` | The scroll function that is triggered when scrolling to an anchor. | `EventEmitter<NzAnchorLinkComponent>` | - |

### nz-link

| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| `[nzHref]` | target of hyperlink | string | |
| `[nzTitle]` | content of hyperlink | string丨`TemplateRef<void>` | |
| `[nzHref]` | target of hyperlink | `string` | - |
| `[nzTitle]` | content of hyperlink | `string|TemplateRef<void>` | - |
16 changes: 8 additions & 8 deletions components/anchor/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@ title: Anchor

| 成员 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| `[nzAffix]` | 固定模式 | boolean | true |
| `[nzBounds]` | 锚点区域边界 | number | 5(px) |
| `[nzOffsetBottom]` | 距离窗口底部达到指定偏移量后触发 | number | |
| `[nzOffsetTop]` | 距离窗口顶部达到指定偏移量后触发 | number | |
| `[nzShowInkInFixed]` | 固定模式是否显示小圆点 | boolean | false |
| `[nzTarget]` | 指定滚动的容器 | `string, HTMLElement` | `window` |
| `[nzAffix]` | 固定模式 | `boolean` | `true` |
| `[nzBounds]` | 锚点区域边界,单位:px | `number` | `5` |
| `[nzOffsetBottom]` | 距离窗口底部达到指定偏移量后触发 | `number` | - |
| `[nzOffsetTop]` | 距离窗口顶部达到指定偏移量后触发 | `number` | - |
| `[nzShowInkInFixed]` | 固定模式是否显示小圆点 | `boolean` | `false` |
| `[nzTarget]` | 指定滚动的容器 | `stringHTMLElement` | `window` |
| `(nzClick)` | 点击项触发 | `EventEmitter<string>` | - |
| `(nzScroll)` | 滚动至某锚点时触发 | `EventEmitter<NzAnchorLinkComponent>` | - |

### nz-link

| 成员 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| `[nzHref]` | 锚点链接 | string | |
| `[nzTitle]` | 文字内容 | string丨`TemplateRef<void>` | |
| `[nzHref]` | 锚点链接 | `string` | - |
| `[nzTitle]` | 文字内容 | `string|TemplateRef<void>` | - |
4 changes: 2 additions & 2 deletions components/auto-complete/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ When there is a need for autocomplete functionality.
| `[nzDataSource]` | Data source for autocomplete | `AutocompleteDataSource` | - |
| `[nzDefaultActiveFirstOption]` | Whether active first option by default | `boolean` | `true` |
| `[nzWidth]` | Custom width, unit px | `number` | trigger element width |
| `[nzOverlayClassName]` | Class name of the dropdown root element | string | - |
| `[nzOverlayStyle]` | Style of the dropdown root element | object | - |
| `[nzOverlayClassName]` | Class name of the dropdown root element | `string` | - |
| `[nzOverlayStyle]` | Style of the dropdown root element | `object` | - |

### nz-auto-option

Expand Down
4 changes: 2 additions & 2 deletions components/auto-complete/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ subtitle: 自动完成
| `[nzDataSource]` | 自动完成的数据源 | `AutocompleteDataSource` | - |
| `[nzDefaultActiveFirstOption]` | 是否默认高亮第一个选项。 | `boolean` | `true` |
| `[nzWidth]` | 自定义宽度单位 px | `number` | 触发元素宽度 |
| `[nzOverlayClassName]` | 下拉根元素的类名称 | string | - |
| `[nzOverlayStyle]` | 下拉根元素的样式 | object | - |
| `[nzOverlayClassName]` | 下拉根元素的类名称 | `string` | - |
| `[nzOverlayStyle]` | 下拉根元素的样式 | `object` | - |

### nz-auto-option

Expand Down
10 changes: 5 additions & 5 deletions components/avatar/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Avatars can be used to represent people or objects. It supports images, `Icon`s,

| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| `[nzIcon]` | the `Icon` type for an icon avatar, see `Icon` | string | - |
| `[nzShape]` | the shape of avatar | `circle``square` | `circle` |
| `[nzSize]` | the size of the avatar | `large``small``default`number | `default` |
| `[nzSrc]` | the address of the image for an image avatar | string | - |
| `[nzText]` | letter type avatar | string | - |
| `[nzIcon]` | the `Icon` type for an icon avatar, see `Icon` | `string` | - |
| `[nzShape]` | the shape of avatar | `'circle'|'square'` | `'circle'` |
| `[nzSize]` | the size of the avatar | `'large'|'small'|'default'|number` | `'default'` |
| `[nzSrc]` | the address of the image for an image avatar | `string` | - |
| `[nzText]` | letter type avatar | `string` | - |
10 changes: 5 additions & 5 deletions components/avatar/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ title: Avatar

| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| `[nzIcon]` | 设置头像的图标类型,参考 `Icon` | string | - |
| `[nzShape]` | 指定头像的形状 | Enum{ 'circle', 'square' } | `circle` |
| `[nzSize]` | 设置头像的大小 | Enum{ 'large', 'small', 'default', number } | `default` |
| `[nzSrc]` | 图片类头像的资源地址 | string | - |
| `[nzText]` | 文本类头像 | string | - |
| `[nzIcon]` | 设置头像的图标类型,参考 `Icon` | `string` | - |
| `[nzShape]` | 指定头像的形状 | `'circle''square'` | `'circle'` |
| `[nzSize]` | 设置头像的大小 | `'large''small''default'number` | `'default'` |
| `[nzSrc]` | 图片类头像的资源地址 | `string` | - |
| `[nzText]` | 文本类头像 | `string` | - |
2 changes: 1 addition & 1 deletion components/back-top/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ title: BackTop
| --- | --- | --- | --- |
| `[nzTemplate]` | custom content | `TemplateRef<void>` | - |
| `[nzVisibilityHeight]` | the `nz-back-top` button will not show until the scroll height reaches this value | `number` | `400` |
| `[nzTarget]` | specifies the scrollable area dom node | `string, Element` | `window` |
| `[nzTarget]` | specifies the scrollable area dom node | `stringElement` | `window` |
| `(nzClick)` | a callback function, which can be executed when you click the button | `EventEmitter<boolean>` | - |

2 changes: 1 addition & 1 deletion components/back-top/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ title: BackTop
| --- | --- | --- | --- |
| `[nzTemplate]` | 自定义内容,见示例 | `TemplateRef<void>` | - |
| `[nzVisibilityHeight]` | 滚动高度达到此参数值才出现 `nz-back-top` | `number` | `400` |
| `[nzTarget]` | 设置需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数 | `string, Element` | `window` |
| `[nzTarget]` | 设置需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数 | `stringElement` | `window` |
| `(nzClick)` | 点击按钮的回调函数 | `EventEmitter<boolean>` | - |
14 changes: 7 additions & 7 deletions components/badge/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ Badge normally appears in proximity to notifications or user avatars with eye-ca

| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| `[nzCount]` | Number to show in badge | number | |
| `[nzDot]` | Whether to display a red dot instead of `count` | boolean | `false` |
| `[nzShowDot]` | Whether to display the red dot | boolean | true |
| `[nzOverflowCount]` | Max count to show | number | 99 |
| `[nzShowZero]` | Whether to show badge when `count` is zero | boolean | `false` |
| `[nzStatus]` | Set `nz-badge` as a status dot | `success``processing``default``error``warning` | `''` |
| `[nzText]` | If `nzStatus` is set, `text` sets the display text of the status `dot` | string | `''` |
| `[nzCount]` | Number to show in badge | `number` | - |
| `[nzDot]` | Whether to display a red dot instead of `count` | `boolean` | `false` |
| `[nzShowDot]` | Whether to display the red dot | `boolean` | `true` |
| `[nzOverflowCount]` | Max count to show | `number` | `99` |
| `[nzShowZero]` | Whether to show badge when `count` is zero | `boolean` | `false` |
| `[nzStatus]` | Set `nz-badge` as a status dot | `'success'|'processing'|'default'|'error'|'warning'` | - |
| `[nzText]` | If `nzStatus` is set, `text` sets the display text of the status `dot` | `string` | - |
14 changes: 7 additions & 7 deletions components/badge/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ title: Badge

| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| `[nzCount]` | 展示的数字,大于 nzOverflowCount 时显示为 `${nzOverflowCount}+`,为 0 时隐藏 | number | |
| `[nzDot]` | 不展示数字,只有一个小红点 | boolean | false |
| `[nzShowDot]` | 是否展示小红点 | boolean | true |
| `[nzOverflowCount]` | 展示封顶的数字值 | number | 99 |
| `[nzShowZero]` | 当数值为 0 时,是否展示 Badge | boolean | false |
| `[nzStatus]` | 设置 `nz-badge` 为状态点 | Enum{ 'success', 'processing', 'default', 'error', 'warning' } | '' |
| `[nzText]` | 在设置了 `nzStatus` 的前提下有效,设置状态点的文本 | string | '' |
| `[nzCount]` | 展示的数字,大于 nzOverflowCount 时显示为 `${nzOverflowCount}+`,为 0 时隐藏 | `number` | - |
| `[nzDot]` | 不展示数字,只有一个小红点 | `boolean` | `false` |
| `[nzShowDot]` | 是否展示小红点 | `boolean` | `true` |
| `[nzOverflowCount]` | 展示封顶的数字值 | `number` | `99` |
| `[nzShowZero]` | 当数值为 0 时,是否展示 Badge | `boolean` | `false` |
| `[nzStatus]` | 设置 `nz-badge` 为状态点 | `'success''processing''default''error''warning'` | - |
| `[nzText]` | 在设置了 `nzStatus` 的前提下有效,设置状态点的文本 | `string` | - |
8 changes: 4 additions & 4 deletions components/breadcrumb/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ A breadcrumb displays the current location within a hierarchy. It allows going b

### nz-breadcrumb

| Property | Description | Type | Optional | Default |
| -------- | ----------- | ---- | -------- | ------- |
| `[nzSeparator]` | Custom separator | string丨`TemplateRef<void>` | | `/` |
| `[nzAutoGenerate]` | Auto generate breadcrumb | boolean | | `false` |
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| `[nzSeparator]` | Custom separator | `string|TemplateRef<void>` | `'/'` |
| `[nzAutoGenerate]` | Auto generate breadcrumb | `boolean` | `false` |

Using `[nzAutoGenerate]` by configuring `data` like this:

Expand Down
8 changes: 4 additions & 4 deletions components/breadcrumb/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ title: Breadcrumb

### nz-breadcrumb

| 参数 | 说明 | 类型 | 可选值 | 默认值 |
| --- | --- | --- | --- | --- |
| `[nzSeparator]` | 分隔符自定义 | string丨`TemplateRef<void>` | | '/' |
| `[nzAutoGenerate]` | 自动生成 Breadcrumb | boolean | | `false` |
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| `[nzSeparator]` | 分隔符自定义 | `string|TemplateRef<void>` | `'/'` |
| `[nzAutoGenerate]` | 自动生成 Breadcrumb | `boolean` | `false` |

使用 `[nzAutoGenerate]` 时,需要在路由类中定义 `data`:

Expand Down
12 changes: 6 additions & 6 deletions components/button/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ To get a customized button, just set `nzType`/`nzShape`/`nzSize`/`nzLoading`/`di

| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| `[nzGhost]` | make background transparent and invert text and border colors | boolean | false |
| `[nzLoading]` | set the loading status of button | boolean | false |
| `[nzShape]` | can be set to `circle` or omitted | string | - |
| `[nzSize]` | can be set to `small` `large` or omitted | string | `default` |
| `[nzType]` | can be set to `primary` `ghost` `dashed` `danger` or omitted (meaning `default`) | string | `default` |
| `[nzBlock]` | option to fit button width to its parent width | boolean | false |
| `[nzGhost]` | make background transparent and invert text and border colors | `boolean` | `false` |
| `[nzLoading]` | set the loading status of button | `boolean` | `false` |
| `[nzShape]` | can be set to `circle` or omitted | `'circle'` | - |
| `[nzSize]` | can be set to `small` `large` or omitted | `'large'|'small'|'default'` | `'default'` |
| `[nzType]` | can be set to `primary` `ghost` `dashed` `danger` or omitted (meaning `default`) | `'primary'|'ghost'|'dashed'|'danger'|'default'` | `'default'` |
| `[nzBlock]` | option to fit button width to its parent width | `boolean` | `false` |
12 changes: 6 additions & 6 deletions components/button/doc/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ subtitle: 按钮

| 属性 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| `[nzGhost]` | 幽灵属性,使按钮背景透明 | boolean | false |
| `[nzLoading]` | 设置按钮载入状态 | boolean | false |
| `[nzShape]` | 设置按钮形状,可选值为 `circle` 或者不设 | string | - |
| `[nzSize]` | 设置按钮大小,可选值为 `small` `large` 或者不设 | string | default |
| `[nzType]` | 设置按钮类型,可选值为 `primary` `dashed` `danger` 或者不设 | string | - |
| `[nzBlock]` | 将按钮宽度调整为其父宽度的选项 | boolean | false |
| `[nzGhost]` | 幽灵属性,使按钮背景透明 | `boolean` | `false` |
| `[nzLoading]` | 设置按钮载入状态 | `boolean` | `false` |
| `[nzShape]` | 设置按钮形状,可选值为 `circle` 或者不设 | `'circle'` | - |
| `[nzSize]` | 设置按钮大小,可选值为 `small` `large` 或者不设 | `'large'|'small'|'default'` | `'default'` |
| `[nzType]` | 设置按钮类型,可选值为 `primary` `dashed` `danger` 或者不设 | `'primary'|'ghost'|'dashed'|'danger'|'default'` | `'default'` |
| `[nzBlock]` | 将按钮宽度调整为其父宽度的选项 | `boolean` | `false` |
2 changes: 1 addition & 1 deletion components/calendar/doc/index.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ registerLocaleData(en);
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| `[(ngModel)]` | (Two-way bindable) The current selected date | `Date` | current date |
| `[(nzMode)]` | The display mode of the calendar (two-way bindable) | `'month'/'year'` | `'month'` |
| `[(nzMode)]` | The display mode of the calendar (two-way bindable) | `'month''year'` | `'month'` |
| `[nzFullscreen]` | Whether to display in full-screen | `boolean` | `true` |
| `[nzCard]` | Whether to not display in full-screen | `boolean` | `false` |
| `[nzDateCell]` | (Contentable) Customize the display of the date cell, the template content will be appended to the cell | `TemplateRef<Date>` | - |
Expand Down
Loading

0 comments on commit 49416ea

Please sign in to comment.