diff --git a/components/affix/doc/index.en-US.md b/components/affix/doc/index.en-US.md index 2b28fe47d0b..77e2928ab00 100755 --- a/components/affix/doc/index.en-US.md +++ b/components/affix/doc/index.en-US.md @@ -28,7 +28,7 @@ import { NzAffixModule } from 'ng-zorro-antd'; | -------- | ----------- | ---- | ------- | | `[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` | +| `[nzTarget]` | specifies the scrollable area dom node | `string \| HTMLElement` | `window` | | `(nzChange)` | Callback for when affix state is changed | `EventEmitter` | - | **Note:** Children of `nz-affix` can not be `position: absolute`, but you can set `nz-affix` as `position: absolute`: diff --git a/components/affix/doc/index.zh-CN.md b/components/affix/doc/index.zh-CN.md index d79e93d6317..2910f19499d 100755 --- a/components/affix/doc/index.zh-CN.md +++ b/components/affix/doc/index.zh-CN.md @@ -29,7 +29,7 @@ import { NzAffixModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[nzOffsetBottom]` | 距离窗口底部达到指定偏移量后触发 | `number` | - | | `[nzOffsetTop]` | 距离窗口顶部达到指定偏移量后触发 | `number` | `0` | -| `[nzTarget]` | 设置 `nz-affix` 需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数 | `string|HTMLElement` | `window` | +| `[nzTarget]` | 设置 `nz-affix` 需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数 | `string \| HTMLElement` | `window` | | `(nzChange)` | 固定状态改变时触发的回调函数 | `EventEmitter` | - | **注意:**`nz-affix` 内的元素不要使用绝对定位,如需要绝对定位的效果,可以直接设置 `nz-affix` 为绝对定位: diff --git a/components/alert/doc/index.en-US.md b/components/alert/doc/index.en-US.md index 73f95531ed7..551cd7f0cc3 100644 --- a/components/alert/doc/index.en-US.md +++ b/components/alert/doc/index.en-US.md @@ -27,10 +27,10 @@ import { NzAlertModule } from 'ng-zorro-antd'; | -------- | ----------- | ---- | ------- | | `[nzBanner]` | Whether to show as banner | `boolean` | `false` | | `[nzCloseable]` | Whether Alert can be closed | `boolean` | - | -| `[nzCloseText]` | Close text to show | `string|TemplateRef` | - | -| `[nzDescription]` | Additional content of Alert | `string|TemplateRef` | - | -| `[nzMessage]` | Content of Alert | `string|TemplateRef` | - | +| `[nzCloseText]` | Close text to show | `string \| TemplateRef` | - | +| `[nzDescription]` | Additional content of Alert | `string \| TemplateRef` | - | +| `[nzMessage]` | Content of Alert | `string \| TemplateRef` | - | | `[nzShowIcon]` | Whether to show icon, in `nzBanner` mode default is `true` | `boolean` | `false` | -| `[nzIconType]` | Icon type, effective when `nzShowIcon` is `true` | `string|string[]|Set|{ [klass: string]: any; }` | - | -| `[nzType]` | Type of Alert styles, in `nzBanner` mode default is `'warning'` | `'success'|'info'|'warning'|'error'` | `'info'` | +| `[nzIconType]` | Icon type, effective when `nzShowIcon` is `true` | `string \| string[] \| Set \| { [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` | - | diff --git a/components/alert/doc/index.zh-CN.md b/components/alert/doc/index.zh-CN.md index 51a907adbe9..179ba5bf61e 100644 --- a/components/alert/doc/index.zh-CN.md +++ b/components/alert/doc/index.zh-CN.md @@ -28,10 +28,10 @@ import { NzAlertModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[nzBanner]` | 是否用作顶部公告 | `boolean` | `false` | | `[nzCloseable]` | 默认不显示关闭按钮 | `boolean` | - | -| `[nzCloseText]` | 自定义关闭按钮 | `string|TemplateRef` | - | -| `[nzDescription]` | 警告提示的辅助性文字介绍 | `string|TemplateRef` | - | -| `[nzMessage]` | 警告提示内容 | `string|TemplateRef` | - | +| `[nzCloseText]` | 自定义关闭按钮 | `string \| TemplateRef` | - | +| `[nzDescription]` | 警告提示的辅助性文字介绍 | `string \| TemplateRef` | - | +| `[nzMessage]` | 警告提示内容 | `string \| TemplateRef` | - | | `[nzShowIcon]` | 是否显示辅助图标,`nzBanner` 模式下默认值为 `true` | `boolean` | `false` | -| `[nzIconType]` | 自定义图标类型,`nzShowIcon` 为 `true` 时有效 | `string|string[]|Set|{ [klass: string]: any; }` | - | -| `[nzType]` | 指定警告提示的样式,`nzBanner` 模式下默认值为 `'warning'` | `'success'|'info'|'warning'|'error'` | `'info'` | +| `[nzIconType]` | 自定义图标类型,`nzShowIcon` 为 `true` 时有效 | `string \| string[] \| Set \| { [klass: string]: any; }` | - | +| `[nzType]` | 指定警告提示的样式,`nzBanner` 模式下默认值为 `'warning'` | `'success' \| 'info' \| 'warning' \| 'error'` | `'info'` | | `(nzOnClose)` | 关闭时触发的回调函数 | `EventEmitter` | - | diff --git a/components/anchor/doc/index.en-US.md b/components/anchor/doc/index.en-US.md index c497901da94..5d319be4b05 100755 --- a/components/anchor/doc/index.en-US.md +++ b/components/anchor/doc/index.en-US.md @@ -29,7 +29,7 @@ import { NzAnchorModule } from 'ng-zorro-antd'; | `[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` | +| `[nzTarget]` | Scrolling container | `string \| HTMLElement` | `window` | | `(nzClick)` | Click of Anchor item | `EventEmitter` | - | | `(nzScroll)` | The scroll function that is triggered when scrolling to an anchor. | `EventEmitter` | - | @@ -38,4 +38,4 @@ import { NzAnchorModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | `[nzHref]` | target of hyperlink | `string` | - | -| `[nzTitle]` | content of hyperlink | `string|TemplateRef` | - | +| `[nzTitle]` | content of hyperlink | `string \| TemplateRef` | - | diff --git a/components/anchor/doc/index.zh-CN.md b/components/anchor/doc/index.zh-CN.md index 117986bc46f..9916b1dc46c 100755 --- a/components/anchor/doc/index.zh-CN.md +++ b/components/anchor/doc/index.zh-CN.md @@ -30,7 +30,7 @@ import { NzAnchorModule } from 'ng-zorro-antd'; | `[nzOffsetBottom]` | 距离窗口底部达到指定偏移量后触发 | `number` | - | | `[nzOffsetTop]` | 距离窗口顶部达到指定偏移量后触发 | `number` | - | | `[nzShowInkInFixed]` | 固定模式是否显示小圆点 | `boolean` | `false` | -| `[nzTarget]` | 指定滚动的容器 | `string|HTMLElement` | `window` | +| `[nzTarget]` | 指定滚动的容器 | `string \| HTMLElement` | `window` | | `(nzClick)` | 点击项触发 | `EventEmitter` | - | | `(nzScroll)` | 滚动至某锚点时触发 | `EventEmitter` | - | @@ -39,4 +39,4 @@ import { NzAnchorModule } from 'ng-zorro-antd'; | 成员 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[nzHref]` | 锚点链接 | `string` | - | -| `[nzTitle]` | 文字内容 | `string|TemplateRef` | - | +| `[nzTitle]` | 文字内容 | `string \| TemplateRef` | - | diff --git a/components/avatar/doc/index.en-US.md b/components/avatar/doc/index.en-US.md index e7cae321c01..bb4f20e0f86 100644 --- a/components/avatar/doc/index.en-US.md +++ b/components/avatar/doc/index.en-US.md @@ -21,8 +21,8 @@ import { NzAvatarModule } from 'ng-zorro-antd'; | 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'` | +| `[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` | - | | `[nzSrcSet]` | a list of sources to use for different screen resolutions | string | - | | `[nzAlt]` | This attribute defines the alternative text describing the image | string | - | diff --git a/components/avatar/doc/index.zh-CN.md b/components/avatar/doc/index.zh-CN.md index e1d006ae3ab..f90a3081c2a 100644 --- a/components/avatar/doc/index.zh-CN.md +++ b/components/avatar/doc/index.zh-CN.md @@ -22,8 +22,8 @@ import { NzAvatarModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[nzIcon]` | 设置头像的图标类型,参考 `Icon` | `string` | - | -| `[nzShape]` | 指定头像的形状 | `'circle'|'square'` | `'circle'` | -| `[nzSize]` | 设置头像的大小 | `'large'|'small'|'default'|number` | `'default'` | +| `[nzShape]` | 指定头像的形状 | `'circle' \| 'square'` | `'circle'` | +| `[nzSize]` | 设置头像的大小 | `'large' \| 'small' \| 'default' \| number` | `'default'` | | `[nzSrc]` | 图片类头像的资源地址 | `string` | - | | `[nzSrcSet]` | 设置图片类头像响应式资源地址 | string | - | | `[nzAlt]` | 图像无法显示时的替代文本 | string | - | diff --git a/components/back-top/doc/index.en-US.md b/components/back-top/doc/index.en-US.md index 0f24f91efe3..dd04fa6ed4d 100644 --- a/components/back-top/doc/index.en-US.md +++ b/components/back-top/doc/index.en-US.md @@ -30,6 +30,6 @@ import { NzBackTopModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[nzTemplate]` | custom content | `TemplateRef` | - | | `[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 | `string \| Element` | `window` | | `(nzClick)` | a callback function, which can be executed when you click the button | `EventEmitter` | - | diff --git a/components/back-top/doc/index.zh-CN.md b/components/back-top/doc/index.zh-CN.md index 1925f985684..0ea947e7652 100644 --- a/components/back-top/doc/index.zh-CN.md +++ b/components/back-top/doc/index.zh-CN.md @@ -31,5 +31,5 @@ import { NzBackTopModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[nzTemplate]` | 自定义内容,见示例 | `TemplateRef` | - | | `[nzVisibilityHeight]` | 滚动高度达到此参数值才出现 `nz-back-top` | `number` | `400` | -| `[nzTarget]` | 设置需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数 | `string|Element` | `window` | +| `[nzTarget]` | 设置需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数 | `string \| Element` | `window` | | `(nzClick)` | 点击按钮的回调函数 | `EventEmitter` | - | diff --git a/components/badge/doc/index.en-US.md b/components/badge/doc/index.en-US.md index 2b13d71b8e8..24f85c134bf 100644 --- a/components/badge/doc/index.en-US.md +++ b/components/badge/doc/index.en-US.md @@ -35,10 +35,10 @@ import { NzBadgeModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | `[nzColor]` | Customize Badge dot color | string | - | -| `[nzCount]` | Number to show in badge | `number|TemplateRef` | - | +| `[nzCount]` | Number to show in badge | `number \| TemplateRef` | - | | `[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'` | - | +| `[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` | - | diff --git a/components/badge/doc/index.zh-CN.md b/components/badge/doc/index.zh-CN.md index e79bec13849..4de1e7c2b9f 100644 --- a/components/badge/doc/index.zh-CN.md +++ b/components/badge/doc/index.zh-CN.md @@ -36,10 +36,10 @@ import { NzBadgeModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[nzColor]` | 自定义小圆点的颜色 | string | - | -| `[nzCount]` | 展示的数字,大于 nzOverflowCount 时显示为 `${nzOverflowCount}+`,为 0 时隐藏 | `number|TemplateRef` | - | +| `[nzCount]` | 展示的数字,大于 nzOverflowCount 时显示为 `${nzOverflowCount}+`,为 0 时隐藏 | `number \| TemplateRef` | - | | `[nzDot]` | 不展示数字,只有一个小红点 | `boolean` | `false` | | `[nzShowDot]` | 是否展示小红点 | `boolean` | `true` | | `[nzOverflowCount]` | 展示封顶的数字值 | `number` | `99` | | `[nzShowZero]` | 当数值为 0 时,是否展示 Badge | `boolean` | `false` | -| `[nzStatus]` | 设置 `nz-badge` 为状态点 | `'success'|'processing'|'default'|'error'|'warning'` | - | +| `[nzStatus]` | 设置 `nz-badge` 为状态点 | `'success' \| 'processing' \| 'default' \| 'error' \| 'warning'` | - | | `[nzText]` | 在设置了 `nzStatus` 的前提下有效,设置状态点的文本 | `string` | - | diff --git a/components/breadcrumb/doc/index.en-US.md b/components/breadcrumb/doc/index.en-US.md index ca8c30228c6..a802ec52278 100755 --- a/components/breadcrumb/doc/index.en-US.md +++ b/components/breadcrumb/doc/index.en-US.md @@ -27,7 +27,7 @@ import { NzBreadCrumbModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzSeparator]` | Custom separator | `string|TemplateRef` | `'/'` | +| `[nzSeparator]` | Custom separator | `string \| TemplateRef` | `'/'` | | `[nzAutoGenerate]` | Auto generate breadcrumb | `boolean` | `false` | Using `[nzAutoGenerate]` by configuring `data` like this: diff --git a/components/breadcrumb/doc/index.zh-CN.md b/components/breadcrumb/doc/index.zh-CN.md index e2ad059e88f..538896b9c32 100755 --- a/components/breadcrumb/doc/index.zh-CN.md +++ b/components/breadcrumb/doc/index.zh-CN.md @@ -27,7 +27,7 @@ import { NzBreadCrumbModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzSeparator]` | 分隔符自定义 | `string|TemplateRef` | `'/'` | +| `[nzSeparator]` | 分隔符自定义 | `string \| TemplateRef` | `'/'` | | `[nzAutoGenerate]` | 自动生成 Breadcrumb | `boolean` | `false` | 使用 `[nzAutoGenerate]` 时,需要在路由类中定义 `data`: diff --git a/components/button/doc/index.en-US.md b/components/button/doc/index.en-US.md index 1cac8365add..c84338d986a 100644 --- a/components/button/doc/index.en-US.md +++ b/components/button/doc/index.en-US.md @@ -28,7 +28,7 @@ To get a customized button, just set `nzType`/`nzShape`/`nzSize`/`nzLoading`/`di | -------- | ----------- | ---- | ------- | | `[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` `round` or omitted | `'circle'|'round'` | - | -| `[nzSize]` | can be set to `small` `large` or omitted | `'large'|'small'|'default'` | `'default'` | -| `[nzType]` | can be set to `primary` `dashed` `danger` or omitted (meaning `default`) | `'primary'|'dashed'|'danger'|'default'|'link'` | `'default'` | +| `[nzShape]` | can be set to `circle` `round` or omitted | `'circle' \| 'round'` | - | +| `[nzSize]` | can be set to `small` `large` or omitted | `'large' \| 'small' \| 'default'` | `'default'` | +| `[nzType]` | can be set to `primary` `dashed` `danger` or omitted (meaning `default`) | `'primary' \| 'dashed' \| 'danger' \| 'default' \| 'link'` | `'default'` | | `[nzBlock]` | option to fit button width to its parent width | `boolean` | `false` | diff --git a/components/button/doc/index.zh-CN.md b/components/button/doc/index.zh-CN.md index 8fade534be5..1263b327700 100644 --- a/components/button/doc/index.zh-CN.md +++ b/components/button/doc/index.zh-CN.md @@ -32,7 +32,7 @@ import { NzButtonModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[nzGhost]` | 幽灵属性,使按钮背景透明 | `boolean` | `false` | | `[nzLoading]` | 设置按钮载入状态 | `boolean` | `false` | -| `[nzShape]` | 设置按钮形状,可选值为 `circle` `round` 或者不设 | `'circle'|'round'` | - | -| `[nzSize]` | 设置按钮大小,可选值为 `small` `large` 或者不设 | `'large'|'small'|'default'` | `'default'` | -| `[nzType]` | 设置按钮类型,可选值为 `primary` `dashed` `danger` 或者不设 | `'primary'|'dashed'|'danger'|'default'|'link'` | `'default'` | +| `[nzShape]` | 设置按钮形状,可选值为 `circle` `round` 或者不设 | `'circle' \| 'round'` | - | +| `[nzSize]` | 设置按钮大小,可选值为 `small` `large` 或者不设 | `'large' \| 'small' \| 'default'` | `'default'` | +| `[nzType]` | 设置按钮类型,可选值为 `primary` `dashed` `danger` 或者不设 | `'primary' \| 'dashed' \| 'danger' \| 'default' \| 'link'` | `'default'` | | `[nzBlock]` | 将按钮宽度调整为其父宽度的选项 | `boolean` | `false` | diff --git a/components/calendar/doc/index.en-US.md b/components/calendar/doc/index.en-US.md index 23f33718fa2..bb43e15a251 100644 --- a/components/calendar/doc/index.en-US.md +++ b/components/calendar/doc/index.en-US.md @@ -49,11 +49,11 @@ import { NzCalendarModule } from 'ng-zorro-antd'; | 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` | - | | `[nzDateFullCell]` | (Contentable) Customize the display of the date cell, the template content will override the cell | `TemplateRef` | - | | `[nzMonthCell]` | (Contentable) Customize the display of the month cell, the template content will be appended to the cell | `TemplateRef` | - | | `[nzMonthFullCell]` | (Contentable) Customize the display of the month cell, the template content will override the cell | `TemplateRef` | - | -| `(nzPanelChange)` | Callback for when panel changes | `EventEmitter<{ date: Date, mode: 'month'|'year' }>` | - | +| `(nzPanelChange)` | Callback for when panel changes | `EventEmitter<{ date: Date, mode: 'month' \| 'year' }>` | - | diff --git a/components/calendar/doc/index.zh-CN.md b/components/calendar/doc/index.zh-CN.md index ed7473865c0..390e5969c51 100644 --- a/components/calendar/doc/index.zh-CN.md +++ b/components/calendar/doc/index.zh-CN.md @@ -50,12 +50,12 @@ import { NzCalendarModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[(ngModel)]` | (可双向绑定)展示日期 | `Date` | 当前日期 | -| `[(nzMode)]` | (可双向绑定)显示模式 | `'month'|'year'` | `'month'` | +| `[(nzMode)]` | (可双向绑定)显示模式 | `'month' \| 'year'` | `'month'` | | `[nzFullscreen]` | 是否全屏显示 | `boolean` | `true` | | `[nzCard]` | 是否不全屏显示 | `boolean` | `false` | | `[nzDateCell]` | (可作为内容)自定义渲染日期单元格,模版内容会被追加到单元格 | `TemplateRef` | - | | `[nzDateFullCell]` | (可作为内容)自定义渲染日期单元格,模版内容覆盖单元格 | `TemplateRef` | - | | `[nzMonthCell]` | (可作为内容)自定义渲染月单元格,模版内容会被追加到单元格 | `TemplateRef` | - | | `[nzMonthFullCell]` | (可作为内容)自定义渲染月单元格,模版内容覆盖单元格 | `TemplateRef` | - | -| `(nzPanelChange)` | 面板变化的回调 | `EventEmitter<{ date: Date, mode: 'month'|'year' }>` | - | +| `(nzPanelChange)` | 面板变化的回调 | `EventEmitter<{ date: Date, mode: 'month' \| 'year' }>` | - | | `(nzSelectChange)` | 选择日期的回调 | `EventEmitter` | - | diff --git a/components/card/doc/index.en-US.md b/components/card/doc/index.en-US.md index 616c901219a..693e7e2b3aa 100644 --- a/components/card/doc/index.en-US.md +++ b/components/card/doc/index.en-US.md @@ -33,12 +33,12 @@ import { NzCardModule } from 'ng-zorro-antd'; | `[nzBodyStyle]` | Inline style to apply to the card content | `{ [key: string]: string }` | - | | `[nzBordered]` | Toggles rendering of the border around the card | `boolean` | `true` | | `[nzCover]` | Card cover | `TemplateRef` | - | -| `[nzExtra]` | Content to render in the top-right corner of the card | `string|TemplateRef` | - | +| `[nzExtra]` | Content to render in the top-right corner of the card | `string \| TemplateRef` | - | | `[nzHoverable]` | Lift up when hovering card | `boolean` | `false` | | `[nzLoading]` | Shows a loading indicator while the contents of the card are being fetched | `boolean` | `false` | -| `[nzTitle]` | Card title | `string|TemplateRef` | - | +| `[nzTitle]` | Card title | `string \| TemplateRef` | - | | `[nzType]` | Card style type, can be set to `inner` or not set | `'inner'` | - | -| `[nzSize]` | Size of card | `'default'|'small'` | `'default'` | +| `[nzSize]` | Size of card | `'default' \| 'small'` | `'default'` | ### nz-card-meta @@ -46,8 +46,8 @@ import { NzCardModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | `[nzAvatar]` | avatar or icon | `TemplateRef` | - | -| `[nzDescription]` | description content | `string|TemplateRef` | - | -| `[nzTitle]` | title content | `string|TemplateRef` | - | +| `[nzDescription]` | description content | `string \| TemplateRef` | - | +| `[nzTitle]` | title content | `string \| TemplateRef` | - | ### [nz-card-grid] Area for grid style card diff --git a/components/card/doc/index.zh-CN.md b/components/card/doc/index.zh-CN.md index 8e9ba613cb2..6abcd6cd00e 100644 --- a/components/card/doc/index.zh-CN.md +++ b/components/card/doc/index.zh-CN.md @@ -34,20 +34,20 @@ import { NzCardModule } from 'ng-zorro-antd'; | `[nzBodyStyle]` | 内容区域自定义样式 | `{ [key: string]: string }` | - | | `[nzBordered]` | 是否有边框 | `boolean` | `true` | | `[nzCover]` | 卡片封面 | `TemplateRef` | - | -| `[nzExtra]` | 卡片右上角的操作区域 | `string|TemplateRef` | - | +| `[nzExtra]` | 卡片右上角的操作区域 | `string \| TemplateRef` | - | | `[nzHoverable]` | 鼠标移过时可浮起 | `boolean` | `false` | | `[nzLoading]` | 当卡片内容还在加载中时,可以用 loading 展示一个占位 | `boolean` | `false` | -| `[nzTitle]` | 卡片标题 | `string|TemplateRef` | - | +| `[nzTitle]` | 卡片标题 | `string \| TemplateRef` | - | | `[nzType]` | 卡片类型,可设置为 `inner` 或 不设置 | `'inner'` | - | -| `[nzSize]` | 卡片的尺寸 | `'default'|'small'` | `'default'` | +| `[nzSize]` | 卡片的尺寸 | `'default' \| 'small'` | `'default'` | ### nz-card-meta | 参数 | 说明 | 类型 | 默认值 | | -------- | ----------- | ---- | ------- | | `[nzAvatar]` | 头像/图标 | `TemplateRef` | - | -| `[nzDescription]` | 描述内容 | `string|TemplateRef` | - | -| `[nzTitle]` | 标题内容 | `string|TemplateRef` | - | +| `[nzDescription]` | 描述内容 | `string \| TemplateRef` | - | +| `[nzTitle]` | 标题内容 | `string \| TemplateRef` | - | ### [nz-card-grid] diff --git a/components/cascader/doc/index.en-US.md b/components/cascader/doc/index.en-US.md index 49613f0cc78..813e261833c 100755 --- a/components/cascader/doc/index.en-US.md +++ b/components/cascader/doc/index.en-US.md @@ -37,10 +37,10 @@ import { NzCascaderModule } from 'ng-zorro-antd'; | `[nzChangeOnSelect]` | change value on each selection if set to true, see above demo for details | `boolean` | `false` | | `[nzColumnClassName]` | additional className of column in the popup overlay | `string` | - | | `[nzDisabled]` | whether disabled select | `boolean` | `false` | -| `[nzExpandTrigger]` | expand current item when click or hover, one of 'click' 'hover' | `'click'|'hover'` | `'click'` | +| `[nzExpandTrigger]` | expand current item when click or hover, one of 'click' 'hover' | `'click' \| 'hover'` | `'click'` | | `[nzMenuClassName]` | additional className of popup overlay | `string` | - | | `[nzMenuStyle]` | additional css style of popup overlay | `object` | - | -| `[nzNotFoundContent]` | Specify content to show when no result matches. | `string|TemplateRef` | - | +| `[nzNotFoundContent]` | Specify content to show when no result matches. | `string \| TemplateRef` | - | | `[nzLabelProperty]` | the label property name of options | `string` | `'label'` | | `[nzLabelRender]` | render template of displaying selected options | `TemplateRef` | - | | `[nzLoadData]` | To load option lazily. If setting `ngModel` with an array value and `nzOptions` is not setting, lazy load will be call immediately | `(option: any, index?: index) => PromiseLike` | - | @@ -48,8 +48,8 @@ import { NzCascaderModule } from 'ng-zorro-antd'; | `[nzPlaceHolder]` | input placeholder | `string` | `'Please select'` | | `[nzShowArrow]` | Whether show arrow | `boolean` | `true` | | `[nzShowInput]` | Whether show input | `boolean` | `true` | -| `[nzShowSearch]` | Whether support search. Cannot be used with `[nzLoadData]` at the same time | `boolean|NzShowSearchOptions` | `false` | -| `[nzSize]` | input size, one of `large` `default` `small` | `'large'|'small'|'default'` | `'default'` | +| `[nzShowSearch]` | Whether support search. Cannot be used with `[nzLoadData]` at the same time | `boolean \| NzShowSearchOptions` | `false` | +| `[nzSize]` | input size, one of `large` `default` `small` | `'large' \| 'small' \| 'default'` | `'default'` | | `[nzValueProperty]` | the value property name of options | `string` | `'value'` | | `(ngModelChange)` | Emit on values change | `EventEmitter` | - | | `(nzClear)` | Emit on clear values | `EventEmitter` | - | diff --git a/components/cascader/doc/index.zh-CN.md b/components/cascader/doc/index.zh-CN.md index 82f87b847f1..c9ad3b69f8c 100755 --- a/components/cascader/doc/index.zh-CN.md +++ b/components/cascader/doc/index.zh-CN.md @@ -38,10 +38,10 @@ import { NzCascaderModule } from 'ng-zorro-antd'; | `[nzChangeOnSelect]` | 当此项为 true 时,点选每级菜单选项值都会发生变化,具体见上面的演示 | `boolean` | `false` | | `[nzColumnClassName]` | 自定义浮层列类名 | `string` | - | | `[nzDisabled]` | 禁用 | `boolean` | `false` | -| `[nzExpandTrigger]` | 次级菜单的展开方式,可选 'click' 和 'hover' | `'click'|'hover'` | `'click'` | +| `[nzExpandTrigger]` | 次级菜单的展开方式,可选 'click' 和 'hover' | `'click' \| 'hover'` | `'click'` | | `[nzMenuClassName]` | 自定义浮层类名 | `string` | - | | `[nzMenuStyle]` | 自定义浮层样式 | `object` | - | -| `[nzNotFoundContent]` | 当下拉列表为空时显示的内容 | `string|TemplateRef` | - | +| `[nzNotFoundContent]` | 当下拉列表为空时显示的内容 | `string \| TemplateRef` | - | | `[nzLabelProperty]` | 选项的显示值的属性名 | `string` | `'label'` | | `[nzLabelRender]` | 选择后展示的渲染模板 | `TemplateRef` | - | | `[nzLoadData]` | 用于动态加载选项。如果提供了`ngModel`初始值,且未提供`nzOptions`值,则会立即触发动态加载。 | `(option: any, index?: index) => PromiseLike` | - | @@ -49,8 +49,8 @@ import { NzCascaderModule } from 'ng-zorro-antd'; | `[nzPlaceHolder]` | 输入框占位文本 | `string` | `'请选择'` | | `[nzShowArrow]` | 是否显示箭头 | `boolean` | `true` | | `[nzShowInput]` | 显示输入框 | `boolean` | `true` | -| `[nzShowSearch]` | 是否支持搜索,默认情况下对 `label` 进行全匹配搜索,不能和 `[nzLoadData]` 同时使用 | `boolean|NzShowSearchOptions` | `false` | -| `[nzSize]` | 输入框大小,可选 `large` `default` `small` | `'large'|'small'|'default'` | `'default'` | +| `[nzShowSearch]` | 是否支持搜索,默认情况下对 `label` 进行全匹配搜索,不能和 `[nzLoadData]` 同时使用 | `boolean \| NzShowSearchOptions` | `false` | +| `[nzSize]` | 输入框大小,可选 `large` `default` `small` | `'large' \| 'small' \| 'default'` | `'default'` | | `[nzValueProperty]` | 选项的实际值的属性名 | `string` | `'value'` | | `(ngModelChange)` | 值发生变化时触发 | `EventEmitter` | - | | `(nzClear)` | 清空值时触发 | `EventEmitter` | - | diff --git a/components/collapse/doc/index.en-US.md b/components/collapse/doc/index.en-US.md index d59979da24a..a92198126a7 100755 --- a/components/collapse/doc/index.en-US.md +++ b/components/collapse/doc/index.en-US.md @@ -34,9 +34,9 @@ import { NzCollapseModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | `[nzDisabled]` | If `true`, panel cannot be opened or closed | `boolean` | `false` | -| `[nzHeader]` | Title of the panel | `string|TemplateRef` | - | -| `[nzExpandedIcon]` | Customize an icon for toggle | `string|TemplateRef` | - | -| `[nzExtra]` | Extra element in the corner | `string|TemplateRef` | - | +| `[nzHeader]` | Title of the panel | `string \| TemplateRef` | - | +| `[nzExpandedIcon]` | Customize an icon for toggle | `string \| TemplateRef` | - | +| `[nzExtra]` | Extra element in the corner | `string \| TemplateRef` | - | | `[nzShowArrow]` | Display arrow or not | `boolean` | `true` | | `[nzActive]` | Active status of panel, double binding | `boolean` | - | | `(nzActiveChange)` | Callback function of the active status | `EventEmitter` | - | diff --git a/components/collapse/doc/index.zh-CN.md b/components/collapse/doc/index.zh-CN.md index 014d3abd525..2585ebf17ca 100755 --- a/components/collapse/doc/index.zh-CN.md +++ b/components/collapse/doc/index.zh-CN.md @@ -35,9 +35,9 @@ import { NzCollapseModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[nzDisabled]` | 禁用后的面板展开与否将无法通过用户交互改变 | `boolean` | `false` | -| `[nzHeader]` | 面板头内容 | `string|TemplateRef` | - | -| `[nzExpandedIcon]` | 自定义切换图标 | `string|TemplateRef` | - | -| `[nzExtra]` | 自定义渲染每个面板右上角的内容 | `string|TemplateRef` | - | +| `[nzHeader]` | 面板头内容 | `string \| TemplateRef` | - | +| `[nzExpandedIcon]` | 自定义切换图标 | `string \| TemplateRef` | - | +| `[nzExtra]` | 自定义渲染每个面板右上角的内容 | `string \| TemplateRef` | - | | `[nzShowArrow]` | 是否展示箭头 | `boolean` | `true` | | `[nzActive]` | 面板是否展开,可双向绑定 | `boolean` | - | | `(nzActiveChange)` | 面板展开回调 | `EventEmitter` | - | diff --git a/components/comment/doc/index.en-US.md b/components/comment/doc/index.en-US.md index b41d751c865..024bd340138 100644 --- a/components/comment/doc/index.en-US.md +++ b/components/comment/doc/index.en-US.md @@ -15,8 +15,8 @@ Comments can be used to enable discussions on an entity such as a page, blog pos | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| [nzAuthor] | The element to display as the comment author | `string|TemplateRef` | - | -| [nzDatetime] | A datetime element containing the time to be displayed | `string|TemplateRef` | - | +| [nzAuthor] | The element to display as the comment author | `string \| TemplateRef` | - | +| [nzDatetime] | A datetime element containing the time to be displayed | `string \| TemplateRef` | - | ### Import this Component Individually diff --git a/components/comment/doc/index.zh-CN.md b/components/comment/doc/index.zh-CN.md index a9e06467890..a4fd855787f 100644 --- a/components/comment/doc/index.zh-CN.md +++ b/components/comment/doc/index.zh-CN.md @@ -16,8 +16,8 @@ cols: 1 | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| [nzAuthor] | 显示评论的作者 | `string|TemplateRef` | - | -| [nzDatetime] | 展示时间描述 | `string|TemplateRef` | - | +| [nzAuthor] | 显示评论的作者 | `string \| TemplateRef` | - | +| [nzDatetime] | 展示时间描述 | `string \| TemplateRef` | - | ### 单独引入此组件 diff --git a/components/date-picker/doc/index.en-US.md b/components/date-picker/doc/index.en-US.md index eb6de67028c..2f362217b2b 100644 --- a/components/date-picker/doc/index.en-US.md +++ b/components/date-picker/doc/index.en-US.md @@ -47,14 +47,14 @@ The following APIs are shared by nz-date-picker, nz-month-picker, nz-range-picke | `[nzAllowClear]` | Whether to show clear button | `boolean` | `true` | | `[nzAutoFocus]` | get focus when component mounted | `boolean` | `false` | | `[nzClassName]` | picker className | `string` | `''` | -| `[nzDateRender]` | custom rendering function for date cells (Not support by month-picker/year-picker) | `TemplateRef|string|((d: Date) => TemplateRef|string)` | - | +| `[nzDateRender]` | custom rendering function for date cells (Not support by month-picker/year-picker) | `TemplateRef \| string \| ((d: Date) => TemplateRef \| string)` | - | | `[nzDisabled]` | determine whether the nz-date-picker is disabled | `boolean` | `false` | | `[nzDisabledDate]` | specify the date that cannot be selected | `(current: Date) => boolean` | - | | `[nzLocale]` | localization configuration | `object` | [default](https://github.com/ant-design/ant-design/blob/master/components/date-picker/locale/example.json) | | `[nzOpen]` | open state of picker | `boolean` | - | | `[nzPopupStyle]` | to customize the style of the popup calendar | `object` | `{}` | | `[nzDropdownClassName]` | to customize the className of the popup calendar | `string` | - | -| `[nzSize]` | determine the size of the input box, the height of `large` and `small`, are 40px and 24px respectively, while default size is 32px | `'large'|'small'` | - | +| `[nzSize]` | determine the size of the input box, the height of `large` and `small`, are 40px and 24px respectively, while default size is 32px | `'large' \| 'small'` | - | | `[nzStyle]` | to customize the style of the input box | `object` | `{}` | | `(nzOnOpenChange)` | a callback emitter, can be executed whether the popup calendar is popped up or closed | `EventEmitter` | - | @@ -65,8 +65,8 @@ The following APIs are shared by nz-date-picker, nz-month-picker, nz-range-picke | `[ngModel]` | Date | `Date` | - | | `[nzDisabledTime]` | to specify the time that cannot be selected | `(current: Date) => { nzDisabledHours, nzDisabledMinutes, nzDisabledSeconds }` | - | | `[nzFormat]` | to set the date format, see `nzFormat special instructions` | `string` | `"yyyy-MM-DD"` | -| `[nzRenderExtraFooter]` | render extra footer in panel | `TemplateRef|string|(() => TemplateRef|string)` | - | -| `[nzShowTime]` | to provide an additional time selection | `object|boolean` | [TimePicker Options](/components/time-picker/en#api) | +| `[nzRenderExtraFooter]` | render extra footer in panel | `TemplateRef \| string \| (() => TemplateRef \| string)` | - | +| `[nzShowTime]` | to provide an additional time selection | `object \| boolean` | [TimePicker Options](/components/time-picker/en#api) | | `[nzShowToday]` | whether to show "Today" button | `boolean` | `true` | | `[nzPlaceHolder]` | placeholder of date input | `string` | - | | `(nzOnOk)` | callback when click ok button | `EventEmitter` | - | @@ -78,7 +78,7 @@ The following APIs are shared by nz-date-picker, nz-month-picker, nz-range-picke | -------- | ----------- | ---- | ------- | | `[ngModel]` | Date | `Date` | - | | `[nzFormat]` | to set the date format, see `nzFormat special instructions` | `string` | `"yyyy"` | -| `[nzRenderExtraFooter]` | render extra footer in panel | `TemplateRef|string|(() => TemplateRef|string)` | - | +| `[nzRenderExtraFooter]` | render extra footer in panel | `TemplateRef \| string \| (() => TemplateRef \| string)` | - | | `[nzPlaceHolder]` | placeholder of date input | `string` | - | | `(ngModelChange)` | Date change callback | `EventEmitter` | - | @@ -88,7 +88,7 @@ The following APIs are shared by nz-date-picker, nz-month-picker, nz-range-picke | -------- | ----------- | ---- | ------- | | `[ngModel]` | Date | `Date` | - | | `[nzFormat]` | to set the date format, see `nzFormat special instructions` | `string` | `"yyyy-MM"` | -| `[nzRenderExtraFooter]` | render extra footer in panel | `TemplateRef|string|(() => TemplateRef|string)` | - | +| `[nzRenderExtraFooter]` | render extra footer in panel | `TemplateRef \| string \| (() => TemplateRef \| string)` | - | | `[nzPlaceHolder]` | placeholder of date input | `string` | - | | `(ngModelChange)` | Date change callback | `EventEmitter` | - | @@ -106,11 +106,11 @@ The following APIs are shared by nz-date-picker, nz-month-picker, nz-range-picke | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | `[ngModel]` | Date | `Date[]` | - | -| `[nzDisabledTime]` | to specify the time that cannot be selected | `(current: Date, partial: 'start'|'end') => { nzDisabledHours, nzDisabledMinutes, nzDisabledSeconds }` | - | +| `[nzDisabledTime]` | to specify the time that cannot be selected | `(current: Date, partial: 'start' \| 'end') => { nzDisabledHours, nzDisabledMinutes, nzDisabledSeconds }` | - | | `[nzFormat]` | to set the date format, see `nzFormat special instructions` | `string` | `"yyyy-MM-dd"` | -| `[nzRanges]` | preseted ranges for quick selection | `{ [ key: string ]: Date[] } | { [ key: string ]: () => Date[] }` | - | -| `[nzRenderExtraFooter]` | render extra footer in panel | `TemplateRef|string|(() => TemplateRef|string)` | - | -| `[nzShowTime]` | to provide an additional time selection | `object|boolean` | [TimePicker Options](/components/time-picker/en#api) | +| `[nzRanges]` | preseted ranges for quick selection | `{ [ key: string ]: Date[] } \| { [ key: string ]: () => Date[] }` | - | +| `[nzRenderExtraFooter]` | render extra footer in panel | `TemplateRef \| string \| (() => TemplateRef \| string)` | - | +| `[nzShowTime]` | to provide an additional time selection | `object \| boolean` | [TimePicker Options](/components/time-picker/en#api) | | `[nzPlaceHolder]` | placeholder of date input | `string[]` | - | | `(nzOnOk)` | click ok callback | `EventEmitter` | - | | `(ngModelChange)` | Date change callback | `EventEmitter` | - | diff --git a/components/date-picker/doc/index.zh-CN.md b/components/date-picker/doc/index.zh-CN.md index 2696ad83f05..1ede6e3c9cb 100644 --- a/components/date-picker/doc/index.zh-CN.md +++ b/components/date-picker/doc/index.zh-CN.md @@ -47,14 +47,14 @@ import { NzDatePickerModule } from 'ng-zorro-antd'; | `[nzAllowClear]` | 是否显示清除按钮 | `boolean` | `true` | | `[nzAutoFocus]` | 自动获取焦点 | `boolean` | `false` | | `[nzClassName]` | 选择器 className | `string` | `''` | -| `[nzDateRender]` | 自定义日期单元格的内容(month-picker/year-picker不支持) | `TemplateRef|string|((d: Date) => TemplateRef|string)` | - | +| `[nzDateRender]` | 自定义日期单元格的内容(month-picker/year-picker不支持) | `TemplateRef \| string \| ((d: Date) => TemplateRef \| string)` | - | | `[nzDisabled]` | 禁用 | `boolean` | `false` | | `[nzDisabledDate]` | 不可选择的日期 | `(current: Date) => boolean` | - | | `[nzLocale]` | 国际化配置 | `object` | [默认配置](https://github.com/ant-design/ant-design/blob/master/components/date-picker/locale/example.json) | | `[nzOpen]` | 控制弹层是否展开 | `boolean` | - | | `[nzPopupStyle]` | 额外的弹出日历样式 | `object` | `{}` | | `[nzDropdownClassName]` | 额外的弹出日历 className | `string` | - | -| `[nzSize]` | 输入框大小,`large` 高度为 40px,`small` 为 24px,默认是 32px | `'large'|'small'` | - | +| `[nzSize]` | 输入框大小,`large` 高度为 40px,`small` 为 24px,默认是 32px | `'large' \| 'small'` | - | | `[nzStyle]` | 自定义输入框样式 | `object` | `{}` | | `(nzOnOpenChange)` | 弹出日历和关闭日历的回调 | `EventEmitter` | - | @@ -65,8 +65,8 @@ import { NzDatePickerModule } from 'ng-zorro-antd'; | `[ngModel]` | 日期 | `Date` | - | | `[nzDisabledTime]` | 不可选择的时间 | `(current: Date) => { nzDisabledHours, nzDisabledMinutes, nzDisabledSeconds }` | - | | `[nzFormat]` | 展示的日期格式,见`nzFormat特别说明` | `string` | `"yyyy-MM-dd"` | -| `[nzRenderExtraFooter]` | 在面板中添加额外的页脚 | `TemplateRef|string|(() => TemplateRef|string)` | - | -| `[nzShowTime]` | 增加时间选择功能 | `object|boolean` | [TimePicker Options](/components/time-picker/zh#api) | +| `[nzRenderExtraFooter]` | 在面板中添加额外的页脚 | `TemplateRef \| string \| (() => TemplateRef \| string)` | - | +| `[nzShowTime]` | 增加时间选择功能 | `object \| boolean` | [TimePicker Options](/components/time-picker/zh#api) | | `[nzShowToday]` | 是否展示“今天”按钮 | `boolean` | `true` | | `[nzPlaceHolder]` | 输入框提示文字 | `string` | - | | `(nzOnOk)` | 点击确定按钮的回调 | `EventEmitter` | - | @@ -78,7 +78,7 @@ import { NzDatePickerModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[ngModel]` | 日期 | `Date` | - | | `[nzFormat]` | 展示的日期格式,见`nzFormat特别说明` | `string` | `"yyyy"` | -| `[nzRenderExtraFooter]` | 在面板中添加额外的页脚 | `TemplateRef|string|(() => TemplateRef|string)` | - | +| `[nzRenderExtraFooter]` | 在面板中添加额外的页脚 | `TemplateRef \| string \| (() => TemplateRef \| string)` | - | | `[nzPlaceHolder]` | 输入框提示文字 | `string` | - | | `(ngModelChange)` | 时间发生变化的回调 | `EventEmitter` | - | @@ -88,7 +88,7 @@ import { NzDatePickerModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[ngModel]` | 日期 | `Date` | - | | `[nzFormat]` | 展示的日期格式,见`nzFormat特别说明` | `string` | `"yyyy-MM"` | -| `[nzRenderExtraFooter]` | 在面板中添加额外的页脚 | `TemplateRef|string|(() => TemplateRef|string)` | - | +| `[nzRenderExtraFooter]` | 在面板中添加额外的页脚 | `TemplateRef \| string \| (() => TemplateRef \| string)` | - | | `[nzPlaceHolder]` | 输入框提示文字 | `string` | - | | `(ngModelChange)` | 时间发生变化的回调 | `EventEmitter` | - | @@ -106,11 +106,11 @@ import { NzDatePickerModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[ngModel]` | 日期 | `Date[]` | - | -| `[nzDisabledTime]` | 不可选择的时间 | `(current: Date, partial: 'start'|'end') => { nzDisabledHours, nzDisabledMinutes, nzDisabledSeconds }` | - | +| `[nzDisabledTime]` | 不可选择的时间 | `(current: Date, partial: 'start' \| 'end') => { nzDisabledHours, nzDisabledMinutes, nzDisabledSeconds }` | - | | `[nzFormat]` | 展示的日期格式,见`nzFormat特别说明` | `string` | `"yyyy-MM-dd"` | -| `[nzRanges]` | 预设时间范围快捷选择 | `{ [ key: string ]: Date[] } | { [ key: string ]: () => Date[] }` | - | -| `[nzRenderExtraFooter]` | 在面板中添加额外的页脚 | `TemplateRef|string|(() => TemplateRef|string)` | - | -| `[nzShowTime]` | 增加时间选择功能 | `object|boolean` | [TimePicker Options](/components/time-picker/zh#api) | +| `[nzRanges]` | 预设时间范围快捷选择 | `{ [ key: string ]: Date[] } \| { [ key: string ]: () => Date[] }` | - | +| `[nzRenderExtraFooter]` | 在面板中添加额外的页脚 | `TemplateRef \| string \| (() => TemplateRef \| string)` | - | +| `[nzShowTime]` | 增加时间选择功能 | `object \| boolean` | [TimePicker Options](/components/time-picker/zh#api) | | `[nzPlaceHolder]` | 输入框提示文字 | `string[]` | - | | `(nzOnOk)` | 点击确定按钮的回调 | `EventEmitter` | - | | `(ngModelChange)` | 时间发生变化的回调 | `EventEmitter` | - | diff --git a/components/descriptions/doc/index.en-US.md b/components/descriptions/doc/index.en-US.md index 1308e191df5..dacc68012ba 100644 --- a/components/descriptions/doc/index.en-US.md +++ b/components/descriptions/doc/index.en-US.md @@ -20,7 +20,7 @@ Commonly displayed on the details page. | `[nzTitle]` | Describe the title of the list, displayed at the top | `string\|TemplateRef` | `false` | | `[nzBordered]` | Whether to display the border | `boolean` | `false` | | `[nzColumn]` | The number of `nz-descriptions-item` in a row. It could be a number or a object like `{ xs: 8, sm: 16, md: 24}` | `number\|object` | `{ xxl: 3, xl: 3, lg: 3, md: 3, sm: 2, xs: 1 }` | -| `[nzSize]` | Set the size of the list. Only works when `nzBordered` is set | `'default'|'middle'|'small'` | `'default'` | +| `[nzSize]` | Set the size of the list. Only works when `nzBordered` is set | `'default' \| 'middle' \| 'small'` | `'default'` | ### Import this Component Individually diff --git a/components/descriptions/doc/index.zh-CN.md b/components/descriptions/doc/index.zh-CN.md index de534607788..77f33db79e8 100644 --- a/components/descriptions/doc/index.zh-CN.md +++ b/components/descriptions/doc/index.zh-CN.md @@ -21,7 +21,7 @@ cols: 1 | `[nzTitle]` | 描述列表的标题,显示在最顶部 | `string\|TemplateRef` | `false` | | `[nzBorder]` | 是否展示边框 | `boolean` | `false` | | `[nzColumn]` | 一行的 `nz-descriptions-item` 的数量,可以写成像素值或支持响应式的对象写法 `{ xs: 8, sm: 16, md: 24}` | `number\|object` | `{ xxl: 3, xl: 3, lg: 3, md: 3, sm: 2, xs: 1 }` | -| `[nzSize]` | 设置列表的大小(只有设置 `nzBordered` 时生效) | `'default'|'middle'|'small'` | `'default'` | +| `[nzSize]` | 设置列表的大小(只有设置 `nzBordered` 时生效) | `'default' \| 'middle' \| 'small'` | `'default'` | ### 单独引入此组件 diff --git a/components/divider/doc/index.en-US.md b/components/divider/doc/index.en-US.md index 2211eaf28b6..c41e556c490 100644 --- a/components/divider/doc/index.en-US.md +++ b/components/divider/doc/index.en-US.md @@ -26,6 +26,6 @@ import { NzDividerModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | `[nzDashed]` | whether line is dasded | `boolean` | `false` | -| `[nzType]` | direction type of divider | `'horizontal'|'vertical'` | `'horizontal'` | -| `[nzText]` | inner text of divider | `string|TemplateRef` | - | -| `[nzOrientation]` | inner text orientation | `'left'|'right'` | - | +| `[nzType]` | direction type of divider | `'horizontal' \| 'vertical'` | `'horizontal'` | +| `[nzText]` | inner text of divider | `string \| TemplateRef` | - | +| `[nzOrientation]` | inner text orientation | `'left' \| 'right'` | - | diff --git a/components/divider/doc/index.zh-CN.md b/components/divider/doc/index.zh-CN.md index 6e53850e983..63fd1595869 100644 --- a/components/divider/doc/index.zh-CN.md +++ b/components/divider/doc/index.zh-CN.md @@ -27,6 +27,6 @@ import { NzDividerModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[nzDashed]` | 是否虚线 | `boolean` | `false` | -| `[nzType]` | 水平还是垂直类型 | `'horizontal'|'vertical'` | `'horizontal'` | -| `[nzText]` | 中间文字 | `string|TemplateRef` | - | -| `[nzOrientation]` | 中间文字方向 | `'left'|'right'` | - | +| `[nzType]` | 水平还是垂直类型 | `'horizontal' \| 'vertical'` | `'horizontal'` | +| `[nzText]` | 中间文字 | `string \| TemplateRef` | - | +| `[nzOrientation]` | 中间文字方向 | `'left' \| 'right'` | - | diff --git a/components/drawer/doc/index.en-US.md b/components/drawer/doc/index.en-US.md index 093cb0eebe4..2af8add75a1 100755 --- a/components/drawer/doc/index.en-US.md +++ b/components/drawer/doc/index.en-US.md @@ -32,11 +32,11 @@ import { NzDrawerModule } from 'ng-zorro-antd'; | `[nzMaskClosable]` | Clicking on the mask (area outside the Drawer) to close the Drawer or not. | `boolean` | `true` | | `[nzMaskStyle]` | Style for Drawer's mask element. | `object` | `{}` | | `[nzBodyStyle]` | Body style for drawer body element. Such as height, padding etc. | `object` | `{}` | -| `[nzTitle]` | The title for Drawer. | `string|TemplateRef` | - | +| `[nzTitle]` | The title for Drawer. | `string \| TemplateRef` | - | | `[nzVisible]` | Whether the Drawer dialog is visible or not. | `boolean` | `false` | -| `[nzPlacement]` | The placement of the Drawer. | `'top'|'right'|'bottom'|'left'` | `'right'` | -| `[nzWidth]` | Width of the Drawer dialog, only when placement is `'right'` or `'left'`. | `number|string` | `256` | -| `[nzHeight]` | Height of the Drawer dialog, only when placement is `'top'` or `'bottom'`. | `number|string` | `256` | +| `[nzPlacement]` | The placement of the Drawer. | `'top' \| 'right' \| 'bottom' \| 'left'` | `'right'` | +| `[nzWidth]` | Width of the Drawer dialog, only when placement is `'right'` or `'left'`. | `number \| string` | `256` | +| `[nzHeight]` | Height of the Drawer dialog, only when placement is `'top'` or `'bottom'`. | `number \| string` | `256` | | `[nzOffsetX]` | The the X coordinate offset(px), only when placement is `'right'` or `'left'`. | `number` | `0` | | `[nzOffsetY]` | The the Y coordinate offset(px), only when placement is `'top'` or `'bottom'`. | `number` | `0` | | `[nzWrapClassName]` | The class name of the container of the Drawer dialog. | `string` | - | @@ -53,7 +53,7 @@ import { NzDrawerModule } from 'ng-zorro-antd'; | Params | Description | Type | Default | | --- | --- | --- | --- | -| nzContent | The drawer body content. | `TemplateRef<{ $implicit: D, drawerRef: NzDrawerRef }>|Type` | - | +| nzContent | The drawer body content. | `TemplateRef<{ $implicit: D, drawerRef: NzDrawerRef }> \| Type` | - | | nzContentParams | The component inputs the param / The Template context. | `D` | - | | nzClosable | Whether a close (x) button is visible on top right of the Drawer dialog or not. | `boolean` | `true` | | nzOnCancel | Execute when click on the mask or the upper cancel button, This function returns a promise, which is automatically closed when the execution is complete or the promise ends (return false to prevent closing) | `() => Promise` | - | @@ -61,12 +61,12 @@ import { NzDrawerModule } from 'ng-zorro-antd'; | nzMask | Whether to show mask or not. | `boolean` | `true` | | nzMaskStyle | Style for Drawer's mask element. | `object` | `{}` | | nzBodyStyle | Body style for modal body element. Such as height, padding etc. | `object` | `{}` | -| nzTitle | The title for Drawer. | `string|TemplateRef` | - | -| nzWidth | Width of the Drawer dialog. | `number|string` | `256` | -| nzHeight | Height of the Drawer dialog, only when placement is `'top'` or `'bottom'`. | `number|string` | `256` | +| nzTitle | The title for Drawer. | `string \| TemplateRef` | - | +| nzWidth | Width of the Drawer dialog. | `number \| string` | `256` | +| nzHeight | Height of the Drawer dialog, only when placement is `'top'` or `'bottom'`. | `number \| string` | `256` | | nzWrapClassName | The class name of the container of the Drawer dialog. | `string` | - | | nzZIndex| The `z-index` of the Drawer. | `number` | `1000` | -| nzPlacement | The placement of the Drawer. | `'top'|'right'|'bottom'|'left'` | `'right'` | +| nzPlacement | The placement of the Drawer. | `'top' \| 'right' \| 'bottom' \| 'left'` | `'right'` | | nzOffsetX | The the X coordinate offset(px). | `number` | `0` | | nzOffsetY | The the Y coordinate offset(px), only when placement is `'top'` or `'bottom'`. | `number` | `0` | @@ -89,11 +89,11 @@ import { NzDrawerModule } from 'ng-zorro-antd'; | nzMask | Whether to show mask or not. | `boolean` | `true` | | nzMaskStyle | Style for Drawer's mask element. | `object` | `{}` | | nzBodyStyle | Body style for modal body element. Such as height, padding etc. | `object` | `{}` | -| nzTitle | The title for Drawer. | `string|TemplateRef` | - | -| nzWidth | Width of the Drawer dialog. | `number|string` | `256` | -| nzHeight | Height of the Drawer dialog, only when placement is `'top'` or `'bottom'`. | `number|string` | `256` | +| nzTitle | The title for Drawer. | `string \| TemplateRef` | - | +| nzWidth | Width of the Drawer dialog. | `number \| string` | `256` | +| nzHeight | Height of the Drawer dialog, only when placement is `'top'` or `'bottom'`. | `number \| string` | `256` | | nzWrapClassName | The class name of the container of the Drawer dialog. | `string` | - | | nzZIndex| The `z-index` of the Drawer. | `number` | `1000` | -| nzPlacement | The placement of the Drawer. | `'top'|'right'|'bottom'|'left'` | `'right'` | +| nzPlacement | The placement of the Drawer. | `'top' \| 'right' \| 'bottom' \| 'left'` | `'right'` | | nzOffsetX | The the X coordinate offset(px). | `number` | `0` | | nzOffsetY | The the Y coordinate offset(px), only when placement is `'top'` or `'bottom'`. | `number` | `0` | \ No newline at end of file diff --git a/components/drawer/doc/index.zh-CN.md b/components/drawer/doc/index.zh-CN.md index ccb8dc84d78..d8fc9159601 100755 --- a/components/drawer/doc/index.zh-CN.md +++ b/components/drawer/doc/index.zh-CN.md @@ -33,11 +33,11 @@ import { NzDrawerModule } from 'ng-zorro-antd'; | `[nzMask]` | 是否展示遮罩 | `boolean` | `true` | | `[nzMaskStyle]` | 遮罩样式 | `object` | `{}` | | `[nzBodyStyle]` | Drawer body 样式 | `object` | `{}` | -| `[nzTitle]` | 标题 | `string|TemplateRef` | - | +| `[nzTitle]` | 标题 | `string \| TemplateRef` | - | | `[nzVisible]` | Drawer 是否可见 | `boolean` | - | -| `[nzPlacement]` | 抽屉的方向 | `'top'|'right'|'bottom'|'left'` | `'right'` | -| `[nzWidth]` | 宽度, 只在方向为 `'right'`或`'left'` 时生效 | `number|string` | `256` | -| `[nzHeight]` | 高度, 只在方向为 `'top'`或`'bottom'` 时生效 | `number|string` | `256` | +| `[nzPlacement]` | 抽屉的方向 | `'top' \| 'right' \| 'bottom' \| 'left'` | `'right'` | +| `[nzWidth]` | 宽度, 只在方向为 `'right'`或`'left'` 时生效 | `number \| string` | `256` | +| `[nzHeight]` | 高度, 只在方向为 `'top'`或`'bottom'` 时生效 | `number \| string` | `256` | | `[nzOffsetX]` | x 坐标移量(px), 只在方向为 `'right'`或`'left'` 时生效 | `number` | `0` | | `[nzOffsetY]` | y 坐标移量(px), 高度, 只在方向为 `'top'`或`'bottom'` 时生效 | `number` | `0` | | `[nzWrapClassName]` | 对话框外层容器的类名 | `string` | - | @@ -54,7 +54,7 @@ import { NzDrawerModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| nzContent | Drawer body 的内容 | `TemplateRef<{ $implicit: D, drawerRef: NzDrawerRef }>| Type` | - | +| nzContent | Drawer body 的内容 | `TemplateRef<{ $implicit: D, drawerRef: NzDrawerRef }> \| Type` | - | | nzContentParams | 内容组件的输入参数 / Template的 context | `D` | - | | nzOnCancel | 点击遮罩层或右上角叉时执行,该函数可返回 promise 待执行完毕或 promise 结束时,将自动关闭对话框(返回false可阻止关闭) | `() => Promise` | - | | nzClosable | 是否显示右上角的关闭按钮 | `boolean` | `true` | @@ -62,12 +62,12 @@ import { NzDrawerModule } from 'ng-zorro-antd'; | nzMask | 是否展示遮罩 | `boolean` | `true` | | nzMaskStyle | 遮罩样式 | `object` | `{}` | | nzBodyStyle | Modal body 样式 | `object` | `{}` | -| nzTitle | 标题 | `string|TemplateRef` | - | -| nzWidth | 宽度 | `number|string` | `256` | -| nzHeight | 高度, 只在方向为 `'top'`或`'bottom'` 时生效 | `number|string` | `256` | +| nzTitle | 标题 | `string \| TemplateRef` | - | +| nzWidth | 宽度 | `number \| string` | `256` | +| nzHeight | 高度, 只在方向为 `'top'`或`'bottom'` 时生效 | `number \| string` | `256` | | nzWrapClassName | 对话框外层容器的类名 | `string` | - | | nzZIndex| 设置 Drawer 的 `z-index` | `number` | `1000` | -| nzPlacement | 抽屉的方向 | `'top'|'right'|'bottom'|'left'` | `'right'` | +| nzPlacement | 抽屉的方向 | `'top' \| 'right' \| 'bottom' \| 'left'` | `'right'` | | nzOffsetX | x 坐标移量(px) | `number` | `0` | | nzOffsetY | y 坐标移量(px), 高度, 只在方向为 `'top'`或`'bottom'` 时生效 | `number` | `0` | @@ -91,11 +91,11 @@ import { NzDrawerModule } from 'ng-zorro-antd'; | nzMask | 是否展示遮罩 | `boolean` | `true` | | nzMaskStyle | 遮罩样式 | `object` | `{}` | | nzBodyStyle | Modal body 样式 | `object` | `{}` | -| nzTitle | 标题 | `string|TemplateRef` | - | -| nzWidth | 宽度 | `number|string` | `256` | -| nzHeight | 高度, 只在方向为 `'top'`或`'bottom'` 时生效 | `number|string` | `256` | +| nzTitle | 标题 | `string \| TemplateRef` | - | +| nzWidth | 宽度 | `number \| string` | `256` | +| nzHeight | 高度, 只在方向为 `'top'`或`'bottom'` 时生效 | `number \| string` | `256` | | nzWrapClassName | 对话框外层容器的类名 | `string` | - | | nzZIndex| 设置 Drawer 的 `z-index` | `number` | `1000` | -| nzPlacement | 抽屉的方向 | `'top'|'right'|'bottom'|'left'` | `'right'` | +| nzPlacement | 抽屉的方向 | `'top' \| 'right' \| 'bottom' \| 'left'` | `'right'` | | nzOffsetX | x 坐标移量(px) | `number` | `0` | | nzOffsetY | y 坐标移量(px), 高度, 只在方向为 `'top'`或`'bottom'` 时生效 | `number` | `0` | \ No newline at end of file diff --git a/components/dropdown/doc/index.en-US.md b/components/dropdown/doc/index.en-US.md index 307e99a4d5f..9ed1b92fa0d 100755 --- a/components/dropdown/doc/index.en-US.md +++ b/components/dropdown/doc/index.en-US.md @@ -26,8 +26,8 @@ import { NzDropDownModule } from 'ng-zorro-antd'; | -------- | ----------- | ---- | ------- | | `[nzDropdownMenu]` | Dropdown menu | `NzDropdownMenuComponent` | - | | `[nzDisabled]` | whether the dropdown menu is disabled | `boolean` | - | -| `[nzPlacement]` | placement of pop menu | `'bottomLeft'|'bottomCenter'|'bottomRight'|'topLeft'|'topCenter'|'topRight'` | `'bottomLeft'` | -| `[nzTrigger]` | the trigger mode which executes the drop-down action | `'click'|'hover'` | `'hover'` | +| `[nzPlacement]` | placement of pop menu | `'bottomLeft' \| 'bottomCenter' \| 'bottomRight' \| 'topLeft' \| 'topCenter' \| 'topRight'` | `'bottomLeft'` | +| `[nzTrigger]` | the trigger mode which executes the drop-down action | `'click' \| 'hover'` | `'hover'` | | `[nzClickHide]` | whether hide menu when click | `boolean` | `true` | | `[nzVisible]` | whether the dropdown menu is visible, double binding | `boolean` | - | | `[nzOverlayClassName]` | Class name of the dropdown root element | `string` | - | diff --git a/components/dropdown/doc/index.zh-CN.md b/components/dropdown/doc/index.zh-CN.md index d0abaca35ab..ed793a1385d 100755 --- a/components/dropdown/doc/index.zh-CN.md +++ b/components/dropdown/doc/index.zh-CN.md @@ -27,8 +27,8 @@ import { NzDropDownModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[nzDropdownMenu]` | Dropdown 下拉菜单组件 | `NzDropdownMenuComponent` | - | | `[nzDisabled]` | 菜单是否禁用 | `boolean` | - | -| `[nzPlacement]` | 菜单弹出位置 | `'bottomLeft'|'bottomCenter'|'bottomRight'|'topLeft'|'topCenter'|'topRight'` | `'bottomLeft'` | -| `[nzTrigger]` | 触发下拉的行为 | `'click'|'hover'` | `'hover'` | +| `[nzPlacement]` | 菜单弹出位置 | `'bottomLeft' \| 'bottomCenter' \| 'bottomRight' \| 'topLeft' \| 'topCenter' \| 'topRight'` | `'bottomLeft'` | +| `[nzTrigger]` | 触发下拉的行为 | `'click' \| 'hover'` | `'hover'` | | `[nzClickHide]` | 点击后是否隐藏菜单 | `boolean` | `true` | | `[nzVisible]` | 菜单是否显示,可双向绑定 | `boolean` | - | | `[nzOverlayClassName]` | 下拉根元素的类名称 | `string` | - | diff --git a/components/empty/doc/index.en-US.md b/components/empty/doc/index.en-US.md index e0ce57747db..9164737d905 100644 --- a/components/empty/doc/index.en-US.md +++ b/components/empty/doc/index.en-US.md @@ -25,22 +25,22 @@ import { NzEmptyModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzNotFoundImage]` | Customize image. Will tread as image url when string provided | `string` | `TemplateRef` | - | -| `[nzNotFoundContent]` | Custom description | `string` | `TemplateRef` | - | -| `[nzNotFoundFooter]` | Custom Footer | `string` | `TemplateRef` | - | +| `[nzNotFoundImage]` | Customize image. Will tread as image url when string provided | `string` \| `TemplateRef` | - | +| `[nzNotFoundContent]` | Custom description | `string` \| `TemplateRef` | - | +| `[nzNotFoundFooter]` | Custom Footer | `string` \| `TemplateRef` | - | ### NzEmptyService | Methods/Properties | Description | Parameters | | -------- | ----------- | ---- | -| `setDefaultContent` | To set the default empty content. The parent component name would be passed to the template. | `TemplateRef` | `string` | +| `setDefaultContent` | To set the default empty content. The parent component name would be passed to the template. | `TemplateRef` \| `string` | | `resetDefault` | Reset default empty content | - | ### InjectionToken | Token | Description | Parameters | | ----- | --- | ---- | -| `NZ_DEFAULT_EMPTY_CONTENT` | To provide a user default empty component | `Component` | `string` | +| `NZ_DEFAULT_EMPTY_CONTENT` | To provide a user default empty component | `Component` \| `string` | | `NZ_EMPTY_COMPONENT_NAME` | Would be injected to `NZ_DEFAULT_EMPTY_CONTENT`, telling that component its parent component's name | `string` | ### Global Customizable Empty Content diff --git a/components/empty/doc/index.zh-CN.md b/components/empty/doc/index.zh-CN.md index 4c1b3869358..683a98a7f0b 100644 --- a/components/empty/doc/index.zh-CN.md +++ b/components/empty/doc/index.zh-CN.md @@ -26,22 +26,22 @@ import { NzEmptyModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | -------- | ----------- | ---- | ------- | -| `[nzNotFoundImage]` | 设置显示图片,为 `string` 时表示自定义图片地址 | `string` | `TemplateRef` | - | -| `[nzNotFoundContent]` | 自定义描述内容 | `string` | `TemplateRef` | - | -| `[nzNotFoundFooter]` | 设置自定义 footer | `string` | `TemplateRef` | - | +| `[nzNotFoundImage]` | 设置显示图片,为 `string` 时表示自定义图片地址 | `string` \| `TemplateRef` | - | +| `[nzNotFoundContent]` | 自定义描述内容 | `string` \| `TemplateRef` | - | +| `[nzNotFoundFooter]` | 设置自定义 footer | `string` \| `TemplateRef` | - | ### NzEmptyService | 属性/方法 | 说明 | 参数 | | -------- | ----------- | ---- | -| `setDefaultEmptyContent` | 设置全局空内容,空组件的父组件名称将会被传递给模板 | `TemplateRef` | `string` | +| `setDefaultEmptyContent` | 设置全局空内容,空组件的父组件名称将会被传递给模板 | `TemplateRef` \| `string` | | `resetDefault` | 重置默认空内容 | - | ### InjectionToken | Token | 说明 | 参数 | | ----- | --- | ---- | -| `NZ_DEFAULT_EMPTY_CONTENT` | 提供一个用户自定义的空组件 | `Component` | `string` | +| `NZ_DEFAULT_EMPTY_CONTENT` | 提供一个用户自定义的空组件 | `Component` \| `string` | | `NZ_EMPTY_COMPONENT_NAME` | 将会被注入到 `NZ_DEFAULT_EMPTY_CONTENT` 中,告诉该组件其父组件的名称 | `string` | ### 全局自定义空组件 diff --git a/components/form/doc/index.en-US.md b/components/form/doc/index.en-US.md index 5cfa625db6b..d0973724198 100644 --- a/components/form/doc/index.en-US.md +++ b/components/form/doc/index.en-US.md @@ -58,7 +58,7 @@ import { NzFormModule } from 'ng-zorro-antd'; | Property | Description | Type | Default Value | | -------- | ----------- | ---- | ------------- | -| `[nzLayout]`| Form layout | `'horizontal'|'vertical'|'inline'` | `'horizontal'` | +| `[nzLayout]`| Form layout | `'horizontal' \| 'vertical' \| 'inline'` | `'horizontal'` | | `[nzNoColon]`| change default props `[nzNoColon]` value of `nz-form-label` | `boolean` | `false` | @@ -94,13 +94,13 @@ A form consists of one or more form fields whose type includes input, textarea, | Property | Description | Type | Default Value | | --- | --- | --- | --- | -| `[nzValidateStatus]` | Will generate status based on the input `FormControl`, `NgModel` or string, the default value is the first `FormControl` or `NgModel` in `nz-form-control` | `'success'|'warning'|'error'|'validating' | FormControl | NgModel` | first `FormControl` or `NgModel` in `nz-form-control` | +| `[nzValidateStatus]` | Will generate status based on the input `FormControl`, `NgModel` or string, the default value is the first `FormControl` or `NgModel` in `nz-form-control` | `'success' \| 'warning' \| 'error' \| 'validating' \| FormControl \| NgModel` | first `FormControl` or `NgModel` in `nz-form-control` | | `[nzHasFeedback]`| Used with `nzValidateStatus`, this option specifies the validation status icon. Recommended to be used only with `Input`. | `boolean` | `false` | -| `[nzExtra]`| The extra prompt message | `string | TemplateRef` | - | -| `[nzSuccessTip]`| Tip display when validate success | `string | TemplateRef<{ $implicit: FormControl | NgModel }>` | - | -| `[nzWarningTip]`| Tip display when validate warning | `string | TemplateRef<{ $implicit: FormControl | NgModel }>` | - | -| `[nzErrorTip]`| Tip display when validate error | `string | TemplateRef<{ $implicit: FormControl | NgModel }>` | - | -| `[nzValidatingTip]`| Tip display when validating | `string | TemplateRef<{ $implicit: FormControl | NgModel }>` | - | +| `[nzExtra]`| The extra prompt message | `string \| TemplateRef` | - | +| `[nzSuccessTip]`| Tip display when validate success | `string \| TemplateRef<{ $implicit: FormControl \| NgModel }>` | - | +| `[nzWarningTip]`| Tip display when validate warning | `string \| TemplateRef<{ $implicit: FormControl \| NgModel }>` | - | +| `[nzErrorTip]`| Tip display when validate error | `string \| TemplateRef<{ $implicit: FormControl \| NgModel }>` | - | +| `[nzValidatingTip]`| Tip display when validating | `string \| TemplateRef<{ $implicit: FormControl \| NgModel }>` | - | ### nz-form-split diff --git a/components/form/doc/index.zh-CN.md b/components/form/doc/index.zh-CN.md index 8c15aba5975..a9443944981 100644 --- a/components/form/doc/index.zh-CN.md +++ b/components/form/doc/index.zh-CN.md @@ -56,7 +56,7 @@ import { NzFormModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzLayout]`| 表单布局 | `'horizontal'|'vertical'|'inline'` | `'horizontal'` | +| `[nzLayout]`| 表单布局 | `'horizontal' \| 'vertical' \| 'inline'` | `'horizontal'` | | `[nzNoColon]`| 配置 `nz-form-label` 的 `[nzNoColon]` 的默认值 | `boolean` | `false` | ### nz-form-item @@ -93,13 +93,13 @@ import { NzFormModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzValidateStatus]` | 会根据传入的 `FormControl` 或 `NgModel` 自动生成校验状态,也可以直接指定状态,不传入时默认值为 `nz-form-control` 中包裹的第一个 `FormControl` 或 `NgModel` | `'success'|'warning'|'error'|'validating' | FormControl | NgModel` | `nz-form-control` 中包裹的第一个 `FormControl` 或 `NgModel` | +| `[nzValidateStatus]` | 会根据传入的 `FormControl` 或 `NgModel` 自动生成校验状态,也可以直接指定状态,不传入时默认值为 `nz-form-control` 中包裹的第一个 `FormControl` 或 `NgModel` | `'success' \| 'warning' \| 'error' \| 'validating' \| FormControl \| NgModel` | `nz-form-control` 中包裹的第一个 `FormControl` 或 `NgModel` | | `[nzHasFeedback]`| 配合 `nzValidateStatus` 属性使用,展示校验状态图标 | `boolean` | `false`| -| `[nzExtra]`| 用于显示表单额外提示信息 | `string | TemplateRef` | - | -| `[nzSuccessTip]`| 校验状态 success 时提示信息 | `string | TemplateRef<{ $implicit: FormControl | NgModel }>` | - | -| `[nzWarningTip]`| 校验状态 warning 时提示信息 | `string | TemplateRef<{ $implicit: FormControl | NgModel }>` | - | -| `[nzErrorTip]`| 校验状态 error 时提示信息 | `string | TemplateRef<{ $implicit: FormControl | NgModel }>` | - | -| `[nzValidatingTip]`| 正在校验时提示信息 | `string | TemplateRef<{ $implicit: FormControl | NgModel }>` | - | +| `[nzExtra]`| 用于显示表单额外提示信息 | `string \| TemplateRef` | - | +| `[nzSuccessTip]`| 校验状态 success 时提示信息 | `string \| TemplateRef<{ $implicit: FormControl \| NgModel }>` | - | +| `[nzWarningTip]`| 校验状态 warning 时提示信息 | `string \| TemplateRef<{ $implicit: FormControl \| NgModel }>` | - | +| `[nzErrorTip]`| 校验状态 error 时提示信息 | `string \| TemplateRef<{ $implicit: FormControl \| NgModel }>` | - | +| `[nzValidatingTip]`| 正在校验时提示信息 | `string \| TemplateRef<{ $implicit: FormControl \| NgModel }>` | - | ### nz-form-split diff --git a/components/grid/doc/index.en-US.md b/components/grid/doc/index.en-US.md index efc8439416d..87979ef2bcb 100755 --- a/components/grid/doc/index.en-US.md +++ b/components/grid/doc/index.en-US.md @@ -93,9 +93,9 @@ import { NzGridModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzAlign]` | the vertical alignment of the flex layout | `'top'|'middle'|'bottom'` | `'top'` | -| `[nzGutter]` | spacing between grids, could be a number or a object like `{ xs: 8, sm: 16, md: 24, lg: 32, xl: 32, xxl: 32 }` | `number|object` | `0` | -| `[nzJustify]` | horizontal arrangement of the flex layout | `'start'|'end'|'center'|'space-around'|'space-between'` | `'start'` | +| `[nzAlign]` | the vertical alignment of the flex layout | `'top' \| 'middle' \| 'bottom'` | `'top'` | +| `[nzGutter]` | spacing between grids, could be a number or a object like `{ xs: 8, sm: 16, md: 24, lg: 32, xl: 32, xxl: 32 }` | `number \| object` | `0` | +| `[nzJustify]` | horizontal arrangement of the flex layout | `'start' \| 'end' \| 'center' \| 'space-around' \| 'space-between'` | `'start'` | | `[nzType]` | layout mode, optional `flex`, [browser support](http://caniuse.com/#search=flex) | `'flex'` | - | ### [nz-col] @@ -107,11 +107,11 @@ import { NzGridModule } from 'ng-zorro-antd'; | `[nzPull]` | the number of cells that raster is moved to the left | `number` | `0` | | `[nzPush]` | the number of cells that raster is moved to the right | `number` | `0` | | `[nzSpan]` | raster number of cells to occupy, 0 corresponds to `display: none` | `number` | - | -| `[nzXs]` | `<576px` and also default setting, could be a `span` value or an object containing above props | `number|object` | - | -| `[nzSm]` | `≥576px`, could be a `span` value or an object containing above props | `number|object` | - | -| `[nzMd]` | `≥768px`, could be a `span` value or an object containing above props | `number|object` | - | -| `[nzLg]` | `≥992px`, could be a `span` value or an object containing above props | `number|object` | - | -| `[nzXl]` | `≥1200px`, could be a `span` value or an object containing above props | `number|object` | - | -| `[nzXXl]` | `≥1600px`, could be a `span` value or an object containing above props | `number|object` | - | +| `[nzXs]` | `<576px` and also default setting, could be a `span` value or an object containing above props | `number \| object` | - | +| `[nzSm]` | `≥576px`, could be a `span` value or an object containing above props | `number \| object` | - | +| `[nzMd]` | `≥768px`, could be a `span` value or an object containing above props | `number \| object` | - | +| `[nzLg]` | `≥992px`, could be a `span` value or an object containing above props | `number \| object` | - | +| `[nzXl]` | `≥1200px`, could be a `span` value or an object containing above props | `number \| object` | - | +| `[nzXXl]` | `≥1600px`, could be a `span` value or an object containing above props | `number \| object` | - | The breakpoints of responsive grid follow [BootStrap 4 media queries rules](https://getbootstrap.com/docs/4.0/layout/overview/#responsive-breakpoints)(not including `occasionally part`). diff --git a/components/grid/doc/index.zh-CN.md b/components/grid/doc/index.zh-CN.md index e40861a1808..c039158d8ca 100755 --- a/components/grid/doc/index.zh-CN.md +++ b/components/grid/doc/index.zh-CN.md @@ -92,9 +92,9 @@ import { NzGridModule } from 'ng-zorro-antd'; | 成员 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzAlign]` | flex 布局下的垂直对齐方式 | `'top'|'middle'|'bottom'` | `'top'` | -| `[nzGutter]` | 栅格间隔,可以写成像素值或支持响应式的对象写法 `{ xs: 8, sm: 16, md: 24, lg: 32, xl: 32, xxl: 32 }` | `number|object` | `0` | -| `[nzJustify]` | flex 布局下的水平排列方式 | `'start'|'end'|'center'|'space-around'|'space-between'` | `'start'` | +| `[nzAlign]` | flex 布局下的垂直对齐方式 | `'top' \| 'middle' \| 'bottom'` | `'top'` | +| `[nzGutter]` | 栅格间隔,可以写成像素值或支持响应式的对象写法 `{ xs: 8, sm: 16, md: 24, lg: 32, xl: 32, xxl: 32 }` | `number \| object` | `0` | +| `[nzJustify]` | flex 布局下的水平排列方式 | `'start' \| 'end' \| 'center' \| 'space-around' \| 'space-between'` | `'start'` | | `[nzType]` | 布局模式,可选 `flex`,[现代浏览器](http://caniuse.com/#search=flex) 下有效 | `'flex'` | - | ### [nz-col] @@ -106,11 +106,11 @@ import { NzGridModule } from 'ng-zorro-antd'; | `[nzPull]` | 栅格向左移动格数 | `number` | `0` | | `[nzPush]` | 栅格向右移动格数 | `number` | `0` | | `[nzSpan]` | 栅格占位格数,为 0 时相当于 `display: none` | `number` | - | -| `[nzXs]` | `<576px` 响应式栅格,可为栅格数或一个包含其他属性的对象 | `number|object` | - | -| `[nzSm]` | `≥576px` 响应式栅格,可为栅格数或一个包含其他属性的对象 | `number|object` | - | -| `[nzMd]` | `≥768px` 响应式栅格,可为栅格数或一个包含其他属性的对象 | `number|object` | - | -| `[nzLg]` | `≥992px` 响应式栅格,可为栅格数或一个包含其他属性的对象 | `number|object` | - | -| `[nzXl]` | `≥1200px` 响应式栅格,可为栅格数或一个包含其他属性的对象 | `number|object` | - | -| `[nzXXl]` | `≥1600px` 响应式栅格,可为栅格数或一个包含其他属性的对象 | `number|object` | - | +| `[nzXs]` | `<576px` 响应式栅格,可为栅格数或一个包含其他属性的对象 | `number \| object` | - | +| `[nzSm]` | `≥576px` 响应式栅格,可为栅格数或一个包含其他属性的对象 | `number \| object` | - | +| `[nzMd]` | `≥768px` 响应式栅格,可为栅格数或一个包含其他属性的对象 | `number \| object` | - | +| `[nzLg]` | `≥992px` 响应式栅格,可为栅格数或一个包含其他属性的对象 | `number \| object` | - | +| `[nzXl]` | `≥1200px` 响应式栅格,可为栅格数或一个包含其他属性的对象 | `number \| object` | - | +| `[nzXXl]` | `≥1600px` 响应式栅格,可为栅格数或一个包含其他属性的对象 | `number \| object` | - | 响应式栅格的断点扩展自 [BootStrap 4 的规则](https://getbootstrap.com/docs/4.0/layout/overview/#responsive-breakpoints)(不包含链接里 `occasionally` 的部分)。 diff --git a/components/icon/doc/index.en-US.md b/components/icon/doc/index.en-US.md index 10726d74bb8..7f26ca631e8 100755 --- a/components/icon/doc/index.en-US.md +++ b/components/icon/doc/index.en-US.md @@ -33,7 +33,7 @@ import { NzIconModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | `[nzType]` | Type of the ant design icon | `string` | - | -| `[nzTheme]` | Type of the ant design icon | `'fill'|'outline'|'twotone'` | `'outline'` | +| `[nzTheme]` | Type of the ant design icon | `'fill' \| 'outline' \| 'twotone'` | `'outline'` | | `[nzSpin]` | Rotate icon with animation | `boolean` | `false` | | `[nzTwotoneColor]` | Only support the two-tone icon. Specific the primary color. | `string (hex color)` | - | | `[nzIconfont]` | Type of the icon from iconfont | `string` | - | diff --git a/components/input-number/doc/index.en-US.md b/components/input-number/doc/index.en-US.md index 51faec10383..c62e02138ad 100755 --- a/components/input-number/doc/index.en-US.md +++ b/components/input-number/doc/index.en-US.md @@ -28,16 +28,16 @@ The value entered in `nz-input-number` will not be verified at the time of input | property | description | type | default | | -------- | ----------- | ---- | ------- | -| `[ngModel]` | current value, double binding | `number|string` | `string` | - | +| `[ngModel]` | current value, double binding | `number \| string` \| `string` | - | | `[nzAutoFocus]` | get focus when component mounted | `boolean` | `false` | | `[nzDisabled]` | disable the input | `boolean` | `false` | | `[nzMax]` | max value | `number` | `Infinity` | | `[nzMin]` | min value | `number` | `-Infinity` | -| `[nzFormatter]` | Specifies the format of the value presented | `(value: number|string) => string|number` | - | -| `[nzParser]` | Specifies the value extracted from nzFormatter | `(value: string) => string|number` | - | +| `[nzFormatter]` | Specifies the format of the value presented | `(value: number \| string) => string \| number` | - | +| `[nzParser]` | Specifies the value extracted from nzFormatter | `(value: string) => string \| number` | - | | `[nzPrecision]` | precision of input value | `number` | - | -| `[nzSize]` | width of input box | `'large'|'small'|'default'` | `'default'` | -| `[nzStep]` | The number to which the current value is increased or decreased. It can be an integer or decimal. | `number|string` | `1` | +| `[nzSize]` | width of input box | `'large' \| 'small' \| 'default'` | `'default'` | +| `[nzStep]` | The number to which the current value is increased or decreased. It can be an integer or decimal. | `number \| string` | `1` | | `[nzPlaceHolder]` | Placeholder of select | `string` | - | | `[nzId]` | input id attribute inside the component| `string` | - | | `(ngModelChange)` | The callback triggered when the value is changed | `EventEmitter` | - | diff --git a/components/input-number/doc/index.zh-CN.md b/components/input-number/doc/index.zh-CN.md index 43ac0c0b861..844c66cbeee 100755 --- a/components/input-number/doc/index.zh-CN.md +++ b/components/input-number/doc/index.zh-CN.md @@ -31,16 +31,16 @@ import { NzInputNumberModule } from 'ng-zorro-antd'; | 成员 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[ngModel]` | 当前值,可双向绑定 | `number|string` | `string` | - | +| `[ngModel]` | 当前值,可双向绑定 | `number \| string` \| `string` | - | | `[nzAutoFocus]` | 自动获取焦点 | `boolean` | `false` | | `[nzDisabled]` | 禁用 | `boolean` | `false` | | `[nzMax]` | 最大值 | `number` | `Infinity` | | `[nzMin]` | 最小值 | `number` | `-Infinity` | -| `[nzFormatter]` | 指定输入框展示值的格式 | `(value: number|string) => string|number` | - | -| `[nzParser]` | 指定从 nzFormatter 里转换回数字的方式,和 nzFormatter 搭配使用 | `(value: string) => string|number` | - | +| `[nzFormatter]` | 指定输入框展示值的格式 | `(value: number \| string) => string \| number` | - | +| `[nzParser]` | 指定从 nzFormatter 里转换回数字的方式,和 nzFormatter 搭配使用 | `(value: string) => string \| number` | - | | `[nzPrecision]` | 数值精度 | `number` | - | -| `[nzSize]` | 输入框大小 | `'large'|'small'|'default'` | `'default'` | -| `[nzStep]` | 每次改变步数,可以为小数 | `number|string` | `1` | +| `[nzSize]` | 输入框大小 | `'large' \| 'small' \| 'default'` | `'default'` | +| `[nzStep]` | 每次改变步数,可以为小数 | `number \| string` | `1` | | `[nzPlaceHolder]` | 选择框默认文字 | `string` | - | | `[nzId]` | 组件内部 input 的 id 值 | `string` | - | | `(ngModelChange)` | 数值改变时回调 | `EventEmitter` | - | diff --git a/components/input/doc/index.en-US.md b/components/input/doc/index.en-US.md index 7c8d33e265c..acb273df26d 100755 --- a/components/input/doc/index.en-US.md +++ b/components/input/doc/index.en-US.md @@ -28,17 +28,17 @@ All props of input supported by [w3c standards](https://www.w3schools.com/tags/t | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzSize]` | The size of the input box. Note: in the context of a form, the `large` size is used. | `'large'|'small'|'default'` | `'default'` | -| `[nzAutosize]` | Only used for `textarea`, height autosize feature, can be set to `boolean` or an object `{ minRows: 2, maxRows: 6 }` | `boolean|{ minRows: number, maxRows: number }` | `false` | +| `[nzSize]` | The size of the input box. Note: in the context of a form, the `large` size is used. | `'large' \| 'small' \| 'default'` | `'default'` | +| `[nzAutosize]` | Only used for `textarea`, height autosize feature, can be set to `boolean` or an object `{ minRows: 2, maxRows: 6 }` | `boolean \| { minRows: number, maxRows: number }` | `false` | ### nz-input-group | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzAddOnAfter]` | The label text displayed after (on the right side of) the input field, can work with `nzAddOnBefore` | `string|TemplateRef` | - | -| `[nzAddOnBefore]` | The label text displayed before (on the left side of) the input field, can work with `nzAddOnAfter` | `string|TemplateRef` | - | -| `[nzPrefix]` | The prefix icon for the Input, can work with `nzSuffix` | `string|TemplateRef` | - | -| `[nzSuffix]` | The suffix icon for the Input, can work with `nzPrefix` | `string|TemplateRef` | - | +| `[nzAddOnAfter]` | The label text displayed after (on the right side of) the input field, can work with `nzAddOnBefore` | `string \| TemplateRef` | - | +| `[nzAddOnBefore]` | The label text displayed before (on the left side of) the input field, can work with `nzAddOnAfter` | `string \| TemplateRef` | - | +| `[nzPrefix]` | The prefix icon for the Input, can work with `nzSuffix` | `string \| TemplateRef` | - | +| `[nzSuffix]` | The suffix icon for the Input, can work with `nzPrefix` | `string \| TemplateRef` | - | | `[nzCompact]` | Whether use compact style | `boolean` | `false` | -| `[nzSize]` | The size of `nz-input-group` specifies the size of the included `nz-input` fields | `'large'|'small'|'default'` | `'default'` | +| `[nzSize]` | The size of `nz-input-group` specifies the size of the included `nz-input` fields | `'large' \| 'small' \| 'default'` | `'default'` | diff --git a/components/input/doc/index.zh-CN.md b/components/input/doc/index.zh-CN.md index 0e591931df3..ffeac48984f 100755 --- a/components/input/doc/index.zh-CN.md +++ b/components/input/doc/index.zh-CN.md @@ -28,17 +28,17 @@ nz-input 可以使用所有的W3C标准下的所有 [使用方式](https://www.w | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzSize]` | 控件大小。注:标准表单内的输入框大小限制为 `large` | `'large'|'small'|'default'` | `'default'` | -| `[nzAutosize]` | 只可以用于 `textarea`,自适应内容高度,可设置为 `boolean` 或对象:`{ minRows: 2, maxRows: 6 }` | `boolean|{ minRows: number, maxRows: number }` | `false` | +| `[nzSize]` | 控件大小。注:标准表单内的输入框大小限制为 `large` | `'large' \| 'small' \| 'default'` | `'default'` | +| `[nzAutosize]` | 只可以用于 `textarea`,自适应内容高度,可设置为 `boolean` 或对象:`{ minRows: 2, maxRows: 6 }` | `boolean \| { minRows: number, maxRows: number }` | `false` | ### nz-input-group | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzAddOnAfter]` | 带标签的 input,设置后置标签,可以与 `nzAddOnBefore` 配合使用 | `string|TemplateRef` | - | -| `[nzAddOnBefore]` | 带标签的 input,设置前置标签,可以与 `nzAddOnBefore` 配合使用 | `string|TemplateRef` | - | -| `[nzPrefix]` | 带有前缀图标的 input,可以与 `nzSuffix` 配合使用 | `string|TemplateRef` | - | -| `[nzSuffix]` | 带有后缀图标的 input,可以与 `nzPrefix` 配合使用 | `string|TemplateRef` | - | +| `[nzAddOnAfter]` | 带标签的 input,设置后置标签,可以与 `nzAddOnBefore` 配合使用 | `string \| TemplateRef` | - | +| `[nzAddOnBefore]` | 带标签的 input,设置前置标签,可以与 `nzAddOnBefore` 配合使用 | `string \| TemplateRef` | - | +| `[nzPrefix]` | 带有前缀图标的 input,可以与 `nzSuffix` 配合使用 | `string \| TemplateRef` | - | +| `[nzSuffix]` | 带有后缀图标的 input,可以与 `nzPrefix` 配合使用 | `string \| TemplateRef` | - | | `[nzCompact]` | 是否用紧凑模式 | `boolean` | `false` | | `[nzSearch]` | 是否用搜索框 | `boolean` | `false` | -| `[nzSize]` | `nz-input-group` 中所有的 `nz-input` 的大小 | `'large'|'small'|'default'` | `'default'` | +| `[nzSize]` | `nz-input-group` 中所有的 `nz-input` 的大小 | `'large' \| 'small' \| 'default'` | `'default'` | diff --git a/components/layout/doc/index.en-US.md b/components/layout/doc/index.en-US.md index 91849241129..94d5641c068 100755 --- a/components/layout/doc/index.en-US.md +++ b/components/layout/doc/index.en-US.md @@ -83,16 +83,16 @@ The sidebar. | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzBreakpoint]` | breakpoints of the responsive layout | `'xs'|'sm'|'md'|'lg'|'xl'|'xxl'` | - | +| `[nzBreakpoint]` | breakpoints of the responsive layout | `'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl' \| 'xxl'` | - | | `[nzCollapsed]` | to set the current status | `boolean` | - | | `[nzCollapsedWidth]` | width of the collapsed sidebar, by setting to `0` a special trigger will appear | `number` | `64` | | `[nzCollapsible]` | whether can be collapsed | `boolean` | `false` | | `[nzCollapsed]` | the collapsed status can be double binding | `boolean` | `false` | | `[nzReverseArrow]` | reverse direction of arrow, for a sider that expands from the right | `boolean` | `false` | -| `[nzTrigger]` | specify the customized trigger, set to null to hide the trigger | `string|TemplateRef` | - | +| `[nzTrigger]` | specify the customized trigger, set to null to hide the trigger | `string \| TemplateRef` | - | | `[nzZeroTrigger]` | specify the customized trigger when nzCollapsedWidth setting to `0` | `TemplateRef` | - | -| `[nzWidth]` | width of the sidebar | `number|string` | `200` | -| `[nzTheme]` | color theme of the sidebar | `'light'|'dark'` | `dark` | +| `[nzWidth]` | width of the sidebar | `number \| string` | `200` | +| `[nzTheme]` | color theme of the sidebar | `'light' \| 'dark'` | `dark` | | `(nzCollapsedChange)` | the callback function | `EventEmitter` | - | #### breakpoint width diff --git a/components/layout/doc/index.zh-CN.md b/components/layout/doc/index.zh-CN.md index ab095444cd9..3d69498e643 100755 --- a/components/layout/doc/index.zh-CN.md +++ b/components/layout/doc/index.zh-CN.md @@ -84,7 +84,7 @@ import { NzLayoutModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzBreakpoint]` | 触发响应式布局的断点 | `'xs'|'sm'|'md'|'lg'|'xl'|'xxl'` | - | +| `[nzBreakpoint]` | 触发响应式布局的断点 | `'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl' \| 'xxl'` | - | | `[nzCollapsed]` | 当前收起状态 | `boolean` | - | | `[nzCollapsedWidth]` | 收缩宽度,设置为 0 会出现特殊 trigger | `number` | `64` | | `[nzCollapsible]` | 是否可收起 | `boolean` | `false` | @@ -92,8 +92,8 @@ import { NzLayoutModule } from 'ng-zorro-antd'; | `[nzReverseArrow]` | 翻转折叠提示箭头的方向,当 Sider 在右边时可以使用 | `boolean` | `false` | | `[nzTrigger]` | 自定义 trigger,设置为 null 时隐藏 trigger | `TemplateRef` | - | | `[nzZeroTrigger]` | 自定义 nzCollapsedWidth 为 0 时的 特殊trigger | `TemplateRef` | - | -| `[nzWidth]` | 宽度 | `number|string` | `200` | -| `[nzTheme]` | 主题颜色 | `'light'|'dark'` | `dark` | +| `[nzWidth]` | 宽度 | `number \| string` | `200` | +| `[nzTheme]` | 主题颜色 | `'light' \| 'dark'` | `dark` | | `(nzCollapsedChange)` | 展开-收起时的回调函数 | `EventEmitter` | - | #### breakpoint width diff --git a/components/list/doc/index.en-US.md b/components/list/doc/index.en-US.md index 76c3df2d318..bda85048b80 100644 --- a/components/list/doc/index.en-US.md +++ b/components/list/doc/index.en-US.md @@ -28,15 +28,15 @@ import { NzListModule } from 'ng-zorro-antd'; | `[nzDataSource]` | Data source for list | `any[]` | - | | `[nzRenderItem]` | Custom item renderer | `TemplateRef` | - | | `[nzBordered]` | Toggles rendering of the border around the list | `boolean` | `false` | -| `[nzFooter]` | List footer renderer | `string|TemplateRef` | - | +| `[nzFooter]` | List footer renderer | `string \| TemplateRef` | - | | `[nzGrid]` | The grid type of list. You can set grid to something like `{gutter: 16, column: 4}` | `object` | - | -| `[nzHeader]` | List header renderer | `string|TemplateRef` | - | -| `[nzItemLayout]` | The layout of list, default is `horizontal`, If a vertical list is desired, set the itemLayout property to `vertical` | `'vertical'|'horizontal'` | `'horizontal'` | +| `[nzHeader]` | List header renderer | `string \| TemplateRef` | - | +| `[nzItemLayout]` | The layout of list, default is `horizontal`, If a vertical list is desired, set the itemLayout property to `vertical` | `'vertical' \| 'horizontal'` | `'horizontal'` | | `[nzLoading]` | Shows a loading indicator while the contents of the list are being fetched | `boolean` | `false` | | `[nzLoadMore]` | Shows a load more content | `TemplateRef` | - | -| `[nzNoResult]` | Specify content to show when list is empty | `string` | `TemplateRef` | - | +| `[nzNoResult]` | Specify content to show when list is empty | `string` \| `TemplateRef` | - | | `[nzPagination]` | Shows a pagination content | `TemplateRef` | - | -| `[nzSize]` | Size of list | `'large'|'small'|'default'` | `'default'` | +| `[nzSize]` | Size of list | `'large' \| 'small' \| 'default'` | `'default'` | | `[nzSplit]` | Toggles rendering of the split under the list item | `boolean` | `true` | #### nzGrid @@ -56,7 +56,7 @@ import { NzListModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | --- | --- | --- | --- | -| `[nzContent]` | content renderer | `string|TemplateRef` | - | +| `[nzContent]` | content renderer | `string \| TemplateRef` | - | | `[nzActions]` | The actions content of list item. If `itemLayout` is `vertical`, shows the content on bottom, otherwise shows content on the far right. | `Array>` | - | | `[nzExtra]` | The extra content of list item. If `itemLayout` is `vertical`, shows the content on right, otherwise shows content on the far right. | `TemplateRef` | - | | `[nzNoFlex]` | Whether it's not `flex` layout rendering | `boolean` | `false` | @@ -65,6 +65,6 @@ import { NzListModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | --- | --- | --- | --- | -| `[nzAvatar]` | The avatar of list item | `string|TemplateRef` | - | -| `[nzDescription]` | The description of list item | `string|TemplateRef` | - | -| `[nzTitle]` | The title of list item | `string|TemplateRef` | - | +| `[nzAvatar]` | The avatar of list item | `string \| TemplateRef` | - | +| `[nzDescription]` | The description of list item | `string \| TemplateRef` | - | +| `[nzTitle]` | The title of list item | `string \| TemplateRef` | - | diff --git a/components/list/doc/index.zh-CN.md b/components/list/doc/index.zh-CN.md index e6b23e3e3f5..399c2e19101 100644 --- a/components/list/doc/index.zh-CN.md +++ b/components/list/doc/index.zh-CN.md @@ -29,15 +29,15 @@ import { NzListModule } from 'ng-zorro-antd'; | `[nzDataSource]` | 列表数据源 | `any[]` | - | | `[nzRenderItem]` | 自定义列表项 | `TemplateRef` | - | | `[nzBordered]` | 是否展示边框 | `boolean` | `false` | -| `[nzFooter]` | 列表底部 | `string|TemplateRef` | - | +| `[nzFooter]` | 列表底部 | `string \| TemplateRef` | - | | `[nzGrid]` | 列表栅格配置 | `object` | - | -| `[nzHeader]` | 列表头部 | `string|TemplateRef` | - | -| `[nzItemLayout]` | 设置 `nz-list-item` 布局, 设置成 `vertical` 则竖直样式显示, 默认横排 | `'vertical'|'horizontal'` | `'horizontal'` | +| `[nzHeader]` | 列表头部 | `string \| TemplateRef` | - | +| `[nzItemLayout]` | 设置 `nz-list-item` 布局, 设置成 `vertical` 则竖直样式显示, 默认横排 | `'vertical' \| 'horizontal'` | `'horizontal'` | | `[nzLoading]` | 当卡片内容还在加载中时,可以用 `loading` 展示一个占位 | `boolean` | `false` | | `[nzLoadMore]` | 加载更多 | `TemplateRef` | - | -| `[nzNoResult]` | 当列表为空时加载的内容 | `string` | `TemplateRef` | - | +| `[nzNoResult]` | 当列表为空时加载的内容 | `string` \| `TemplateRef` | - | | `[nzPagination]` | 对应的 `pagination` 配置 | `TemplateRef` | - | -| `[nzSize]` | list 的尺寸 | `'large'|'small'|'default'` | `'default'` | +| `[nzSize]` | list 的尺寸 | `'large' \| 'small' \| 'default'` | `'default'` | | `[nzSplit]` | 是否展示分割线 | `boolean` | `true` | #### nzGrid @@ -57,7 +57,7 @@ import { NzListModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzContent]` | 内容项 | `string|TemplateRef` | - | +| `[nzContent]` | 内容项 | `string \| TemplateRef` | - | | `[nzActions]` | 列表操作组,根据 `nzItemLayout` 的不同, 位置在卡片底部或者最右侧。 | `Array>` | - | | `[nzExtra]` | 额外内容, 通常用在 `nzItemLayout` 为 `vertical` 的情况下, 展示右侧内容; `horizontal` 展示在列表元素最右侧 | `TemplateRef` | - | | `[nzNoFlex]` | 是否非 `flex` 布局渲染 | `boolean` | `false` | @@ -66,6 +66,6 @@ import { NzListModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzAvatar]` | 列表元素的图标 | `string|TemplateRef` | - | -| `[nzDescription]` | 列表元素的描述内容 | `string|TemplateRef` | - | -| `[nzTitle]` | 列表元素的标题 | `string|TemplateRef` | - | +| `[nzAvatar]` | 列表元素的图标 | `string \| TemplateRef` | - | +| `[nzDescription]` | 列表元素的描述内容 | `string \| TemplateRef` | - | +| `[nzTitle]` | 列表元素的标题 | `string \| TemplateRef` | - | diff --git a/components/mention/doc/index.en-US.md b/components/mention/doc/index.en-US.md index 61eb3f3d506..bdc156944f0 100644 --- a/components/mention/doc/index.en-US.md +++ b/components/mention/doc/index.en-US.md @@ -34,14 +34,14 @@ import { NzMentionModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | --- | --- | --- | --- | -| `[nzMentionTrigger]` | Trigger element **(required)** | `HTMLTextAreaElement|HTMLInputElement` | - | +| `[nzMentionTrigger]` | Trigger element **(required)** | `HTMLTextAreaElement \| HTMLInputElement` | - | | `[nzMentionSuggestion]` | Customize the suggestion template | `TemplateRef` | - | | `[nzLoading]` | Loading mode | `boolean` | `false` | | `[nzNotFoundContent]` | Suggestion when suggestions empty | `string` | `'无匹配结果,轻敲空格完成输入'` | -| `[nzPlacement]` | The position of the suggestion relative to the target, which can be one of top and bottom | `'button'|'top'` | `'bottom'` | -| `[nzPrefix]` | Character which will trigger Mention to show mention list | `string|string[]` | `'@'` | +| `[nzPlacement]` | The position of the suggestion relative to the target, which can be one of top and bottom | `'button' \| 'top'` | `'bottom'` | +| `[nzPrefix]` | Character which will trigger Mention to show mention list | `string \| string[]` | `'@'` | | `[nzSuggestions]` | Suggestion content | `any[]` | `[]` | -| `[nzValueWith]` | Function that maps an suggestion's value | `(any) => string|(value: string) => string` | +| `[nzValueWith]` | Function that maps an suggestion's value | `(any) => string \| (value: string) => string` | | `(nzOnSelect)` | Callback function called when select from suggestions | `EventEmitter` | - | | `(onSearchChange)` | Callback function called when search content changes| `EventEmitter` | - | diff --git a/components/mention/doc/index.zh-CN.md b/components/mention/doc/index.zh-CN.md index e48cdc23f0e..27f861b260c 100644 --- a/components/mention/doc/index.zh-CN.md +++ b/components/mention/doc/index.zh-CN.md @@ -35,14 +35,14 @@ import { NzMentionModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzMentionTrigger]` | 用于指定提及的触发元素 **(必须)** | `HTMLTextAreaElement|HTMLInputElement` | - | +| `[nzMentionTrigger]` | 用于指定提及的触发元素 **(必须)** | `HTMLTextAreaElement \| HTMLInputElement` | - | | `[nzMentionSuggestion]` | 自定义建议渲染模板 | `TemplateRef` | - | | `[nzLoading]` | 加载中 | `boolean` | `false` | | `[nzNotFoundContent]` | 未找到时的内容 | `string` | `'无匹配结果,轻敲空格完成输入'` | -| `[nzPlacement]` | 建议框位置 | `'button'|'top'` | `'bottom'` | -| `[nzPrefix]` | 触发弹出下拉框的字符 | `string|string[]` | `'@'` | +| `[nzPlacement]` | 建议框位置 | `'button' \| 'top'` | `'bottom'` | +| `[nzPrefix]` | 触发弹出下拉框的字符 | `string \| string[]` | `'@'` | | `[nzSuggestions]` | 建议内容 | `any[]` | `[]` | -| `[nzValueWith]` | 建议选项的取值方法 | `(any) => string|(value: string) => string` | +| `[nzValueWith]` | 建议选项的取值方法 | `(any) => string \| (value: string) => string` | | `(nzOnSelect)` | 下拉框选择建议时回调 | `EventEmitter` | - | | `(onSearchChange)` | 输入框中 @ 变化时回调 | `EventEmitter` | - | diff --git a/components/menu/doc/index.en-US.md b/components/menu/doc/index.en-US.md index 3d19b573cfd..e8ef99ed1cc 100755 --- a/components/menu/doc/index.en-US.md +++ b/components/menu/doc/index.en-US.md @@ -43,9 +43,9 @@ import { NzMenuModule } from 'ng-zorro-antd'; | ----- | ----------- | ---- | ------------- | | `[nzInlineCollapsed]` | specifies the collapsed status when menu is inline mode | `boolean` | - | | `[nzInlineIndent]` | indent px of inline menu item on each level | `number` | `24` | -| `[nzMode]` | type of the menu; `vertical`, `horizontal`, and `inline` modes are supported | `'vertical'|'horizontal'|'inline'` | `'vertical'` | +| `[nzMode]` | type of the menu; `vertical`, `horizontal`, and `inline` modes are supported | `'vertical' \| 'horizontal' \| 'inline'` | `'vertical'` | | `[nzSelectable]` | allow selecting menu items | `boolean` | `true` | -| `[nzTheme]` | color theme of the menu | `'light'|'dark'` | `'light'` | +| `[nzTheme]` | color theme of the menu | `'light' \| 'dark'` | `'light'` | | `(nzClick)` | the Output when click nz-menu-item inside nz-menu | `EventEmitter` | | ### [nz-menu-item] @@ -74,7 +74,7 @@ You can set the title of `[nz-submenu]` in the following ways. | ----- | ----------- | ---- | ------------- | | `[nzOpen]` | whether sub menu is open or not, double binding | `boolean` | `false` | | `[nzDisabled]` | whether sub menu is disabled or not | `boolean` | `false` | -| `[nzTitle]` | set submenu title | `string|TemplateRef` | - | +| `[nzTitle]` | set submenu title | `string \| TemplateRef` | - | | `[nzIcon]` | icon type in title | `string` | - | | `[nzMenuClassName]` | Custom the submenu container's class name | `string` | - | | `(nzOpenChange)` | nzOpen callback | `EventEmitter` | - | @@ -94,7 +94,7 @@ You can set the title of `[nz-menu-group]` in the following ways. | Param | Description | Type | Default value | | ----- | ----------- | ---- | ------------- | -| `[nzTitle]` | set menu group title | `string|TemplateRef` | - | +| `[nzTitle]` | set menu group title | `string \| TemplateRef` | - | ### [nz-menu-divider] diff --git a/components/menu/doc/index.zh-CN.md b/components/menu/doc/index.zh-CN.md index 4edcdfa001a..1c36e8444a2 100755 --- a/components/menu/doc/index.zh-CN.md +++ b/components/menu/doc/index.zh-CN.md @@ -44,9 +44,9 @@ import { NzMenuModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[nzInlineCollapsed]` | inline 时菜单是否收起状态 | `boolean` | - | | `[nzInlineIndent]` | inline 模式的菜单缩进宽度 | `number` | `24` | -| `[nzMode]` | 菜单类型,现在支持垂直、水平、和内嵌模式三种 | `'vertical'|'horizontal'|'inline'` | `'vertical'` | +| `[nzMode]` | 菜单类型,现在支持垂直、水平、和内嵌模式三种 | `'vertical' \| 'horizontal' \| 'inline'` | `'vertical'` | | `[nzSelectable]` | 是否允许选中 | `boolean` | `true` | -| `[nzTheme]` | 主题颜色 | `'light'|'dark'` | `'light'` | +| `[nzTheme]` | 主题颜色 | `'light' \| 'dark'` | `'light'` | | `(nzClick)` | 点击 nz-menu-item 输出属性 | `EventEmitter` | | ### [nz-menu-item] @@ -75,7 +75,7 @@ import { NzMenuModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[nzOpen]` | 是否展开,可双向绑定 | `boolean` | `false` | | `[nzDisabled]` | 是否禁用 | `boolean` | `false` | -| `[nzTitle]` | 标题内容 | `string|TemplateRef` | - | +| `[nzTitle]` | 标题内容 | `string \| TemplateRef` | - | | `[nzIcon]` | 标题中 icon 类型 | `string` | - | | `[nzMenuClassName]` | 自定义子菜单容器类名 | `string` | - | | `(nzOpenChange)` | 展开回调 | `EventEmitter` | - | @@ -95,7 +95,7 @@ import { NzMenuModule } from 'ng-zorro-antd'; ``` | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzTitle]` | 标题内容 | `string|TemplateRef` | - | +| `[nzTitle]` | 标题内容 | `string \| TemplateRef` | - | ### [nz-menu-divider] diff --git a/components/message/doc/index.en-US.md b/components/message/doc/index.en-US.md index fdbaaa2fb09..2a7ef878d7d 100644 --- a/components/message/doc/index.en-US.md +++ b/components/message/doc/index.en-US.md @@ -49,7 +49,7 @@ This components provides some service methods, with usage and arguments as follo | Argument | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| content | The content of message | `string|TemplateRef` | - | +| content | The content of message | `string \| TemplateRef` | - | | options | Support setting the parameters for the current message box, see the table below | `object` | - | The parameters that are set by the `options` support are as follows: @@ -72,7 +72,7 @@ Methods for destruction are also provided: | nzMaxStack | The maximum number of messages that can be displayed at the same time | `number` | `8` | | nzPauseOnHover | Do not remove automatically when mouse is over while setting to `true` | `boolean` | `true` | | nzAnimate | Whether to turn on animation | `boolean` | `true` | -| nzTop | Distance from top | `number|string` | `24` | +| nzTop | Distance from top | `number \| string` | `24` | ### NzMessageDataFilled diff --git a/components/message/doc/index.zh-CN.md b/components/message/doc/index.zh-CN.md index 4ca67285670..d65255b45c8 100644 --- a/components/message/doc/index.zh-CN.md +++ b/components/message/doc/index.zh-CN.md @@ -50,7 +50,7 @@ import { NzMessageModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| content | 提示内容 | `string|TemplateRef` | - | +| content | 提示内容 | `string \| TemplateRef` | - | | options | 支持设置针对当前提示框的参数,见下方表格 | `object` | - | `options` 支持设置的参数如下: @@ -73,7 +73,7 @@ import { NzMessageModule } from 'ng-zorro-antd'; | nzMaxStack | 同一时间可展示的最大提示数量 | `number` | `8` | | nzPauseOnHover | 鼠标移上时禁止自动移除 | `boolean` | `true` | | nzAnimate | 开关动画效果 | `boolean` | `true` | -| nzTop | 消息距离顶部的位置 | `number|string` | `24` | +| nzTop | 消息距离顶部的位置 | `number \| string` | `24` | ### NzMessageDataFilled diff --git a/components/page-header/doc/index.en-US.md b/components/page-header/doc/index.en-US.md index e6188a6e476..c6d13e50405 100644 --- a/components/page-header/doc/index.en-US.md +++ b/components/page-header/doc/index.en-US.md @@ -28,9 +28,9 @@ import { NzPageHeaderModule } from 'ng-zorro-antd'; ### nz-page-header | Param | Description | Type | Default value | | ----- | ----------- | ---- | ------------- | -| `[nzTitle]` | title string | `string|TemplateRef` | - | -| `[nzSubtitle]` | subTitle string | `string|TemplateRef` | - | -| `[nzBackIcon]` | custom back icon | `string|TemplateRef` | - | +| `[nzTitle]` | title string | `string \| TemplateRef` | - | +| `[nzSubtitle]` | subTitle string | `string \| TemplateRef` | - | +| `[nzBackIcon]` | custom back icon | `string \| TemplateRef` | - | | `(nzBack)` | back icon click event | `EventEmitter` | - | ### Page header sections diff --git a/components/page-header/doc/index.zh-CN.md b/components/page-header/doc/index.zh-CN.md index 08f6bde9696..54967493cc5 100644 --- a/components/page-header/doc/index.zh-CN.md +++ b/components/page-header/doc/index.zh-CN.md @@ -29,9 +29,9 @@ import { NzPageHeaderModule } from 'ng-zorro-antd'; ### nz-page-header | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzTitle]` | title 文字 | `string|TemplateRef` | - | -| `[nzSubtitle]` | subTitle 文字 | `string|TemplateRef` | - | -| `[nzBackIcon]` | 自定义 back icon | `string|TemplateRef` | - | +| `[nzTitle]` | title 文字 | `string \| TemplateRef` | - | +| `[nzSubtitle]` | subTitle 文字 | `string \| TemplateRef` | - | +| `[nzBackIcon]` | 自定义 back icon | `string \| TemplateRef` | - | | `[nzBack]` | 返回按钮的点击事件 | `EventEmitter` | - | ### Page header 组成部分 diff --git a/components/pagination/doc/index.en-US.md b/components/pagination/doc/index.en-US.md index bd4b24ec9d7..88ea29e6266 100755 --- a/components/pagination/doc/index.en-US.md +++ b/components/pagination/doc/index.en-US.md @@ -39,7 +39,7 @@ import { NzPaginationModule } from 'ng-zorro-antd'; | `[nzSimple]` | whether to use simple mode | `boolean` | - | | `[nzSize]` | specify the size of `nz-pagination`, can be set to `small` | `'small'` | `'default'` | | `[nzPageSizeOptions]` | specify the sizeChanger options | `number[]` | `[10, 20, 30, 40]` | -| `[nzItemRender]` | to customize item | `TemplateRef<{ $implicit: 'page'|'prev'|'next', page: number }>` | - | +| `[nzItemRender]` | to customize item | `TemplateRef<{ $implicit: 'page' \| 'prev' \| 'next', page: number }>` | - | | `[nzShowTotal]` | to display the total number and range | `TemplateRef<{ $implicit: number, range: [ number, number ] }>` | - | | `[nzHideOnSinglePage]` | Whether to hide pager on single page | `boolean` | `false` | | `(nzPageIndexChange)` | current page number change callback | `EventEmitter` | - | diff --git a/components/pagination/doc/index.zh-CN.md b/components/pagination/doc/index.zh-CN.md index 264baf6b483..254d2aaef86 100755 --- a/components/pagination/doc/index.zh-CN.md +++ b/components/pagination/doc/index.zh-CN.md @@ -40,7 +40,7 @@ import { NzPaginationModule } from 'ng-zorro-antd'; | `[nzSimple]` | 当添加该属性时,显示为简单分页 | `boolean` | - | | `[nzSize]` | 当为「small」时,是小尺寸分页 | `'small'` | `'default'` | | `[nzPageSizeOptions]` | 指定每页可以显示多少条 | `number[]` | `[10, 20, 30, 40]` | -| `[nzItemRender]` | 用于自定义页码的结构 | `TemplateRef<{ $implicit: 'page'|'prev'|'next', page: number }>` | - | +| `[nzItemRender]` | 用于自定义页码的结构 | `TemplateRef<{ $implicit: 'page' \| 'prev' \| 'next', page: number }>` | - | | `[nzShowTotal]` | 用于显示数据总量和当前数据范围,具体使用方式见代码演示部分 | `TemplateRef<{ $implicit: number, range: [ number, number ] }>` | - | | `[nzHideOnSinglePage]` | 只有一页时是否隐藏分页器 | `boolean` | `false` | | `(nzPageIndexChange)` | 页码改变的回调 | `EventEmitter` | - | diff --git a/components/popconfirm/doc/index.en-US.md b/components/popconfirm/doc/index.en-US.md index 2c7f8afccdb..b239d8445df 100644 --- a/components/popconfirm/doc/index.en-US.md +++ b/components/popconfirm/doc/index.en-US.md @@ -28,10 +28,10 @@ import { NzPopconfirmModule } from 'ng-zorro-antd'; | ----- | ----------- | ---- | ------------- | | `[nzCancelText]` | Text of the Cancel button | `string` | `'Cancel'` | | `[nzOkText]` | Text of the Confirm button | `string` | `'Confirm'` | -| `[nzOkType]` | Button `type` of the Confirm button | `'primary'|'ghost'|'dashed'|'danger'|'default'` | `'primary'` | -| `[nzTitle]` | Title of the confirmation box | `string|TemplateRef` | - | +| `[nzOkType]` | Button `type` of the Confirm button | `'primary' \| 'ghost' \| 'dashed' \| 'danger' \| 'default'` | `'primary'` | +| `[nzTitle]` | Title of the confirmation box | `string \| TemplateRef` | - | | `[nzCondition]` | Whether to directly emit `onConfirm` without showing Popconfirm | `boolean` | `false` | -| `[nzIcon]` | Customize icon of confirmation | `string|TemplateRef` | - | +| `[nzIcon]` | Customize icon of confirmation | `string \| TemplateRef` | - | | `(nzOnCancel)` | Callback of cancel | `EventEmitter` | - | | `(nzOnConfirm)` | Callback of confirmation | `EventEmitter` | - | diff --git a/components/popconfirm/doc/index.zh-CN.md b/components/popconfirm/doc/index.zh-CN.md index 4d3f5ce3f85..7c40afdfb9d 100644 --- a/components/popconfirm/doc/index.zh-CN.md +++ b/components/popconfirm/doc/index.zh-CN.md @@ -29,10 +29,10 @@ import { NzPopconfirmModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[nzCancelText]` | 取消按钮文字 | `string` | `'取消'` | | `[nzOkText]` | 确认按钮文字 | `string` | `'确定'` | -| `[nzOkType]` | 确认按钮类型 | `'primary'|'ghost'|'dashed'|'danger'|'default'` | `'primary'` | -| `[nzTitle]` | 确认框的描述 | `string|TemplateRef` | - | +| `[nzOkType]` | 确认按钮类型 | `'primary' \| 'ghost' \| 'dashed' \| 'danger' \| 'default'` | `'primary'` | +| `[nzTitle]` | 确认框的描述 | `string \| TemplateRef` | - | | `[nzCondition]` | 是否直接触发 `nzOnConfirm` 而不弹出框 | `boolean` | `false` | -| `[nzIcon]` | 自定义弹出框的 icon | `string|TemplateRef` | - | +| `[nzIcon]` | 自定义弹出框的 icon | `string \| TemplateRef` | - | | `(nzOnCancel)` | 点击取消的回调 | `EventEmitter` | - | | `(nzOnConfirm)` | 点击确认的回调 | `EventEmitter` | - | diff --git a/components/popover/doc/index.en-US.md b/components/popover/doc/index.en-US.md index 8a74eb561c3..24c740dee95 100644 --- a/components/popover/doc/index.en-US.md +++ b/components/popover/doc/index.en-US.md @@ -26,8 +26,8 @@ import { NzPopoverModule } from 'ng-zorro-antd'; | Param | Description | Type | Default value | | ----- | ----------- | ---- | ------------- | -| nzTitle | Title of the card | `string|TemplateRef` | - | -| nzTemplate | Used to define the content | `string|TemplateRef` | - | +| nzTitle | Title of the card | `string \| TemplateRef` | - | +| nzTemplate | Used to define the content | `string \| TemplateRef` | - | Consult [Tooltip's documentation](/components/tooltip/en#api) to find more APIs. diff --git a/components/popover/doc/index.zh-CN.md b/components/popover/doc/index.zh-CN.md index 2b1a61de9e1..d14a1c93159 100644 --- a/components/popover/doc/index.zh-CN.md +++ b/components/popover/doc/index.zh-CN.md @@ -27,8 +27,8 @@ import { NzPopoverModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzTitle]` | 卡片标题 | `string|TemplateRef` | - | -| `[nzContent]` | 用于定义Content内容 | `string|TemplateRef` | - | +| `[nzTitle]` | 卡片标题 | `string \| TemplateRef` | - | +| `[nzContent]` | 用于定义Content内容 | `string \| TemplateRef` | - | 更多属性请参考 [Tooltip](/components/tooltip/zh#api)。 diff --git a/components/progress/doc/index.en-US.md b/components/progress/doc/index.en-US.md index ebe579fc0b7..8675a0e43db 100644 --- a/components/progress/doc/index.en-US.md +++ b/components/progress/doc/index.en-US.md @@ -29,13 +29,13 @@ import { NzProgressModule } from 'ng-zorro-antd'; | -------- | ----------- | ---- | ------- | | `[nzFormat]` | template function of the content | `(percent: number) => string` | `percent => percent + '%'` | | `[nzGapDegree]` `(nzType=circle)` | the gap degree of half circle, 0 ~ 360 | `number` | `0` | -| `[nzGapPosition]` `(nzType=circle)` | the gap position | `'top'|'right'|'bottom'|'left'` | `'top'` | +| `[nzGapPosition]` `(nzType=circle)` | the gap position | `'top' \| 'right' \| 'bottom' \| 'left'` | `'top'` | | `[nzPercent]` | to set the completion percentage | `number` | `0` | | `[nzShowInfo]` | whether to display the progress value and the status icon | `boolean` | `true` | -| `[nzStatus]` | to set the status of the Progress | `'success'|'exception'|'active'|'normal'` | - | +| `[nzStatus]` | to set the status of the Progress | `'success' \| 'exception' \| 'active' \| 'normal'` | - | | `[nzStrokeWidth]` `(nzType=line)` | to set the width of the progress bar, unit: `px` | `number` | `8` | | `[nzStrokeWidth]` `(nzType=circle)` | to set the width of the circular progress bar, unit: percentage of the canvas width | `number` | `6` | -| `[nzType]` | to set the type | `'line'|'circle'|'dashboard'` | `'line'` | +| `[nzType]` | to set the type | `'line' \| 'circle' \| 'dashboard'` | `'line'` | | `[nzWidth]` `(nzType=circle)` | to set the canvas width of the circular progress bar, unit: `px` | `number` | `132` | -| `[nzStrokeLinecap]` | to set the style of the progress linecap | `'round'|'square'` | `'round'` | +| `[nzStrokeLinecap]` | to set the style of the progress linecap | `'round' \| 'square'` | `'round'` | | `[nzStrokeColor]` | color of progress bar | `string` | - | \ No newline at end of file diff --git a/components/progress/doc/index.zh-CN.md b/components/progress/doc/index.zh-CN.md index f492bdc3f6b..3dcae72ce3c 100644 --- a/components/progress/doc/index.zh-CN.md +++ b/components/progress/doc/index.zh-CN.md @@ -30,13 +30,13 @@ import { NzProgressModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[nzFormat]` | 内容的模板函数 | `(percent: number) => string` | `percent => percent + '%'` | | `[nzGapDegree]` `(nzType=circle)` | 圆形进度条缺口角度,可取值 0 ~ 360 | `number` | `0` | -| `[nzGapPosition]` `(nzType=circle)` | 圆形进度条缺口位置 | `'top'|'right'|'bottom'|'left'` | `'top'` | +| `[nzGapPosition]` `(nzType=circle)` | 圆形进度条缺口位置 | `'top' \| 'right' \| 'bottom' \| 'left'` | `'top'` | | `[nzPercent]` | 百分比 | `number` | `0` | | `[nzShowInfo]` | 是否显示进度数值或状态图标 | `boolean` | `true` | -| `[nzStatus]` | 状态 | `'success'|'exception'|'active'|'normal'` | - | +| `[nzStatus]` | 状态 | `'success' \| 'exception' \| 'active' \| 'normal'` | - | | `[nzStrokeWidth]` `(nzType=line)` | 进度条线的宽度,单位 px | `number` | `8` | | `[nzStrokeWidth]` `(nzType=circle)` | 圆形进度条线的宽度,单位是进度条画布宽度的百分比 | `number` | `6` | -| `[nzType]` | 类型 | `'line'|'circle'|'dashboard'` | `'line'` | +| `[nzType]` | 类型 | `'line' \| 'circle' \| 'dashboard'` | `'line'` | | `[nzWidth]` `(nzType=circle)` | 圆形进度条画布宽度,单位 px | `number` | `132` | -| `[nzStrokeLinecap]` | 进度条端点形状 | `'round'|'square'` | `'round'` | +| `[nzStrokeLinecap]` | 进度条端点形状 | `'round' \| 'square'` | `'round'` | | `[nzStrokeColor]` | 进度条颜色 | `string` | - | \ No newline at end of file diff --git a/components/radio/doc/index.en-US.md b/components/radio/doc/index.en-US.md index 5cc198dbf76..5291f7f9e6e 100644 --- a/components/radio/doc/index.en-US.md +++ b/components/radio/doc/index.en-US.md @@ -40,9 +40,9 @@ radio group,wrap a group of `nz-radio`。 | `[ngModel]` | current selected `nz-radio` value, double binding | `string` | - | | `[nzName]` | The `name` property of all `input[type="radio"]` children | `string` | - | | `[nzDisabled]` | Disable all radio buttons | `boolean` | `false` | -| `[nzSize]` | Size, only on radio style | `'large'|'small'|'default'` | `'default'` | +| `[nzSize]` | Size, only on radio style | `'large' \| 'small' \| 'default'` | `'default'` | | `(ngModelChange)` | the callback function when current selected `nz-radio` value change | `EventEmitter` | - | -| `[nzButtonStyle]` | style type of radio button | `'outline'|'solid'` | `'outline'` | +| `[nzButtonStyle]` | style type of radio button | `'outline' \| 'solid'` | `'outline'` | ## Methods diff --git a/components/radio/doc/index.zh-CN.md b/components/radio/doc/index.zh-CN.md index 0430d99fdfc..c27430e5297 100644 --- a/components/radio/doc/index.zh-CN.md +++ b/components/radio/doc/index.zh-CN.md @@ -42,9 +42,9 @@ import { NzRadioModule } from 'ng-zorro-antd'; | `[ngModel]` | 指定选中的 `nz-radio` 的 value 值 | `string` | - | | `[nzName]` | `nz-radio-group` 下所有 `input[type="radio"]` 的 `name` 属性 | `string` | - | | `[nzDisabled]` | 设定所有 `nz-radio` disable 状态 | `boolean` | `false` | -| `[nzSize]` | 大小,只对按钮样式生效 | `'large'|'small'|'default'` | `'default'` | +| `[nzSize]` | 大小,只对按钮样式生效 | `'large' \| 'small' \| 'default'` | `'default'` | | `(ngModelChange)` | 选中变化时回调 | `EventEmitter` | - | -| `[nzButtonStyle]` | RadioButton 的风格样式,目前有描边和填色两种风格 | `'outline'|'solid'` | `'outline'` | +| `[nzButtonStyle]` | RadioButton 的风格样式,目前有描边和填色两种风格 | `'outline' \| 'solid'` | `'outline'` | ## 方法 diff --git a/components/select/doc/index.en-US.md b/components/select/doc/index.en-US.md index 31f438f3d6a..46abd5edb3e 100644 --- a/components/select/doc/index.en-US.md +++ b/components/select/doc/index.en-US.md @@ -31,7 +31,7 @@ import { NzSelectModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[ngModel]` | Current selected nz-option value, double binding. | `any|any[]` | - | +| `[ngModel]` | Current selected nz-option value, double binding. | `any \| any[]` | - | | `[compareWith]` | Same as [SelectControlValueAccessor](https://angular.io/api/forms/SelectControlValueAccessor#caveat-option-selection) | `(o1: any, o2: any) => boolean` | `(o1: any, o2: any) => o1===o2` | | `[nzAutoClearSearchValue]` | Whether the current search will be cleared on selecting an item. Only applies when `mode` is set to `multiple` or `tags`. | `boolean` | `true` | | `[nzAllowClear]` | Show clear button. | `boolean` | `false` | @@ -44,12 +44,12 @@ import { NzSelectModule } from 'ng-zorro-antd'; | `[nzServerSearch]` | nz-option will not be filtered when set to true | `boolean` | `false` | | `[nzFilterOption]` | Filter options against it. The function will receive two arguments, `inputValue` and `option`, if the function returns `true`, the option will be included in the filtered set; Otherwise, it will be excluded. | `(input?: string, option?: NzOptionComponent) => boolean;` | - | | `[nzMaxMultipleCount]` | Max selected option can be selected | `number` | `Infinity` | -| `[nzMode]` | Set mode of Select | `'multiple'|'tags'|'default'` | `'default'` | -| `[nzNotFoundContent]` | Specify content to show when no result matches.. | `string | TemplateRef` | `'Not Found'` | +| `[nzMode]` | Set mode of Select | `'multiple' \| 'tags' \| 'default'` | `'default'` | +| `[nzNotFoundContent]` | Specify content to show when no result matches.. | `string \| TemplateRef` | `'Not Found'` | | `[nzPlaceHolder]` | Placeholder of select | `string` | - | | `[nzShowArrow]` | Whether to show the drop-down arrow | `boolean` | `true` | | `[nzShowSearch]` | Whether show search input in single mode. | `boolean` | `false` | -| `[nzSize]` | Size of Select input | `'large'|'small'|'default'` | `'default'` | +| `[nzSize]` | Size of Select input | `'large' \| 'small' \| 'default'` | `'default'` | | `[nzSuffixIcon]` | The custom suffix icon | `TemplateRef` | - | | `[nzRemoveIcon]` | The custom remove icon | `TemplateRef` | - | | `[nzClearIcon]` | The custom clear icon | `TemplateRef` | - | @@ -78,7 +78,7 @@ import { NzSelectModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzLabel]` | Group label | `string|TemplateRef` | - | +| `[nzLabel]` | Group label | `string \| TemplateRef` | - | ## Methods diff --git a/components/select/doc/index.zh-CN.md b/components/select/doc/index.zh-CN.md index dd41e64ae77..2d891d157e6 100644 --- a/components/select/doc/index.zh-CN.md +++ b/components/select/doc/index.zh-CN.md @@ -32,7 +32,7 @@ import { NzSelectModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[ngModel]` | 当前选中的 nz-option 的 nzValue 值,可双向绑定,当 `nzMode` 为 `multiple` 或 `tags` 时,ngModel 为数组 | `any|any[]` | - | +| `[ngModel]` | 当前选中的 nz-option 的 nzValue 值,可双向绑定,当 `nzMode` 为 `multiple` 或 `tags` 时,ngModel 为数组 | `any \| any[]` | - | | `[compareWith]` | 与 [SelectControlValueAccessor](https://angular.io/api/forms/SelectControlValueAccessor#caveat-option-selection) 相同 | `(o1: any, o2: any) => boolean` | `(o1: any, o2: any) => o1===o2` | | `[nzAutoClearSearchValue]` | 是否在选中项后清空搜索框,只在 `mode` 为 `multiple` 或 `tags` 时有效。 | boolean | `true` | | `[nzAllowClear]` | 支持清除 | `boolean` | `false` | @@ -45,12 +45,12 @@ import { NzSelectModule } from 'ng-zorro-antd'; | `[nzServerSearch]` | 是否使用服务端搜索,当为 true 时,将不再在前端对 nz-option 进行过滤 | `boolean` | `false` | | `[nzFilterOption]` | 是否根据输入项进行筛选。当其为一个函数时,会接收 `inputValue` `option` 两个参数,当 `option` 符合筛选条件时,应返回 `true`,反之则返回 `false`。 | `(input?: string, option?: NzOptionComponent) => boolean;` | - | | `[nzMaxMultipleCount]` | 最多选中多少个标签| `number` | `Infinity` | -| `[nzMode]` | 设置 nz-select 的模式 | `'multiple'|'tags'|'default'` | `'default'` | +| `[nzMode]` | 设置 nz-select 的模式 | `'multiple' \| 'tags' \| 'default'` | `'default'` | | `[nzNotFoundContent]` | 当下拉列表为空时显示的内容 | `string \| TemplateRef` | - | | `[nzPlaceHolder]` | 选择框默认文字 | `string` | - | | `[nzShowArrow]` | 是否显示下拉小箭头 | `boolean` | `true` | | `[nzShowSearch]` | 使单选模式可搜索 | `boolean` | `false` | -| `[nzSize]` | 选择框大小 | `'large'|'small'|'default'` | `'default'` | +| `[nzSize]` | 选择框大小 | `'large' \| 'small' \| 'default'` | `'default'` | | `[nzSuffixIcon]` | 自定义的选择框后缀图标 | `TemplateRef` | - | | `[nzRemoveIcon]` | 自定义的多选框清除图标 | `TemplateRef` | - | | `[nzClearIcon]` | 自定义的多选框清空图标 | `TemplateRef` | - | @@ -79,7 +79,7 @@ import { NzSelectModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzLabel]` | 组名 | `string|TemplateRef` | - | +| `[nzLabel]` | 组名 | `string \| TemplateRef` | - | ## 方法 diff --git a/components/skeleton/doc/index.en-US.md b/components/skeleton/doc/index.en-US.md index 607cbca6fd5..7e18284a2b0 100644 --- a/components/skeleton/doc/index.en-US.md +++ b/components/skeleton/doc/index.en-US.md @@ -27,28 +27,28 @@ import { NzSkeletonModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | --- | --- | --- | --- | | `[nzActive]` | Show animation effect | `boolean` | `false` | -| `[nzAvatar]` | Show avatar placeholder | `boolean|NzSkeletonAvatar` | `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` | +| `[nzParagraph]` | Show paragraph placeholder | `boolean \| NzSkeletonParagraph` | `true` | +| `[nzTitle]` | Show title placeholder | `boolean \| NzSkeletonTitle` | `true` | ### NzSkeletonAvatar | Property | Description | Type | Default | | --- | --- | --- | --- | -| `size` | Set the size of avatar | `'large'|'small'|'default'` | - | -| `shape` | Set the shape of avatar | `'circle'|'square'` | - | +| `size` | Set the size of avatar | `'large' \| 'small' \| 'default'` | - | +| `shape` | Set the shape of avatar | `'circle' \| 'square'` | - | ### NzSkeletonTitle | Property | Description | Type | Default | | --- | --- | --- | --- | -| `width` | Set the width of title | `number|string` | - | +| `width` | Set the width of title | `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` | - | \ No newline at end of file +| `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` | - | \ No newline at end of file diff --git a/components/skeleton/doc/index.zh-CN.md b/components/skeleton/doc/index.zh-CN.md index cb5c2e06158..68b16e4ab56 100644 --- a/components/skeleton/doc/index.zh-CN.md +++ b/components/skeleton/doc/index.zh-CN.md @@ -29,27 +29,27 @@ import { NzSkeletonModule } from 'ng-zorro-antd'; | 属性 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[nzActive]` | 是否展示动画效果 | `boolean` | `false` | -| `[nzAvatar]` | 是否显示头像占位图 | `boolean|NzSkeletonAvatar` | `false` | +| `[nzAvatar]` | 是否显示头像占位图 | `boolean \| NzSkeletonAvatar` | `false` | | `[nzLoading]` | 为 `true` 时,显示占位图。反之则直接展示子组件 | `boolean` | - | -| `[nzParagraph]` | 是否显示段落占位图 | `boolean|NzSkeletonParagraph` | `true` | -| `[nzTitle]` | 是否显示标题占位图 | `boolean|NzSkeletonTitle` | `true` | +| `[nzParagraph]` | 是否显示段落占位图 | `boolean \| NzSkeletonParagraph` | `true` | +| `[nzTitle]` | 是否显示标题占位图 | `boolean \| NzSkeletonTitle` | `true` | ### NzSkeletonAvatar | 属性 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `size` | 设置头像占位图的大小 | `'large'|'small'|'default'` | - | -| `shape` | 指定头像的形状 | `'circle'|'square'` | - | +| `size` | 设置头像占位图的大小 | `'large' \| 'small' \| 'default'` | - | +| `shape` | 指定头像的形状 | `'circle' \| 'square'` | - | ### NzSkeletonTitle | 属性 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `width` | 设置标题占位图的宽度 | `number|string` | - | +| `width` | 设置标题占位图的宽度 | `number \| string` | - | ### NzSkeletonParagraph | 属性 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `rows` | 设置段落占位图的行数 | `number` | - | -| `width` | 设置标题占位图的宽度,若为数组时则为对应的每行宽度,反之则是最后一行的宽度 | `number|string|Array` | - | \ No newline at end of file +| `width` | 设置标题占位图的宽度,若为数组时则为对应的每行宽度,反之则是最后一行的宽度 | `number \| string \| Array` | - | \ No newline at end of file diff --git a/components/slider/doc/index.en-US.md b/components/slider/doc/index.en-US.md index 26fb472ac6e..22a6a106245 100644 --- a/components/slider/doc/index.en-US.md +++ b/components/slider/doc/index.en-US.md @@ -31,10 +31,10 @@ import { NzSliderModule } from 'ng-zorro-antd'; | `[nzMax]` | The maximum value the slider can slide to | `number` | `100` | | `[nzMin]` | The minimum value the slider can slide to. | `number` | `0` | | `[nzRange]` | dual thumb mode | `boolean` | `false` | -| `[nzStep]` | The granularity the slider can step through values. Must greater than 0, and be divided by (max - min) . When `marks` no null, `step` can be `null`. | `number|null` | `1` | +| `[nzStep]` | The granularity the slider can step through values. Must greater than 0, and be divided by (max - min) . When `marks` no null, `step` can be `null`. | `number \| null` | `1` | | `[nzTipFormatter]` | Slider will pass its value to `tipFormatter`, and display its value in Tooltip, and hide Tooltip when return value is null. | `(value: number) => string` | - | -| `[ngModel]` | The value of slider. When `range` is `false`, use `number`, otherwise, use `[number, number]` | `number|number[]` | - | +| `[ngModel]` | The value of slider. When `range` is `false`, use `number`, otherwise, use `[number, number]` | `number \| number[]` | - | | `[nzVertical]` | If true, the slider will be vertical. | `boolean` | `false` | -| `[nzTooltipVisible]` | When set to `always` tooltips are always displayed. When set to `never` they are never displayed | `'default'|'always'|'never'` | `default` | -| `(nzOnAfterChange)` | Fire when `onmouseup` is fired. | `EventEmitter` | - | -| `(ngModelChange)` | Callback function that is fired when the user changes the slider's value. | `EventEmitter` | - | +| `[nzTooltipVisible]` | When set to `always` tooltips are always displayed. When set to `never` they are never displayed | `'default' \| 'always' \| 'never'` | `default` | +| `(nzOnAfterChange)` | Fire when `onmouseup` is fired. | `EventEmitter` | - | +| `(ngModelChange)` | Callback function that is fired when the user changes the slider's value. | `EventEmitter` | - | diff --git a/components/slider/doc/index.zh-CN.md b/components/slider/doc/index.zh-CN.md index 4a99c65c4c2..ce83b96b3fd 100644 --- a/components/slider/doc/index.zh-CN.md +++ b/components/slider/doc/index.zh-CN.md @@ -32,10 +32,10 @@ import { NzSliderModule } from 'ng-zorro-antd'; | `[nzMax]` | 最大值 | `number` | `100` | | `[nzMin]` | 最小值 | `number` | `0` | | `[nzRange]` | 双滑块模式 | `boolean` | `false` | -| `[nzStep]` | 步长,取值必须大于 0,并且可被 (max - min) 整除。当 `marks` 不为空对象时,可以设置 `step` 为 `null`,此时 Slider 的可选值仅有 marks 标出来的部分。 | `number|null` | `1` | +| `[nzStep]` | 步长,取值必须大于 0,并且可被 (max - min) 整除。当 `marks` 不为空对象时,可以设置 `step` 为 `null`,此时 Slider 的可选值仅有 marks 标出来的部分。 | `number \| null` | `1` | | `[nzTipFormatter]` | Slider 会把当前值传给 `nzTipFormatter`,并在 Tooltip 中显示 `nzTipFormatter` 的返回值,若为 null,则隐藏 Tooltip。 | `(value: number) => string` | - | -| `[ngModel]` | 设置当前取值。当 `range` 为 `false` 时,使用 `number`,否则用 `[number, number]` | `number|number[]` | - | +| `[ngModel]` | 设置当前取值。当 `range` 为 `false` 时,使用 `number`,否则用 `[number, number]` | `number \| number[]` | - | | `[nzVertical]` | 值为 `true` 时,Slider 为垂直方向 | `boolean` | `false` | -| `[nzTooltipVisible]` | 值为 `always` 时总是显示,值为 `never` 时在任何情况下都不显示 | `'default'|'always'|'never'` | `default` | -| `(nzOnAfterChange)` | 与 `onmouseup` 触发时机一致,把当前值作为参数传入。 | `EventEmitter` | - | -| `(ngModelChange)` | 当 Slider 的值发生改变时,会触发 ngModelChange 事件,并把改变后的值作为参数传入。 | `EventEmitter>` | - | +| `[nzTooltipVisible]` | 值为 `always` 时总是显示,值为 `never` 时在任何情况下都不显示 | `'default' \| 'always' \| 'never'` | `default` | +| `(nzOnAfterChange)` | 与 `onmouseup` 触发时机一致,把当前值作为参数传入。 | `EventEmitter` | - | +| `(ngModelChange)` | 当 Slider 的值发生改变时,会触发 ngModelChange 事件,并把改变后的值作为参数传入。 | `EventEmitter>` | - | diff --git a/components/spin/doc/index.en-US.md b/components/spin/doc/index.en-US.md index 7e603f08fb6..b52ce7d2c6b 100644 --- a/components/spin/doc/index.en-US.md +++ b/components/spin/doc/index.en-US.md @@ -26,7 +26,7 @@ import { NzSpinModule } from 'ng-zorro-antd'; | -------- | ----------- | ---- | ------------- | | `[nzDelay]` | specifies a delay in milliseconds for loading state (prevent flush), unit: milliseconds | `number` | - | | `[nzIndicator]` | the spinning indicator | `TemplateRef` | - | -| `[nzSize]` | size of Spin | `'large'|'small'|'default'` | `'default'` | +| `[nzSize]` | size of Spin | `'large' \| 'small' \| 'default'` | `'default'` | | `[nzSpinning]` | whether Spin is spinning | `boolean` | `true` | | `[nzSimple]` | whether Spin has no children | `boolean` | `false` | | `[nzTip]` | customize description content when Spin has children | `string` | - | diff --git a/components/spin/doc/index.zh-CN.md b/components/spin/doc/index.zh-CN.md index eaf8fd4807a..91c2da8da9d 100644 --- a/components/spin/doc/index.zh-CN.md +++ b/components/spin/doc/index.zh-CN.md @@ -27,7 +27,7 @@ import { NzSpinModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[nzDelay]` | 延迟显示加载效果的时间(防止闪烁),单位:毫秒 | `number` | - | | `[nzIndicator]` | 加载指示符 | `TemplateRef` | - | -| `[nzSize]` | 组件大小 | `'large'|'small'|'default'` | `'default'` | +| `[nzSize]` | 组件大小 | `'large' \| 'small' \| 'default'` | `'default'` | | `[nzSpinning]` | 是否旋转 | `boolean` | `true` | | `[nzSimple]` | 是否包裹元素 | `boolean` | `false` | | `[nzTip]` | 当作为包裹元素时,可以自定义描述文案 | `string` | - | diff --git a/components/statistic/doc/index.en-US.md b/components/statistic/doc/index.en-US.md index c6b77c33084..fc22f8089d6 100644 --- a/components/statistic/doc/index.en-US.md +++ b/components/statistic/doc/index.en-US.md @@ -25,22 +25,22 @@ import { NzStatisticModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzPrefix]` | Prefix of Value | `string|TemplateRef` | - | -| `[nzSuffix]` | Suffix of Value | `string|TemplateRef` | - | -| `[nzTitle]` | Title | `string|TemplateRef` | - | -| `[nzValue]` | Value | `string|number` | - | +| `[nzPrefix]` | Prefix of Value | `string \| TemplateRef` | - | +| `[nzSuffix]` | Suffix of Value | `string \| TemplateRef` | - | +| `[nzTitle]` | Title | `string \| TemplateRef` | - | +| `[nzValue]` | Value | `string \| number` | - | | `[nzValueStyle]` | Value CSS style | `Object` | - | -| `[nzValueTemplate]` | Custom template to render a number | `TemplateRef<{ $implicit: string|number }>` | - | +| `[nzValueTemplate]` | Custom template to render a number | `TemplateRef<{ $implicit: string \| number }>` | - | ### nz-countdown | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | `[nzFormat]` | Format string | `string` | `"HH:mm:ss"` | -| `[nzPrefix]` | Prefix of Value | `string|TemplateRef` | - | -| `[nzSuffix]` | Suffix of Value | `string|TemplateRef` | - | -| `[nzTitle]` | Title | `string|TemplateRef` | - | -| `[nzValue]` | Target time in timestamp form | `string|number` | - | +| `[nzPrefix]` | Prefix of Value | `string \| TemplateRef` | - | +| `[nzSuffix]` | Suffix of Value | `string \| TemplateRef` | - | +| `[nzTitle]` | Title | `string \| TemplateRef` | - | +| `[nzValue]` | Target time in timestamp form | `string \| number` | - | | `[nzValueTemplate]` | Custom template to render a time | `TemplateRef<{ $implicit: number }>` | - | ### nzFormat diff --git a/components/statistic/doc/index.zh-CN.md b/components/statistic/doc/index.zh-CN.md index 4e354fd549d..f3787844a20 100644 --- a/components/statistic/doc/index.zh-CN.md +++ b/components/statistic/doc/index.zh-CN.md @@ -26,22 +26,22 @@ import { NzStatisticModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | -------- | ----------- | ---- | ------- | -| `[nzPrefix]` | 设置数值的前缀 | `string|TemplateRef` | - | -| `[nzSuffix]` | 设置数值的后缀 | `string|TemplateRef` | - | -| `[nzTitle]` | 数值的标题 | `string|TemplateRef` | - | -| `[nzValue]` | 数值内容 | `string|number` | - | +| `[nzPrefix]` | 设置数值的前缀 | `string \| TemplateRef` | - | +| `[nzSuffix]` | 设置数值的后缀 | `string \| TemplateRef` | - | +| `[nzTitle]` | 数值的标题 | `string \| TemplateRef` | - | +| `[nzValue]` | 数值内容 | `string \| number` | - | | `[nzValueStyle]` | 设置数值的样式 | `Object` | - | -| `[nzValueTemplate]` | 自定义数值展示 | `TemplateRef<{ $implicit: string|number }>` | - | +| `[nzValueTemplate]` | 自定义数值展示 | `TemplateRef<{ $implicit: string \| number }>` | - | ### nz-countdown | 参数 | 说明 | 类型 | 默认值 | | -------- | ----------- | ---- | ------- | | `[nzFormat]` | 格式化倒计时展示 | `string` | `"HH:mm:ss"` | -| `[nzPrefix]` | 设置数值的前缀 | `string|TemplateRef` | - | -| `[nzSuffix]` | 设置数值的后缀 | `string|TemplateRef` | - | -| `[nzTitle]` | 数值的标题 | `string|TemplateRef` | - | -| `[nzValue]` | 时间戳格式的目标时间 | `string|number` | - | +| `[nzPrefix]` | 设置数值的前缀 | `string \| TemplateRef` | - | +| `[nzSuffix]` | 设置数值的后缀 | `string \| TemplateRef` | - | +| `[nzTitle]` | 数值的标题 | `string \| TemplateRef` | - | +| `[nzValue]` | 时间戳格式的目标时间 | `string \| number` | - | | `[nzValueTemplate]` | 自定义时间展示 | `TemplateRef<{ $implicit: number }>` | - | ### nzFormat diff --git a/components/steps/doc/index.en-US.md b/components/steps/doc/index.en-US.md index 422ceb4a29b..35c0a3a48db 100755 --- a/components/steps/doc/index.en-US.md +++ b/components/steps/doc/index.en-US.md @@ -36,11 +36,11 @@ The whole of the step bar. | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | `[nzCurrent]` | To set the current step, counting from 0. You can overwrite this state by using `nzStatus` of `nz-step` | `number` | `0` | -| `[nzDirection]` | To specify the direction of the step bar, `horizontal` and `vertical` are currently supported | `'vertical'|'horizontal'` | `horizontal` | -| `[nzLabelPlacement]` | Support vertical title and description | `'vertical'|'horizontal'` | `horizontal` | -| `[nzProgressDot]` | Steps with progress dot style, customize the progress dot by setting it with TemplateRef | `boolean|TemplateRef<{ $implicit: TemplateRef, status: string, index: number }>` | `false` | -| `[nzSize]` | To specify the size of the step bar, `default` and `small` are currently supported | `'small'|'default'` | `'default'` | -| `[nzStatus]` | To specify the status of current step, can be set to one of the following values: `wait` `process` `finish` `error` | `'wait'|'process'|'finish'|'error'` | `'process'` | +| `[nzDirection]` | To specify the direction of the step bar, `horizontal` and `vertical` are currently supported | `'vertical' \| 'horizontal'` | `horizontal` | +| `[nzLabelPlacement]` | Support vertical title and description | `'vertical' \| 'horizontal'` | `horizontal` | +| `[nzProgressDot]` | Steps with progress dot style, customize the progress dot by setting it with TemplateRef | `boolean \| TemplateRef<{ $implicit: TemplateRef, status: string, index: number }>` | `false` | +| `[nzSize]` | To specify the size of the step bar, `default` and `small` are currently supported | `'small' \| 'default'` | `'default'` | +| `[nzStatus]` | To specify the status of current step, can be set to one of the following values: `wait` `process` `finish` `error` | `'wait' \| 'process' \| 'finish' \| 'error'` | `'process'` | | `[nzStartIndex]` | To specify the starting number | `number` | `0` | ### nz-step @@ -49,7 +49,7 @@ A single step in the step bar. | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzDescription]` | description of the step, optional property | `string|TemplateRef` | - | -| `[nzIcon]` | icon of the step, optional property | `string|string[]|Set|{ [klass: string]: any; }` | `TemplateRef` | - | -| `[nzStatus]` | to specify the status. It will be automatically set by `nzCurrent` of `nz-steps` if not configured. Optional values are: `wait` `process` `finish` `error` | `'wait'|'process'|'finish'|'error'` | `'wait'` | -| `[nzTitle]` | title of the step | `string|TemplateRef` | - | +| `[nzDescription]` | description of the step, optional property | `string \| TemplateRef` | - | +| `[nzIcon]` | icon of the step, optional property | `string \| string[] \| Set \| { [klass: string]: any; }` \| `TemplateRef` | - | +| `[nzStatus]` | to specify the status. It will be automatically set by `nzCurrent` of `nz-steps` if not configured. Optional values are: `wait` `process` `finish` `error` | `'wait' \| 'process' \| 'finish' \| 'error'` | `'wait'` | +| `[nzTitle]` | title of the step | `string \| TemplateRef` | - | diff --git a/components/steps/doc/index.zh-CN.md b/components/steps/doc/index.zh-CN.md index 1a53cdaa851..ba3ad863412 100755 --- a/components/steps/doc/index.zh-CN.md +++ b/components/steps/doc/index.zh-CN.md @@ -37,11 +37,11 @@ import { NzStepsModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[nzCurrent]` | 指定当前步骤,从 0 开始记数。在子 `nz-step` 元素中,可以通过 `nzStatus` 属性覆盖状态 | `number` | `0` | -| `[nzDirection]` | 指定步骤条方向。目前支持水平(`horizontal`)和竖直(`vertical`)两种方向 | `'vertical'|'horizontal'` | `horizontal` | -| `[nzLabelPlacement]` | 指定标签放置位置,默认水平放图标右侧,可选 `vertical` 放图标下方 | `'vertical'|'horizontal'` | `horizontal` | -| `[nzProgressDot]` | 点状步骤条,可以设置为一个 TemplateRef | `boolean|TemplateRef<{ $implicit: TemplateRef, status: string, index: number }>` | `false` | -| `[nzSize]` | 指定大小,目前支持普通(`default`)和迷你(`small`) | `'small'|'default'` | `'default'` | -| `[nzStatus]` | 指定当前步骤的状态,可选 `wait` `process` `finish` `error` | `'wait'|'process'|'finish'|'error'` | `'process'` | +| `[nzDirection]` | 指定步骤条方向。目前支持水平(`horizontal`)和竖直(`vertical`)两种方向 | `'vertical' \| 'horizontal'` | `horizontal` | +| `[nzLabelPlacement]` | 指定标签放置位置,默认水平放图标右侧,可选 `vertical` 放图标下方 | `'vertical' \| 'horizontal'` | `horizontal` | +| `[nzProgressDot]` | 点状步骤条,可以设置为一个 TemplateRef | `boolean \| TemplateRef<{ $implicit: TemplateRef, status: string, index: number }>` | `false` | +| `[nzSize]` | 指定大小,目前支持普通(`default`)和迷你(`small`) | `'small' \| 'default'` | `'default'` | +| `[nzStatus]` | 指定当前步骤的状态,可选 `wait` `process` `finish` `error` | `'wait' \| 'process' \| 'finish' \| 'error'` | `'process'` | | `[nzStartIndex]` | 指定起始位置的序号 | `number` | `0` | ### nz-step @@ -50,7 +50,7 @@ import { NzStepsModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzDescription]` | 步骤的详情描述,可选 | `string|TemplateRef` | - | -| `[nzIcon]` | 步骤图标的类型,可选 | `string|string[]|Set|{ [klass: string]: any; }` | `TemplateRef` | - | -| `[nzStatus]` | 指定状态。当不配置该属性时,会使用 `nz-steps` 的 `nzCurrent` 来自动指定状态。可选:`wait` `process` `finish` `error` | `'wait'|'process'|'finish'|'error'` | `'wait'` | -| `[nzTitle]` | 标题 | `string|TemplateRef` | - | +| `[nzDescription]` | 步骤的详情描述,可选 | `string \| TemplateRef` | - | +| `[nzIcon]` | 步骤图标的类型,可选 | `string \| string[] \| Set \| { [klass: string]: any; }` \| `TemplateRef` | - | +| `[nzStatus]` | 指定状态。当不配置该属性时,会使用 `nz-steps` 的 `nzCurrent` 来自动指定状态。可选:`wait` `process` `finish` `error` | `'wait' \| 'process' \| 'finish' \| 'error'` | `'wait'` | +| `[nzTitle]` | 标题 | `string \| TemplateRef` | - | diff --git a/components/switch/doc/index.en-US.md b/components/switch/doc/index.en-US.md index ff73566b014..bcb69d737d9 100755 --- a/components/switch/doc/index.en-US.md +++ b/components/switch/doc/index.en-US.md @@ -26,10 +26,10 @@ import { NzSwitchModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | `[ngModel]` | determine whether the `nz-switch` is checked, double binding | `boolean` | `false` | -| `[nzCheckedChildren]` | content to be shown when the state is checked | `string|TemplateRef` | - | -| `[nzUnCheckedChildren]` | content to be shown when the state is unchecked | `string|TemplateRef` | - | +| `[nzCheckedChildren]` | content to be shown when the state is checked | `string \| TemplateRef` | - | +| `[nzUnCheckedChildren]` | content to be shown when the state is unchecked | `string \| TemplateRef` | - | | `[nzDisabled]` | Disable switch | `boolean` | `false` | -| `[nzSize]` | the size of the `nz-switch`, options: `default` `small` | `'small'|'default'` | `'default'` | +| `[nzSize]` | the size of the `nz-switch`, options: `default` `small` | `'small' \| 'default'` | `'default'` | | `[nzLoading]` | loading state of switch | `boolean` | `false` | | `[nzControl]` | determine whether fully control state by user | `boolean` | `false` | | `(ngModelChange)` | a callback function, can be executed when the checked state is changing | `EventEmitter` | - | diff --git a/components/switch/doc/index.zh-CN.md b/components/switch/doc/index.zh-CN.md index 1d8d06684e1..7707b0f98c5 100755 --- a/components/switch/doc/index.zh-CN.md +++ b/components/switch/doc/index.zh-CN.md @@ -27,10 +27,10 @@ import { NzSwitchModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[ngModel]` | 指定当前是否选中,可双向绑定 | `boolean` | `false` | -| `[nzCheckedChildren]` | 选中时的内容 | `string|TemplateRef` | - | -| `[nzUnCheckedChildren]` | 非选中时的内容 | `string|TemplateRef` | - | +| `[nzCheckedChildren]` | 选中时的内容 | `string \| TemplateRef` | - | +| `[nzUnCheckedChildren]` | 非选中时的内容 | `string \| TemplateRef` | - | | `[nzDisabled]` | disable 状态 | `boolean` | `false` | -| `[nzSize]` | 开关大小,可选值:`default` `small` | `'small'|'default'` | `'default'` | +| `[nzSize]` | 开关大小,可选值:`default` `small` | `'small' \| 'default'` | `'default'` | | `[nzLoading]` | 加载中的开关 | `boolean` | `false` | | `[nzControl]` | 是否完全由用户控制状态 | `boolean` | `false` | | `(ngModelChange)` | 当前是否选中的回调 | `EventEmitter` | `false` | diff --git a/components/table/doc/index.en-US.md b/components/table/doc/index.en-US.md index 1e72eac39c5..fb0da223ed7 100644 --- a/components/table/doc/index.en-US.md +++ b/components/table/doc/index.en-US.md @@ -73,22 +73,22 @@ import { NzTableModule } from 'ng-zorro-antd'; | `[nzPageIndex]` | pageIndex , double binding | `number` | - | | `[nzPageSize]` | pageSize, double binding | `number` | - | | `[nzShowPagination]` | Whether show pagination component in bottom of the table | `boolean` | `true` | -| `[nzPaginationPosition]` | Specify the position of Pagination | `'top'|'bottom'|'both'` | `bottom` | +| `[nzPaginationPosition]` | Specify the position of Pagination | `'top' \| 'bottom' \| 'both'` | `bottom` | | `[nzBordered]` | Whether to show all table borders | `boolean` | `false` | | `[nzWidthConfig]` | Set col width can not used with `nzWidth` of `th` | `string[]` | - | -| `[nzSize]` | Size of table | `'middle'|'small'|'default'` | `'default'` | +| `[nzSize]` | Size of table | `'middle' \| 'small' \| 'default'` | `'default'` | | `[nzLoading]` | Loading status of table | `boolean` | `false` | | `[nzLoadingIndicator]` | the spinning indicator | `TemplateRef` | - | | `[nzLoadingDelay]` | Specifies a delay in milliseconds for loading state (prevent flush) | `number` | `0` | | `[nzScroll]` | Whether table can be scrolled in x/y direction, `x` or `y` can be a string that indicates the width and height of table body | `object` | - | -| `[nzTitle]` | Table title renderer | `string|TemplateRef` | - | -| `[nzFooter]` | Table footer renderer | `string|TemplateRef` | - | -| `[nzNoResult]` | Custom no result content | `string|TemplateRef` | - | +| `[nzTitle]` | Table title renderer | `string \| TemplateRef` | - | +| `[nzFooter]` | Table footer renderer | `string \| TemplateRef` | - | +| `[nzNoResult]` | Custom no result content | `string \| TemplateRef` | - | | `[nzPageSizeOptions]` | Specify the sizeChanger options | `number[]` | `[10, 20, 30, 40]` | | `[nzShowQuickJumper]` | Determine whether you can jump to pages directly | `boolean` | `false` | | `[nzShowSizeChanger]` | Determine whether `nzPageSize` can be changed | `boolean` | `false` | | `[nzShowTotal]` | To display Pagination total number and range, same as Pagination | `TemplateRef<{ $implicit: number, range: [ number, number ] }>` | - | -| `[nzItemRender]` | to customize Pagination item, same as Pagination | `TemplateRef<{ $implicit: 'page'|'prev'|'next', page: number }>` | - | +| `[nzItemRender]` | to customize Pagination item, same as Pagination | `TemplateRef<{ $implicit: 'page' \| 'prev' \| 'next', page: number }>` | - | | `[nzHideOnSinglePage]` | Whether to hide pager on single page | `boolean` | `false` | | `[nzSimple]` | whether to use simple mode | `boolean` | - | | `[nzTemplateMode]` | template mode,no need to pass data to `nzData` | `boolean` | `false` | @@ -127,7 +127,7 @@ Filter property | `[nzShowFilter]` | Whether show filter | `boolean` | - | | `[nzFilters]` | Filter options, `text`, and `value` for callback, `byDefault` to enable filter by default | `Array<{ text: string; value: any; byDefault?: boolean }>` | - | | `[nzFilterMultiple]` | Whether filter multiple mode | `boolean` | `true` | -| `(nzFilterChange)` | Filter change callback `value` | `EventEmitter` | - | +| `(nzFilterChange)` | Filter change callback `value` | `EventEmitter` | - | Style property @@ -137,7 +137,7 @@ Style property | `[nzWidth]` | Specify the column width, can not used when grouping columns | `string` | - | | `[nzLeft]` | Left pixels, used to fixed column to left | `string` | - | | `[nzRight]` | Right pixels, used to fixed column to right | `string` | - | -| `[nzAlign]` | Specify how content is aligned | `'left'|'right'|'center'` | - | +| `[nzAlign]` | Specify how content is aligned | `'left' \| 'right' \| 'center'` | - | Other property @@ -171,7 +171,7 @@ Style property | -------- | ----------- | ---- | ------- | | `[nzLeft]` | Left pixels, used to fixed column to left | `string` | - | | `[nzRight]` | Right pixels, used to fixed column to right | `string` | - | -| `[nzAlign]` | Specify how content is aligned | `'left'|'right'|'center'` | - | +| `[nzAlign]` | Specify how content is aligned | `'left' \| 'right' \| 'center'` | - | Other property @@ -184,7 +184,7 @@ Other property | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | `[nzSingleSort]` | Whether single column sort mode | `boolean` | `false` | -| `(nzSortChange)` | sort change callback,should used with `nzSortKey` of `th` | `EventEmitter<{ nzSortKey: string, value: 'descend'|'ascend'|null }>` | - | +| `(nzSortChange)` | sort change callback,should used with `nzSortKey` of `th` | `EventEmitter<{ nzSortKey: string, value: 'descend' \| 'ascend' \| null }>` | - | ### tr diff --git a/components/table/doc/index.zh-CN.md b/components/table/doc/index.zh-CN.md index deaed967f6a..0e23713a1c4 100644 --- a/components/table/doc/index.zh-CN.md +++ b/components/table/doc/index.zh-CN.md @@ -74,22 +74,22 @@ import { NzTableModule } from 'ng-zorro-antd'; | `[nzPageIndex]` | 当前页码,可双向绑定 | `number` | - | | `[nzPageSize]` | 每页展示多少数据,可双向绑定 | `number` | - | | `[nzShowPagination]` | 是否显示分页器 | `boolean` | `true` | -| `[nzPaginationPosition]` | 指定分页显示的位置 | `'top'|'bottom'|'both'` | `bottom` | +| `[nzPaginationPosition]` | 指定分页显示的位置 | `'top' \| 'bottom' \| 'both'` | `bottom` | | `[nzBordered]` | 是否展示外边框和列边框 | `boolean` | `false` | | `[nzWidthConfig]` | 表头分组时指定每列宽度,与 `th` 的 `nzWidth` 不可混用 | `string[]` | - | -| `[nzSize]` | 正常或迷你类型 | `'middle'|'small'|'default'` | `'default'` | +| `[nzSize]` | 正常或迷你类型 | `'middle' \| 'small' \| 'default'` | `'default'` | | `[nzLoading]` | 页面是否加载中 | `boolean` | `false` | | `[nzLoadingIndicator]` | 加载指示符 | `TemplateRef` | - | | `[nzLoadingDelay]` | 延迟显示加载效果的时间(防止闪烁) | `number` | `0` | | `[nzScroll]` | 横向或纵向支持滚动,也可用于指定滚动区域的宽高度:`{ x: "300px", y: "300px" }` | `object` | - | -| `[nzTitle]` | 表格标题 | `string|TemplateRef` | - | -| `[nzFooter]` | 表格尾部 | `string|TemplateRef` | - | -| `[nzNoResult]` | 无数据时显示内容 | `string|TemplateRef` | - | +| `[nzTitle]` | 表格标题 | `string \| TemplateRef` | - | +| `[nzFooter]` | 表格尾部 | `string \| TemplateRef` | - | +| `[nzNoResult]` | 无数据时显示内容 | `string \| TemplateRef` | - | | `[nzPageSizeOptions]` | 页数选择器可选值 | `number[]` | `[ 10, 20, 30, 40, 50 ]` | | `[nzShowQuickJumper]` | 是否可以快速跳转至某页 | `boolean` | `false` | | `[nzShowSizeChanger]` | 是否可以改变 `nzPageSize` | `boolean` | `false` | | `[nzShowTotal]` | 用于显示数据总量和当前数据范围,用法参照 Pagination 组件 | `TemplateRef<{ $implicit: number, range: [ number, number ] }>` | - | -| `[nzItemRender]` | 用于自定义页码的结构,用法参照 Pagination 组件 | `TemplateRef<{ $implicit: 'page'|'prev'|'next', page: number }>` | - | +| `[nzItemRender]` | 用于自定义页码的结构,用法参照 Pagination 组件 | `TemplateRef<{ $implicit: 'page' \| 'prev' \| 'next', page: number }>` | - | | `[nzHideOnSinglePage]` | 只有一页时是否隐藏分页器 | `boolean` | `false` | | `[nzSimple]` | 当添加该属性时,显示为简单分页 | `boolean` | - | | `[nzVirtualScroll]` | 是否启用虚拟滚动模式,与 `[nzScroll]` 配合使用 | `boolean` | `false` | @@ -125,8 +125,8 @@ import { NzTableModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[nzShowSort]` | 是否显示排序 | `boolean` | - | | `[nzSortKey]` | 排序key,非受控模式使用,与 `thead` 中 `nzSortChange` 配合使用 | `string` | - | -| `[nzSort]` | 当前排序状态,受控模式使用,可双向绑定 | 'descend'|'ascend'|null | null | -| `(nzSortChange)` | 排序状态改变回调,受控模式使用 | `EventEmitter<'descend'|'ascend'|null>` | - | +| `[nzSort]` | 当前排序状态,受控模式使用,可双向绑定 | 'descend' \| 'ascend' \| null | null | +| `(nzSortChange)` | 排序状态改变回调,受控模式使用 | `EventEmitter<'descend' \| 'ascend' \| null>` | - | 过滤属性 @@ -135,7 +135,7 @@ import { NzTableModule } from 'ng-zorro-antd'; | `[nzShowFilter]` | 是否显示过滤 | `boolean` | - | | `[nzFilters]` | 过滤器内容, 显示数据 `text`,回调函数传出 `value`,设置 `byDefault` 以默认应用过滤规则 | `Array<{ text: string; value: any; byDefault?: boolean }>` | - | | `[nzFilterMultiple]` | 是否为多选过滤器 | `boolean` | `true` | -| `(nzFilterChange)` | 过滤器内容选择的 value 数据回调 | `EventEmitter` | - | +| `(nzFilterChange)` | 过滤器内容选择的 value 数据回调 | `EventEmitter` | - | 样式属性 @@ -144,7 +144,7 @@ import { NzTableModule } from 'ng-zorro-antd'; | `[nzWidth]` | 指定该列宽度,表头未分组时可用 | `string` | - | | `[nzLeft]` | 左侧距离,用于固定左侧列 | `string` | - | | `[nzRight]` | 右侧距离,用于固定右侧列 | `string` | - | -| `[nzAlign]` | 设置列内容的对齐方式 | `'left'|'right'|'center'` | - | +| `[nzAlign]` | 设置列内容的对齐方式 | `'left' \| 'right' \| 'center'` | - | 其他 @@ -178,7 +178,7 @@ import { NzTableModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | `[nzLeft]` | 左侧距离,用于固定左侧列 | `string` | - | | `[nzRight]` | 右侧距离,用于固定右侧列 | `string` | - | -| `[nzAlign]` | 设置列内容的对齐方式 | `'left'|'right'|'center'` | - | +| `[nzAlign]` | 设置列内容的对齐方式 | `'left' \| 'right' \| 'center'` | - | 其他 @@ -192,7 +192,7 @@ import { NzTableModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[nzSingleSort]` | 是否单列排序模式,非受控排序下使用 | `boolean` | `false` | -| `(nzSortChange)` | 排序改变时的回调函数,需要与 `th` 上的 `nzSortKey` 同时使用,非受控排序下使用 | `EventEmitter<{ nzSortKey: string, value: 'descend'|'ascend'|null }>` | - | +| `(nzSortChange)` | 排序改变时的回调函数,需要与 `th` 上的 `nzSortKey` 同时使用,非受控排序下使用 | `EventEmitter<{ nzSortKey: string, value: 'descend' \| 'ascend' \| null }>` | - | ### tr diff --git a/components/tabs/doc/index.en-US.md b/components/tabs/doc/index.en-US.md index 1fb109f19a2..4012985c7d8 100644 --- a/components/tabs/doc/index.en-US.md +++ b/components/tabs/doc/index.en-US.md @@ -30,12 +30,12 @@ import { NzTabsModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | `[nzSelectedIndex]` | Current tab's index | `number` | - | -| `[nzAnimated]` | Whether to change tabs with animation. Only works while `nzTabPosition="top"|"bottom"` | `boolean|{inkBar:boolean, tabPane:boolean}` | `true`, `false` when `type="card"` | -| `[nzSize]` | preset tab bar size | `'large'|'small'|'default'` | `'default'` | +| `[nzAnimated]` | Whether to change tabs with animation. Only works while `nzTabPosition="top" \| "bottom"` | `boolean \| {inkBar:boolean, tabPane:boolean}` | `true`, `false` when `type="card"` | +| `[nzSize]` | preset tab bar size | `'large' \| 'small' \| 'default'` | `'default'` | | `[nzTabBarExtraContent]` | Extra content in tab bar | `TemplateRef` | - | | `[nzTabBarStyle]` | Tab bar style object | `object` | - | -| `[nzTabPosition]` | Position of tabs | `'top'|'right'|'bottom'|'left'` | `'top'` | -| `[nzType]` | Basic style of tabs | `'line'|'card'` | `'line'` | +| `[nzTabPosition]` | Position of tabs | `'top' \| 'right' \| 'bottom' \| 'left'` | `'top'` | +| `[nzType]` | Basic style of tabs | `'line' \| 'card'` | `'line'` | | `[nzTabBarGutter]` | The gap between tabs | `number` | - | | `[nzHideAll]` | Whether hide all tabs | `boolean` | `false` | | `[nzShowPagination]` | Whether show pre or next button when exceed display area | `boolean` | `true` | @@ -48,7 +48,7 @@ import { NzTabsModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzTitle]` | Show text in tab's head | `string|TemplateRef` | - | +| `[nzTitle]` | Show text in tab's head | `string \| TemplateRef` | - | | `[nzForceRender]` | Forced render of content in tabs, not lazy render after clicking on tabs | `boolean` | `false` | | `[nzDisabled]` | tab disable | `boolean` | - | | `(nzClick)` | title click callback | `EventEmitter` | - | diff --git a/components/tabs/doc/index.zh-CN.md b/components/tabs/doc/index.zh-CN.md index aa0555fabd7..7dc304f7649 100644 --- a/components/tabs/doc/index.zh-CN.md +++ b/components/tabs/doc/index.zh-CN.md @@ -33,12 +33,12 @@ import { NzTabsModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[nzSelectedIndex]` | 当前激活 tab 面板的 序列号,可双向绑定 | `number` | - | -| `[nzAnimated]` | 是否使用动画切换 Tabs,在 nzTabPosition=top|bottom 时有效 | `boolean|{inkBar:boolean, tabPane:boolean}` | `true`, 当 `type="card"` 时为 `false` | -| `[nzSize]` | 大小,提供 `large` `default` 和 `small` 三种大小 | `'large'|'small'|'default'` | `'default'` | +| `[nzAnimated]` | 是否使用动画切换 Tabs,在 nzTabPosition=top \| bottom 时有效 | `boolean \| {inkBar:boolean, tabPane:boolean}` | `true`, 当 `type="card"` 时为 `false` | +| `[nzSize]` | 大小,提供 `large` `default` 和 `small` 三种大小 | `'large' \| 'small' \| 'default'` | `'default'` | | `[nzTabBarExtraContent]` | tab bar 上额外的元素 | `TemplateRef` | - | | `[nzTabBarStyle]` | tab bar 的样式对象 | `object` | - | -| `[nzTabPosition]` | 页签位置,可选值有 `top` `right` `bottom` `left` | `'top'|'right'|'bottom'|'left'` | `'top'` | -| `[nzType]` | 页签的基本样式,可选 `line`、`card` 类型 | `'line'|'card'` | `'line'` | +| `[nzTabPosition]` | 页签位置,可选值有 `top` `right` `bottom` `left` | `'top' \| 'right' \| 'bottom' \| 'left'` | `'top'` | +| `[nzType]` | 页签的基本样式,可选 `line`、`card` 类型 | `'line' \| 'card'` | `'line'` | | `[nzTabBarGutter]` | tabs 之间的间隙 | `number` | - | | `[nzHideAll]` | 是否隐藏所有tab内容 | `boolean` | `false` | | `[nzShowPagination]` | 是否超出范围时显示pre和next按钮 | `boolean` | `true` | @@ -51,7 +51,7 @@ import { NzTabsModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzTitle]` | 选项卡头显示文字 | `string|TemplateRef` | - | +| `[nzTitle]` | 选项卡头显示文字 | `string \| TemplateRef` | - | | `[nzForceRender]` | 被隐藏时是否渲染 DOM 结构 | `boolean` | `false` | | `[nzDisabled]` | 是否禁用 | `boolean` | - | | `(nzClick)` | title被点击的回调函数 | `EventEmitter` | - | diff --git a/components/tag/doc/index.en-US.md b/components/tag/doc/index.en-US.md index 18563d48537..f50892e449f 100644 --- a/components/tag/doc/index.en-US.md +++ b/components/tag/doc/index.en-US.md @@ -26,7 +26,7 @@ import { NzTagModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzMode]` | Mode of tag | `'closeable'|'default'|'checkable'` | `'default'` | +| `[nzMode]` | Mode of tag | `'closeable' \| 'default' \| 'checkable'` | `'default'` | | `[nzChecked]` | Checked status of Tag, double binding, only works when `nzMode="checkable"` | `boolean` | `false` | | `[nzColor]` | Color of the Tag | `string` | - | | `(nzAfterClose)` | Callback executed when close animation is completed, only works when `nzMode="closable"` | `EventEmitter` | - | diff --git a/components/tag/doc/index.zh-CN.md b/components/tag/doc/index.zh-CN.md index 40b8185156c..652f6d7504c 100644 --- a/components/tag/doc/index.zh-CN.md +++ b/components/tag/doc/index.zh-CN.md @@ -26,7 +26,7 @@ import { NzTagModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzMode]` | 设定标签工作的模式 | `'closeable'|'default'|'checkable'` | `'default'` | +| `[nzMode]` | 设定标签工作的模式 | `'closeable' \| 'default' \| 'checkable'` | `'default'` | | `[nzChecked]` | 设置标签的选中状态,可双向绑定,在 `nzMode="checkable"` 时可用 | `boolean` | `false` | | `[nzColor]` | 标签色 | `string` | - | | `(nzAfterClose)` | 关闭动画完成后的回调,在 `nzMode="closable"` 时可用 | `EventEmitter` | - | diff --git a/components/timeline/doc/index.en-US.md b/components/timeline/doc/index.en-US.md index 3f9ccf21105..505378b7071 100644 --- a/components/timeline/doc/index.en-US.md +++ b/components/timeline/doc/index.en-US.md @@ -36,10 +36,10 @@ Timeline | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzPending]` | Set the last ghost node's existence or its content | `string|boolean|TemplateRef` | `false` | -| `[nzPendingDot]` | Set the dot of the last ghost node when pending is true | `string|TemplateRef` | `` | +| `[nzPending]` | Set the last ghost node's existence or its content | `string \| boolean \| TemplateRef` | `false` | +| `[nzPendingDot]` | Set the dot of the last ghost node when pending is true | `string \| TemplateRef` | `` | | `[nzReverse]` | Reverse nodes or not | `boolean` | `false` | -| `[nzMode]` | By sending `alternate` the timeline will distribute the nodes to the left and right | `'left'|'alternate'|'right'` | - | +| `[nzMode]` | By sending `alternate` the timeline will distribute the nodes to the left and right | `'left' \| 'alternate' \| 'right'` | - | ### nz-timeline-item @@ -48,4 +48,4 @@ Node of timeline | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | `[nzColor]` | Set the circle's color to `blue`, `red`, `green` or other custom colors (css color) | `string` | `blue` | -| `[nzDot]` | Customize timeline dot | `string|TemplateRef` | - | +| `[nzDot]` | Customize timeline dot | `string \| TemplateRef` | - | diff --git a/components/timeline/doc/index.zh-CN.md b/components/timeline/doc/index.zh-CN.md index 8a029c6a170..39c0cc3af8b 100644 --- a/components/timeline/doc/index.zh-CN.md +++ b/components/timeline/doc/index.zh-CN.md @@ -37,10 +37,10 @@ import { NzTimelineModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzPending]` | 指定最后一个幽灵节点是否存在或内容 | `string|boolean|TemplateRef` | `false` | -| `[nzPendingDot]` | 当最后一个幽灵节点存在時,指定其时间图点 | `string|TemplateRef` | `` | +| `[nzPending]` | 指定最后一个幽灵节点是否存在或内容 | `string \| boolean \| TemplateRef` | `false` | +| `[nzPendingDot]` | 当最后一个幽灵节点存在時,指定其时间图点 | `string \| TemplateRef` | `` | | `[nzReverse]` | 节点排序 | `boolean` | `false` | -| `[nzMode]` | 可以改变时间轴和内容的相对位置 | `'left'|'alternate'|'right'` | - | +| `[nzMode]` | 可以改变时间轴和内容的相对位置 | `'left' \| 'alternate' \| 'right'` | - | ### nz-timeline-item @@ -49,4 +49,4 @@ import { NzTimelineModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[nzColor]` | 指定圆圈颜色 `blue, red, green`,或自定义的色值(CSS 颜色) | `string` | blue | -| `[nzDot]` | 自定义时间轴点 | `string|TemplateRef` | - | +| `[nzDot]` | 自定义时间轴点 | `string \| TemplateRef` | - | diff --git a/components/tooltip/doc/index.en-US.md b/components/tooltip/doc/index.en-US.md index 506b0119722..1afd44d0dac 100644 --- a/components/tooltip/doc/index.en-US.md +++ b/components/tooltip/doc/index.en-US.md @@ -25,7 +25,7 @@ import { NzToolTipModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzTitle]` | The text shown in the tooltip | `string|TemplateRef` | - | +| `[nzTitle]` | The text shown in the tooltip | `string \| TemplateRef` | - | ### Common API @@ -37,8 +37,8 @@ The following APIs are shared by `nz-tooltip`, `nz-popconfirm`, `nz-popover`. | `[nzMouseLeaveDelay]` | Delay in seconds, before tooltip is hidden on mouse leave | `number` | `0.1` | | `[nzOverlayClassName]` | Class name of the tooltip card | `string` | - | | `[nzOverlayStyle]` | Style of the tooltip card | `object` | - | -| `[nzPlacement]` | The position of the tooltip relative to the target | `'top'|'left'|'right'|'bottom'|'topLeft'|'topRight'|'bottomLeft'|'bottomRight'|'leftTop'|'leftBottom'|'rightTop'|'rightBottom'` | `'top'` | -| `[nzTrigger]` | Tooltip trigger mode | `'click'|'focus'|'hover'` | `'hover'` | +| `[nzPlacement]` | The position of the tooltip relative to the target | `'top' \| 'left' \| 'right' \| 'bottom' \| 'topLeft' \| 'topRight' \| 'bottomLeft' \| 'bottomRight' \| 'leftTop' \| 'leftBottom' \| 'rightTop' \| 'rightBottom'` | `'top'` | +| `[nzTrigger]` | Tooltip trigger mode | `'click' \| 'focus' \| 'hover'` | `'hover'` | | `[nzVisible]` | Whether the floating tooltip card is visible or not | `boolean` | `false` | | `(nzVisibleChange)` | Callback executed when visibility of the tooltip card is changed | `EventEmitter` | - | diff --git a/components/tooltip/doc/index.zh-CN.md b/components/tooltip/doc/index.zh-CN.md index 827df58269e..3cb654cf14f 100644 --- a/components/tooltip/doc/index.zh-CN.md +++ b/components/tooltip/doc/index.zh-CN.md @@ -27,7 +27,7 @@ import { NzToolTipModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzTitle]` | 提示文字 | `string|TemplateRef` | - | +| `[nzTitle]` | 提示文字 | `string \| TemplateRef` | - | ### 共同的 API @@ -39,8 +39,8 @@ import { NzToolTipModule } from 'ng-zorro-antd'; | `[nzMouseLeaveDelay]` | 鼠标移出后延时多少才隐藏 Tooltip,单位:秒 | `number` | `0.1` | | `[nzOverlayClassName]` | 卡片类名 | `string` | - | | `[nzOverlayStyle]` | 卡片样式 | `object` | - | -| `[nzPlacement]` | 气泡框位置 | `'top'|'left'|'right'|'bottom'|'topLeft'|'topRight'|'bottomLeft'|'bottomRight'|'leftTop'|'leftBottom'|'rightTop'|'rightBottom'` | `'top'` | -| `[nzTrigger]` | 触发行为,可选 `hover/focus/click` | `'click'|'focus'|'hover'` | `'hover'` | +| `[nzPlacement]` | 气泡框位置 | `'top' \| 'left' \| 'right' \| 'bottom' \| 'topLeft' \| 'topRight' \| 'bottomLeft' \| 'bottomRight' \| 'leftTop' \| 'leftBottom' \| 'rightTop' \| 'rightBottom'` | `'top'` | +| `[nzTrigger]` | 触发行为,可选 `hover/focus/click` | `'click' \| 'focus' \| 'hover'` | `'hover'` | | `[nzVisible]` | 用于手动控制浮层显隐 | `boolean` | `false` | | `(nzVisibleChange)` | 显示隐藏的回调 | `EventEmitter` | - | diff --git a/components/transfer/doc/index.en-US.md b/components/transfer/doc/index.en-US.md index c9dd2b8f534..7089212bdba 100644 --- a/components/transfer/doc/index.en-US.md +++ b/components/transfer/doc/index.en-US.md @@ -34,7 +34,7 @@ import { NzTransferModule } from 'ng-zorro-antd'; | `[nzListStyle]` | A custom CSS style used for rendering the transfer columns. equal `ngStyle` | `object` | - | | `[nzItemUnit]` | single unit | `string` | `'item'` | | `[nzItemsUnit]` | multiple unit | `string` | `'items'` | -| `[nzRenderList]` | Customize render list, please refer to the case. | `Array|null>` | `[null, null]` | +| `[nzRenderList]` | Customize render list, please refer to the case. | `Array \| null>` | `[null, null]` | | `[nzRender]` | The function to generate the item shown on a column. please refer to the case. | `TemplateRef` | - | | `[nzFooter]` | A function used for rendering the footer. please refer to the case. | `TemplateRef` | - | | `[nzShowSearch]` | If included, a search box is shown on each column. | `boolean` | `false` | @@ -52,7 +52,7 @@ import { NzTransferModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | | title | Used to display and search keyword | `string` | - | -| direction | Used for setting the source data. Except the elements whose keys are `direction: 'right'` prop. | `'left'|'right'` | - | +| direction | Used for setting the source data. Except the elements whose keys are `direction: 'right'` prop. | `'left' \| 'right'` | - | | disabled | specifies whether the checkbox is disabled | `boolean` | `false` | | checked | specifies whether the checkbox is selected | `boolean` | `false` | @@ -60,29 +60,29 @@ import { NzTransferModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| direction | data direction | `'left'|'right'` | - | +| direction | data direction | `'left' \| 'right'` | - | | list | Used for setting the source data. | `TransferItem[]` | `[]` | #### TransferChange | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| from | data direction | `'left'|'right'` | - | -| to | data direction | `'left'|'right'` | - | +| from | data direction | `'left' \| 'right'` | - | +| to | data direction | `'left' \| 'right'` | - | | list | Used for setting the source data. | `TransferItem[]` | `[]` | #### TransferSearchChange | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| direction | data direction | `'left'|'right'` | - | +| direction | data direction | `'left' \| 'right'` | - | | value | Search keyword | `string` | - | #### nzRenderList | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `direction` | List render direction | `'left'|'right'` | - | +| `direction` | List render direction | `'left' \| 'right'` | - | | `disabled` | Disable list or not | `boolean` | - | | `items` | Filtered items | `TransferItem[]` | - | | `onItemSelect` | Select item | `(item: TransferItem) => void` | - | diff --git a/components/transfer/doc/index.zh-CN.md b/components/transfer/doc/index.zh-CN.md index ad95ecdd0fd..f6ad54b1b1d 100644 --- a/components/transfer/doc/index.zh-CN.md +++ b/components/transfer/doc/index.zh-CN.md @@ -36,7 +36,7 @@ import { NzTransferModule } from 'ng-zorro-antd'; | `[nzListStyle]` | 两个穿梭框的自定义样式,等同 `ngStyle` | `object` | - | | `[nzItemUnit]` | 单数单位 | `string` | `'项目'` | | `[nzItemsUnit]` | 复数单位 | `string` | `'项目'` | -| `[nzRenderList]` | 自定义渲染列表,见示例 | `Array|null>` | `[null, null]` | +| `[nzRenderList]` | 自定义渲染列表,见示例 | `Array \| null>` | `[null, null]` | | `[nzRender]` | 每行数据渲染模板,见示例 | `TemplateRef` | - | | `[nzFooter]` | 底部渲染模板,见示例 | `TemplateRef` | - | | `[nzShowSearch]` | 是否显示搜索框 | `boolean` | `false` | @@ -54,7 +54,7 @@ import { NzTransferModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | title | 标题,用于显示及搜索关键字判断 | `string` | - | -| direction | 指定数据方向,若指定 `right` 为右栏,其他情况为左栏 | `'left'|'right'` | - | +| direction | 指定数据方向,若指定 `right` 为右栏,其他情况为左栏 | `'left' \| 'right'` | - | | disabled | 指定checkbox为不可用状态 | `boolean` | `false` | | checked | 指定checkbox为选中状态 | `boolean` | `false` | @@ -62,29 +62,29 @@ import { NzTransferModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| direction | 数据方向 | `'left'|'right'` | - | +| direction | 数据方向 | `'left' \| 'right'` | - | | list | 数据源 | `TransferItem[]` | `[]` | #### TransferChange | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| from | 数据方向 | `'left'|'right'` | - | -| to | 数据方向 | `'left'|'right'` | - | +| from | 数据方向 | `'left' \| 'right'` | - | +| to | 数据方向 | `'left' \| 'right'` | - | | list | 数据源 | `TransferItem[]` | `[]` | #### TransferSearchChange | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| direction | 数据方向 | `'left'|'right'` | - | +| direction | 数据方向 | `'left' \| 'right'` | - | | value | 搜索关键词 | `string` | - | #### nzRenderList | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `direction` | 渲染列表的方向 | `'left'|'right'` | - | +| `direction` | 渲染列表的方向 | `'left' \| 'right'` | - | | `disabled` | 是否禁用列表 | `boolean` | - | | `items` | 过滤后的数据 | `TransferItem[]` | - | | `onItemSelect` | 勾选条目 | `(item: TransferItem) => void` | - | diff --git a/components/tree-select/doc/index.en-US.md b/components/tree-select/doc/index.en-US.md index 4b6ca3542f2..96ce6275f0f 100755 --- a/components/tree-select/doc/index.en-US.md +++ b/components/tree-select/doc/index.en-US.md @@ -34,7 +34,7 @@ import { NzTreeSelectModule } from 'ng-zorro-antd'; | `[nzDropdownMatchSelectWidth]` | Determine whether the dropdown menu and the select input are the same width | `boolean` | `true` | | `[nzDropdownStyle]` | To set the style of the dropdown menu | `object` | - | | `[nzMultiple]` | Support multiple or not, will be `true` when enable `nzCheckable`. | `boolean` | `false` | -| `[nzSize]` | To set the size of the select input | `'large'|'small'|'default'` | `'default'` | +| `[nzSize]` | To set the size of the select input | `'large' \| 'small' \| 'default'` | `'default'` | | `[nzCheckable]` | Whether to show checkbox on the treeNodes | `boolean` | `false` | | `[nzShowExpand]` | Show a Expand Icon before the treeNodes | `boolean` | `true` | | `[nzShowLine]` | Shows a connecting line | `boolean` | `false` | diff --git a/components/tree-select/doc/index.zh-CN.md b/components/tree-select/doc/index.zh-CN.md index 1c476a6d305..b3b44b10e88 100755 --- a/components/tree-select/doc/index.zh-CN.md +++ b/components/tree-select/doc/index.zh-CN.md @@ -34,7 +34,7 @@ import { NzTreeSelectModule } from 'ng-zorro-antd'; | `[nzDropdownMatchSelectWidth]` | 下拉菜单和选择器同宽 | `boolean` | `true` | | `[nzDropdownStyle]` | 下拉菜单的样式 | `{ [key: string]: string; }` | - | | `[nzMultiple]` | 支持多选(当设置 nzCheckable 时自动变为true) | `boolean` | `false` | -| `[nzSize]` | 选择框大小 | `'large'|'small'|'default'` | `'default'` | +| `[nzSize]` | 选择框大小 | `'large' \| 'small' \| 'default'` | `'default'` | | `[nzCheckable]` | 节点前添加 Checkbox 复选框 | `boolean` | `false` | | `[nzShowExpand]` | 节点前添加展开图标 | `boolean` | `true` | | `[nzShowLine]` | 是否展示连接线 | `boolean` | `false` | diff --git a/components/tree/doc/index.en-US.md b/components/tree/doc/index.en-US.md index 57c93d856e7..9e72bd2f428 100644 --- a/components/tree/doc/index.en-US.md +++ b/components/tree/doc/index.en-US.md @@ -22,7 +22,7 @@ import { NzTreeModule } from 'ng-zorro-antd'; | Property | Description | Type | Default | | -------- | ----------- | ---- | ------- | -| `[nzData]` | Tree data (Reference NzTreeNode) | `NzTreeNodeOptions[]|NzTreeNode[]` | `[]` | +| `[nzData]` | Tree data (Reference NzTreeNode) | `NzTreeNodeOptions[] \| NzTreeNode[]` | `[]` | | `[nzBlockNode]` | Whether treeNode fill remaining horizontal space | `boolean` | `false` | | `[nzCheckable]` | Adds a Checkbox before the treeNodes| `boolean` | `false` | | `[nzShowExpand]` | Show a Expand Icon before the treeNodes | `boolean` | `true` | @@ -88,7 +88,7 @@ import { NzTreeModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | eventName | Event Name | enum: `click` `dblclick` `contextmenu` `check` `expand` `search` & `dragstart` `dragenter` `dragover` `dragleave` `drop` `dragend` | - | | node | The current operation node (such as the target node to drop while dragging) | `NzTreeNode` | `null` | -| event | MouseEvent or DragEvent | `'MouseEvent'|'DragEvent'` | `null` | +| event | MouseEvent or DragEvent | `'MouseEvent' \| 'DragEvent'` | `null` | | dragNode? | Current drag node (existing if dragged) | `NzTreeNode` | `null` | | selectedKeys? | Selected nodes list | `NzTreeNode[]` | `[]` | | checkedKeys? | Checked nodes list | `NzTreeNode[]` | `[]` | diff --git a/components/tree/doc/index.zh-CN.md b/components/tree/doc/index.zh-CN.md index 33c0fe17ebd..141ee4817e1 100644 --- a/components/tree/doc/index.zh-CN.md +++ b/components/tree/doc/index.zh-CN.md @@ -23,7 +23,7 @@ import { NzTreeModule } from 'ng-zorro-antd'; | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | -| `[nzData]` | 元数据 | `NzTreeNodeOptions[]|NzTreeNode[]` | `[]` | +| `[nzData]` | 元数据 | `NzTreeNodeOptions[] \| NzTreeNode[]` | `[]` | | `[nzBlockNode]` | 是否节点占据一行 | `boolean` | `false` | | `[nzCheckable]` | 节点前添加 Checkbox 复选框 | `boolean` | `false` | | `[nzShowExpand]` | 节点前添加展开图标 | `boolean` | `true` | @@ -90,7 +90,7 @@ import { NzTreeModule } from 'ng-zorro-antd'; | --- | --- | --- | --- | | eventName | 事件名 | enum: `click` `dblclick` `contextmenu` `check` `expand` `search` & `dragstart` `dragenter` `dragover` `dragleave` `drop` `dragend` | - | | node | 当前操作节点(拖拽时表示目标节点) | `NzTreeNode` | `null` | -| event | 原生事件 | `'MouseEvent'|'DragEvent'` | `null` | +| event | 原生事件 | `'MouseEvent' \| 'DragEvent'` | `null` | | dragNode? | 当前拖拽节点(拖拽时存在) | `NzTreeNode` | `null` | | selectedKeys? | 已选中的节点key(单击时存在) | `NzTreeNode[]` | `[]` | | checkedKeys? | checkBox 已选中的节点key(点击 checkBox 存在) | `NzTreeNode[]` | `[]` | diff --git a/components/upload/doc/index.en-US.md b/components/upload/doc/index.en-US.md index 8d65480cf66..c90289c2cd6 100644 --- a/components/upload/doc/index.en-US.md +++ b/components/upload/doc/index.en-US.md @@ -33,25 +33,25 @@ import { NzUploadModule } from 'ng-zorro-antd'; | `[nzAccept]` | File types that can be accepted. See [input accept Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-accept) | `string` | - | | `[nzAction]` | Required. Uploading URL | `string` | - | | `[nzDirectory]` | support upload whole directory ([caniuse](https://caniuse.com/#feat=input-file-directory)) | `boolean` | `false` | -| `[nzBeforeUpload]` | Hook function which will be executed before uploading. Uploading will be stopped with `false` or a Observable. **Warning:this function is not supported in IE9**. NOTICE: Muse be use `=>` to define the method. | `(file: UploadFile, fileList: UploadFile[]) => boolean|Observable` | - | +| `[nzBeforeUpload]` | Hook function which will be executed before uploading. Uploading will be stopped with `false` or a Observable. **Warning:this function is not supported in IE9**. NOTICE: Muse be use `=>` to define the method. | `(file: UploadFile, fileList: UploadFile[]) => boolean \| Observable` | - | | `[nzCustomRequest]` | override for the default xhr behavior allowing for additional customization and ability to implement your own XMLHttpRequest. NOTICE: Muse be use `=>` to define the method. | `(item) => Subscription` | - | -| `[nzData]` | Uploading params or function which can return uploading params. NOTICE: Muse be use `=>` to define the method. | `Object|((file: UploadFile) => Object)` | - | +| `[nzData]` | Uploading params or function which can return uploading params. NOTICE: Muse be use `=>` to define the method. | `Object \| ((file: UploadFile) => Object)` | - | | `[nzDisabled]` | disable upload button | `boolean` | `false` | | `[nzFileList]` | List of files, two-way data-binding | `UploadFile[]` | - | | `[nzLimit]` | limit single upload count when `nzMultiple` has opened. `0` unlimited | `number` | `0` | | `[nzSize]` | limit file size (KB). `0` unlimited | `number` | `0` | | `[nzFileType]` | limit file type, e.g: `image/png,image/jpeg,image/gif,image/bmp` | `string` | - | | `[nzFilter]` | Custom filter when choosed file | `UploadFilter[]` | - | -| `[nzHeaders]` | Set request headers, valid above IE10. NOTICE: Muse be use `=>` to define the method. | `Object|((file: UploadFile) => Object)` | - | -| `[nzListType]` | Built-in stylesheets, support for three types: `text`, `picture` or `picture-card` | `'text'|'picture'|'picture-card'` | `'text'` | +| `[nzHeaders]` | Set request headers, valid above IE10. NOTICE: Muse be use `=>` to define the method. | `Object \| ((file: UploadFile) => Object)` | - | +| `[nzListType]` | Built-in stylesheets, support for three types: `text`, `picture` or `picture-card` | `'text' \| 'picture' \| 'picture-card'` | `'text'` | | `[nzMultiple]` | Whether to support selected multiple file. `IE10+` supported. You can select multiple files with CTRL holding down while multiple is set to be true | `boolean` | `false` | | `[nzName]` | The name of uploading file | `string` | `'file'` | -| `[nzShowUploadList]` | Whether to show default upload list, could be an object to specify `showPreviewIcon` and `showRemoveIcon` individually | `boolean|{ showPreviewIcon?: boolean, showRemoveIcon?: boolean }` | `true` | +| `[nzShowUploadList]` | Whether to show default upload list, could be an object to specify `showPreviewIcon` and `showRemoveIcon` individually | `boolean \| { showPreviewIcon?: boolean, showRemoveIcon?: boolean }` | `true` | | `[nzShowButton]` | Show upload button | `boolean` | `true` | | `[nzWithCredentials]` | ajax upload with cookie sent | `boolean` | `false` | | `[nzOpenFileDialogOnClick]` | click open file dialog | `boolean` | `true` | | `[nzPreview]` | A callback function, will be executed when file link or preview icon is clicked. NOTICE: Muse be use `=>` to define the method. | `(file: UploadFile) => void` | - | -| `[nzRemove]` | A callback function, will be executed when removing file button is clicked, remove event will be prevented when return value is `false` or a Observable. NOTICE: Muse be use `=>` to define the method. | `(file: UploadFile) => boolean|Observable` | - | +| `[nzRemove]` | A callback function, will be executed when removing file button is clicked, remove event will be prevented when return value is `false` or a Observable. NOTICE: Muse be use `=>` to define the method. | `(file: UploadFile) => boolean \| Observable` | - | | `(nzChange)` | A callback function, can be executed when uploading state is changing | `EventEmitter` | - | #### nzChange diff --git a/components/upload/doc/index.zh-CN.md b/components/upload/doc/index.zh-CN.md index de2d3595a65..5fd33e061b3 100644 --- a/components/upload/doc/index.zh-CN.md +++ b/components/upload/doc/index.zh-CN.md @@ -34,25 +34,25 @@ import { NzUploadModule } from 'ng-zorro-antd'; | `[nzAccept]` | 接受上传的文件类型, 详见 [input accept Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-accept) | `string` | - | | `[nzAction]` | 必选参数, 上传的地址 | `string` | - | | `[nzDirectory]` | 支持上传文件夹([caniuse](https://caniuse.com/#feat=input-file-directory)) | `boolean` | `false` | -| `[nzBeforeUpload]` | 上传文件之前的钩子,参数为上传的文件,若返回 `false` 则停止上传。注意:**IE9** 不支持该方法;注意:务必使用 `=>` 定义处理方法。 | `(file: UploadFile, fileList: UploadFile[]) => boolean|Observable` | - | +| `[nzBeforeUpload]` | 上传文件之前的钩子,参数为上传的文件,若返回 `false` 则停止上传。注意:**IE9** 不支持该方法;注意:务必使用 `=>` 定义处理方法。 | `(file: UploadFile, fileList: UploadFile[]) => boolean \| Observable` | - | | `[nzCustomRequest]` | 通过覆盖默认的上传行为,可以自定义自己的上传实现;注意:务必使用 `=>` 定义处理方法。 | `(item) => Subscription` | - | -| `[nzData]` | 上传所需参数或返回上传参数的方法;注意:务必使用 `=>` 定义处理方法。 | `Object|((file: UploadFile) => Object)` | - | +| `[nzData]` | 上传所需参数或返回上传参数的方法;注意:务必使用 `=>` 定义处理方法。 | `Object \| ((file: UploadFile) => Object)` | - | | `[nzDisabled]` | 是否禁用 | `boolean` | `false` | | `[nzFileList]` | 文件列表,双向绑定 | `UploadFile[]` | - | | `[nzLimit]` | 限制单次最多上传数量,`nzMultiple` 打开时有效;`0` 表示不限 | `number` | `0` | | `[nzSize]` | 限制文件大小,单位:KB;`0` 表示不限 | `number` | `0` | | `[nzFileType]` | 限制文件类型,例如:`image/png,image/jpeg,image/gif,image/bmp` | `string` | - | | `[nzFilter]` | 自定义过滤器 | `UploadFilter[]` | - | -| `[nzHeaders]` | 设置上传的请求头部,IE10 以上有效;注意:务必使用 `=>` 定义处理方法。 | `Object|((file: UploadFile) => Object)` | - | -| `[nzListType]` | 上传列表的内建样式,支持三种基本样式 `text`, `picture` 和 `picture-card` | `'text'|'picture'|'picture-card'` | `'text'` | +| `[nzHeaders]` | 设置上传的请求头部,IE10 以上有效;注意:务必使用 `=>` 定义处理方法。 | `Object \| ((file: UploadFile) => Object)` | - | +| `[nzListType]` | 上传列表的内建样式,支持三种基本样式 `text`, `picture` 和 `picture-card` | `'text' \| 'picture' \| 'picture-card'` | `'text'` | | `[nzMultiple]` | 是否支持多选文件,`ie10+` 支持。开启后按住 ctrl 可选择多个文件。 | `boolean` | `false` | | `[nzName]` | 发到后台的文件参数名 | `string` | `'file'` | -| `[nzShowUploadList]` | 是否展示 uploadList, 可设为一个对象,用于单独设定 showPreviewIcon 和 showRemoveIcon | `boolean|{ showPreviewIcon?: boolean, showRemoveIcon?: boolean }` | `true` | +| `[nzShowUploadList]` | 是否展示 uploadList, 可设为一个对象,用于单独设定 showPreviewIcon 和 showRemoveIcon | `boolean \| { showPreviewIcon?: boolean, showRemoveIcon?: boolean }` | `true` | | `[nzShowButton]` | 是否展示上传按钮 | `boolean` | `true` | | `[nzWithCredentials]` | 上传请求时是否携带 cookie | `boolean` | `false` | | `[nzOpenFileDialogOnClick]` | 点击打开文件对话框 | `boolean` | `true` | | `[nzPreview]` | 点击文件链接或预览图标时的回调;注意:务必使用 `=>` 定义处理方法。 | `(file: UploadFile) => void` | - | -| `[nzRemove]` | 点击移除文件时的回调,返回值为 false 时不移除。支持返回 `Observable` 对象;注意:务必使用 `=>` 定义处理方法。 | `(file: UploadFile) => boolean|Observable` | - | +| `[nzRemove]` | 点击移除文件时的回调,返回值为 false 时不移除。支持返回 `Observable` 对象;注意:务必使用 `=>` 定义处理方法。 | `(file: UploadFile) => boolean \| Observable` | - | | `(nzChange)` | 上传文件改变时的状态 | `EventEmitter` | - | #### nzChange