docs: update interface split in markdown

NG-ZORRO · Jun 22, 2019 · 7418263 · 7418263
1 parent b2ffd9e
commit 7418263
Show file tree

Hide file tree

Showing 101 changed files with 423 additions and 423 deletions.
diff --git 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<boolean>` | - |
 
 **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
@@ -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<boolean>` | - |
 
 **注意：**`nz-affix` 内的元素不要使用绝对定位，如需要绝对定位的效果，可以直接设置 `nz-affix` 为绝对定位：

diff --git 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<void>` | - |
-| `[nzDescription]` | Additional content of Alert | `string｜TemplateRef<void>` | - |
-| `[nzMessage]` | Content of Alert | `string｜TemplateRef<void>` | - |
+| `[nzCloseText]` | Close text to show | `string \| TemplateRef<void>` | - |
+| `[nzDescription]` | Additional content of Alert | `string \| TemplateRef<void>` | - |
+| `[nzMessage]` | Content of Alert | `string \| TemplateRef<void>` | - |
 | `[nzShowIcon]` | Whether to show icon, in `nzBanner` mode default is `true` | `boolean` | `false` |
-| `[nzIconType]` | Icon type, effective when `nzShowIcon` is `true` | `string｜string[]｜Set<string>｜{ [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<string> \| { [klass: string]: any; }` | - |
+| `[nzType]` | Type of Alert styles, in `nzBanner` mode default is `'warning'` | `'success' \| 'info' \| 'warning' \| 'error'` | `'info'` |
 | `(nzOnClose)` | Callback when Alert is closed | `EventEmitter<void>` | - |
diff --git 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<void>` | - |
-| `[nzDescription]` | 警告提示的辅助性文字介绍 | `string｜TemplateRef<void>` | - |
-| `[nzMessage]` | 警告提示内容 | `string｜TemplateRef<void>` | - |
+| `[nzCloseText]` | 自定义关闭按钮 | `string \| TemplateRef<void>` | - |
+| `[nzDescription]` | 警告提示的辅助性文字介绍 | `string \| TemplateRef<void>` | - |
+| `[nzMessage]` | 警告提示内容 | `string \| TemplateRef<void>` | - |
 | `[nzShowIcon]` | 是否显示辅助图标，`nzBanner` 模式下默认值为 `true` | `boolean` | `false` |
-| `[nzIconType]` | 自定义图标类型，`nzShowIcon` 为 `true` 时有效 | `string｜string[]｜Set<string>｜{ [klass: string]: any; }` | - |
-| `[nzType]` | 指定警告提示的样式，`nzBanner` 模式下默认值为 `'warning'` | `'success'｜'info'｜'warning'｜'error'` | `'info'` |
+| `[nzIconType]` | 自定义图标类型，`nzShowIcon` 为 `true` 时有效 | `string \| string[] \| Set<string> \| { [klass: string]: any; }` | - |
+| `[nzType]` | 指定警告提示的样式，`nzBanner` 模式下默认值为 `'warning'` | `'success' \| 'info' \| 'warning' \| 'error'` | `'info'` |
 | `(nzOnClose)` | 关闭时触发的回调函数 | `EventEmitter<void>` | - |
diff --git 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<string>` | - |
 | `(nzScroll)` | The scroll function that is triggered when scrolling to an anchor. | `EventEmitter<NzAnchorLinkComponent>` | - |
 
@@ -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<void>` | - |
+| `[nzTitle]` | content of  hyperlink | `string \| TemplateRef<void>` | - |
diff --git 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<string>` | - |
 | `(nzScroll)` | 滚动至某锚点时触发 | `EventEmitter<NzAnchorLinkComponent>` | - |
 
@@ -39,4 +39,4 @@ import { NzAnchorModule } from 'ng-zorro-antd';
 | 成员 | 说明 | 类型 | 默认值 |
 | --- | --- | --- | --- |
 | `[nzHref]` | 锚点链接 | `string` | - |
-| `[nzTitle]` | 文字内容 | `string｜TemplateRef<void>` | - |
+| `[nzTitle]` | 文字内容 | `string \| TemplateRef<void>` | - |
diff --git 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
@@ -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
@@ -30,6 +30,6 @@ import { NzBackTopModule } from 'ng-zorro-antd';
 | --- | --- | --- | --- |
 | `[nzTemplate]` | custom content | `TemplateRef<void>` | - |
 | `[nzVisibilityHeight]` | the `nz-back-top` button will not show until the scroll height reaches this value | `number` | `400` |
-| `[nzTarget]` | specifies the scrollable area dom node | `string｜Element` | `window` |
+| `[nzTarget]` | specifies the scrollable area dom node | `string \| Element` | `window` |
 | `(nzClick)` | a callback function, which can be executed when you click the button | `EventEmitter<boolean>` | - |
 
diff --git 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<void>` | - |
 | `[nzVisibilityHeight]` | 滚动高度达到此参数值才出现 `nz-back-top` | `number` | `400` |
-| `[nzTarget]` | 设置需要监听其滚动事件的元素，值为一个返回对应 DOM 元素的函数 | `string｜Element` | `window` |
+| `[nzTarget]` | 设置需要监听其滚动事件的元素，值为一个返回对应 DOM 元素的函数 | `string \| Element` | `window` |
 | `(nzClick)` | 点击按钮的回调函数 | `EventEmitter<boolean>` | - |
diff --git 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<void>` | - |
+| `[nzCount]` | Number to show in badge | `number \| TemplateRef<void>` | - |
 | `[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
@@ -36,10 +36,10 @@ import { NzBadgeModule } from 'ng-zorro-antd';
 | 参数 | 说明 | 类型 | 默认值 |
 | --- | --- | --- | --- |
 | `[nzColor]` | 自定义小圆点的颜色 | string | - |
-| `[nzCount]` | 展示的数字，大于 nzOverflowCount 时显示为 `${nzOverflowCount}+`，为 0 时隐藏 | `number｜TemplateRef<void>` | - |
+| `[nzCount]` | 展示的数字，大于 nzOverflowCount 时显示为 `${nzOverflowCount}+`，为 0 时隐藏 | `number \| TemplateRef<void>` | - |
 | `[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
@@ -27,7 +27,7 @@ import { NzBreadCrumbModule } from 'ng-zorro-antd';
 
 | Property | Description | Type | Default |
 | -------- | ----------- | ---- | ------- |
-| `[nzSeparator]` | Custom separator | `string｜TemplateRef<void>` | `'/'` |
+| `[nzSeparator]` | Custom separator | `string \| TemplateRef<void>` | `'/'` |
 | `[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
@@ -27,7 +27,7 @@ import { NzBreadCrumbModule } from 'ng-zorro-antd';
 
 | 参数 | 说明 | 类型 | 默认值 |
 | --- | --- | --- | --- |
-| `[nzSeparator]` | 分隔符自定义 | `string｜TemplateRef<void>` | `'/'` |
+| `[nzSeparator]` | 分隔符自定义 | `string \| TemplateRef<void>` | `'/'` |
 | `[nzAutoGenerate]` | 自动生成 Breadcrumb | `boolean` | `false` |
 
 使用 `[nzAutoGenerate]` 时，需要在路由类中定义 `data`:

diff --git 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
@@ -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
@@ -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<Date>` | - |
 | `[nzDateFullCell]` | (Contentable) Customize the display of the date cell, the template content will override the cell | `TemplateRef<Date>` | - |
 | `[nzMonthCell]` | (Contentable) Customize the display of the month cell, the template content will be appended to the cell | `TemplateRef<Date>` | - |
 | `[nzMonthFullCell]` | (Contentable) Customize the display of the month cell, the template content will override the cell | `TemplateRef<Date>` | - |
-| `(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
@@ -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<Date>` | - |
 | `[nzDateFullCell]` | （可作为内容）自定义渲染日期单元格，模版内容覆盖单元格 | `TemplateRef<Date>` | - |
 | `[nzMonthCell]` | （可作为内容）自定义渲染月单元格，模版内容会被追加到单元格 | `TemplateRef<Date>` | - |
 | `[nzMonthFullCell]` | （可作为内容）自定义渲染月单元格，模版内容覆盖单元格 | `TemplateRef<Date>` | - |
-| `(nzPanelChange)` | 面板变化的回调 | `EventEmitter<{ date: Date, mode: 'month'｜'year' }>` | - |
+| `(nzPanelChange)` | 面板变化的回调 | `EventEmitter<{ date: Date, mode: 'month' \| 'year' }>` | - |
 | `(nzSelectChange)` | 选择日期的回调 | `EventEmitter<Date>` | - |
diff --git a/components/card/doc/index.en-US.md b/components/card/doc/index.en-US.md
@@ -33,21 +33,21 @@ 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<void>` | - |
-| `[nzExtra]` | Content to render in the top-right corner of the card | `string｜TemplateRef<void>` | - |
+| `[nzExtra]` | Content to render in the top-right corner of the card | `string \| TemplateRef<void>` | - |
 | `[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<void>` | - |
+| `[nzTitle]` | Card title | `string \| TemplateRef<void>` | - |
 | `[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
 
 | Property | Description | Type | Default |
 | -------- | ----------- | ---- | ------- |
 | `[nzAvatar]` | avatar or icon | `TemplateRef<void>` | - |
-| `[nzDescription]` | description content | `string｜TemplateRef<void>` | - |
-| `[nzTitle]` | title content | `string｜TemplateRef<void>` | - |
+| `[nzDescription]` | description content | `string \| TemplateRef<void>` | - |
+| `[nzTitle]` | title content | `string \| TemplateRef<void>` | - |
 
 ### [nz-card-grid]
 Area for grid style card