From 90550fe99ff8778e8b98f056b4de8c853f2793d8 Mon Sep 17 00:00:00 2001 From: Wendell Date: Sat, 22 Jun 2019 18:57:11 +0800 Subject: [PATCH] docs: update docs (#3625) * docs: update docs * docs: add api link to toc * fix: link * fix: link --- components/affix/doc/index.en-US.md | 8 +- components/affix/doc/index.zh-CN.md | 9 +- components/alert/doc/index.en-US.md | 8 +- components/alert/doc/index.zh-CN.md | 8 +- components/anchor/doc/index.en-US.md | 8 +- components/anchor/doc/index.zh-CN.md | 9 +- components/auto-complete/doc/index.en-US.md | 16 ++-- components/auto-complete/doc/index.zh-CN.md | 16 ++-- components/avatar/doc/index.en-US.md | 8 +- components/avatar/doc/index.zh-CN.md | 8 +- components/back-top/doc/index.en-US.md | 8 +- components/back-top/doc/index.zh-CN.md | 8 +- components/badge/doc/index.en-US.md | 16 ++-- components/badge/doc/index.zh-CN.md | 16 ++-- components/breadcrumb/doc/index.en-US.md | 8 +- components/breadcrumb/doc/index.zh-CN.md | 8 +- components/button/doc/index.en-US.md | 8 +- components/button/doc/index.zh-CN.md | 8 +- components/calendar/doc/index.en-US.md | 17 ++-- components/calendar/doc/index.zh-CN.md | 16 ++-- components/card/doc/index.en-US.md | 16 ++-- components/card/doc/index.zh-CN.md | 16 ++-- components/carousel/doc/index.en-US.md | 8 +- components/carousel/doc/index.zh-CN.md | 8 +- components/cascader/doc/index.en-US.md | 16 ++-- components/cascader/doc/index.zh-CN.md | 16 ++-- components/checkbox/doc/index.en-US.md | 8 +- components/checkbox/doc/index.zh-CN.md | 8 +- components/collapse/doc/index.en-US.md | 8 +- components/collapse/doc/index.zh-CN.md | 8 +- components/comment/doc/index.en-US.md | 16 ++-- components/comment/doc/index.zh-CN.md | 16 ++-- components/date-picker/doc/index.en-US.md | 16 ++-- components/date-picker/doc/index.zh-CN.md | 16 ++-- components/descriptions/doc/index.en-US.md | 16 ++-- components/descriptions/doc/index.zh-CN.md | 16 ++-- components/divider/doc/index.en-US.md | 8 +- components/divider/doc/index.zh-CN.md | 8 +- components/drawer/doc/index.en-US.md | 8 +- components/drawer/doc/index.zh-CN.md | 10 +- components/dropdown/doc/index.en-US.md | 8 +- components/dropdown/doc/index.zh-CN.md | 8 +- components/empty/doc/index.en-US.md | 8 +- components/empty/doc/index.zh-CN.md | 8 +- components/form/doc/index.en-US.md | 9 +- components/form/doc/index.zh-CN.md | 8 +- components/grid/doc/index.en-US.md | 8 +- components/grid/doc/index.zh-CN.md | 8 +- components/icon/doc/index.en-US.md | 8 +- components/icon/doc/index.zh-CN.md | 8 +- components/input-number/doc/index.en-US.md | 8 +- components/input-number/doc/index.zh-CN.md | 10 +- components/input/doc/index.en-US.md | 8 +- components/input/doc/index.zh-CN.md | 8 +- components/layout/doc/index.en-US.md | 16 ++-- components/layout/doc/index.zh-CN.md | 16 ++-- components/list/doc/index.en-US.md | 8 +- components/list/doc/index.zh-CN.md | 8 +- components/mention/doc/index.en-US.md | 16 ++-- components/mention/doc/index.zh-CN.md | 16 ++-- components/menu/doc/index.en-US.md | 16 ++-- components/menu/doc/index.zh-CN.md | 16 ++-- components/message/doc/index.en-US.md | 16 ++-- components/message/doc/index.zh-CN.md | 16 ++-- components/modal/doc/index.en-US.md | 8 +- components/modal/doc/index.zh-CN.md | 8 +- components/notification/doc/index.en-US.md | 16 ++-- components/notification/doc/index.zh-CN.md | 16 ++-- components/page-header/doc/index.en-US.md | 16 ++-- components/page-header/doc/index.zh-CN.md | 16 ++-- components/pagination/doc/index.en-US.md | 16 ++-- components/pagination/doc/index.zh-CN.md | 16 ++-- components/popconfirm/doc/index.en-US.md | 8 +- components/popconfirm/doc/index.zh-CN.md | 8 +- components/popover/doc/index.en-US.md | 8 +- components/popover/doc/index.zh-CN.md | 8 +- components/progress/doc/index.en-US.md | 8 +- components/progress/doc/index.zh-CN.md | 8 +- components/radio/doc/index.en-US.md | 8 +- components/radio/doc/index.zh-CN.md | 8 +- components/rate/doc/index.en-US.md | 8 +- components/rate/doc/index.zh-CN.md | 8 +- components/select/doc/index.en-US.md | 16 ++-- components/select/doc/index.zh-CN.md | 16 ++-- components/skeleton/doc/index.en-US.md | 8 +- components/skeleton/doc/index.zh-CN.md | 9 +- components/slider/doc/index.en-US.md | 8 +- components/slider/doc/index.zh-CN.md | 8 +- components/spin/doc/index.en-US.md | 8 +- components/spin/doc/index.zh-CN.md | 8 +- components/statistic/doc/index.en-US.md | 8 +- components/statistic/doc/index.zh-CN.md | 8 +- components/steps/doc/index.en-US.md | 16 ++-- components/steps/doc/index.zh-CN.md | 16 ++-- components/switch/doc/index.en-US.md | 8 +- components/switch/doc/index.zh-CN.md | 8 +- components/table/doc/index.en-US.md | 16 ++-- components/table/doc/index.zh-CN.md | 16 ++-- components/tabs/doc/index.en-US.md | 10 +- components/tabs/doc/index.zh-CN.md | 8 +- components/tag/doc/index.en-US.md | 8 +- components/tag/doc/index.zh-CN.md | 8 +- components/time-picker/doc/index.en-US.md | 16 ++-- components/time-picker/doc/index.zh-CN.md | 16 ++-- components/timeline/doc/index.en-US.md | 16 ++-- components/timeline/doc/index.zh-CN.md | 16 ++-- components/tooltip/doc/index.en-US.md | 8 +- components/tooltip/doc/index.zh-CN.md | 8 +- components/transfer/doc/index.en-US.md | 8 +- components/transfer/doc/index.zh-CN.md | 8 +- components/tree-select/doc/index.en-US.md | 8 +- components/tree-select/doc/index.zh-CN.md | 8 +- components/tree/doc/index.en-US.md | 8 +- components/tree/doc/index.zh-CN.md | 8 +- components/upload/doc/index.en-US.md | 12 +-- components/upload/doc/index.zh-CN.md | 12 +-- docs/getting-started.en-US.md | 2 +- docs/getting-started.zh-CN.md | 2 +- ngsw-config.json | 2 +- scripts/site/_site/doc/app/app.component.html | 93 +++++++++++++++---- scripts/site/utils/generate-demo.js | 1 + 121 files changed, 712 insertions(+), 655 deletions(-) diff --git a/components/affix/doc/index.en-US.md b/components/affix/doc/index.en-US.md index 77e2928ab00..afe2baed7b4 100755 --- a/components/affix/doc/index.en-US.md +++ b/components/affix/doc/index.en-US.md @@ -12,16 +12,16 @@ When user browses a long web page, some content need to stick to the viewport. T Please note that Affix should not cover other content on the page, especially when the size of the viewport is small. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzAffixModule } from 'ng-zorro-antd'; +import { NzAffixModule } from 'ng-zorro-antd/affix'; ``` +## API + ### nz-affix | Property | Description | Type | Default | diff --git a/components/affix/doc/index.zh-CN.md b/components/affix/doc/index.zh-CN.md index 2910f19499d..7697f9bdb2b 100755 --- a/components/affix/doc/index.zh-CN.md +++ b/components/affix/doc/index.zh-CN.md @@ -13,16 +13,17 @@ title: Affix 页面可视范围过小时，慎用此功能以免遮挡页面内容。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzAffixModule } from 'ng-zorro-antd'; +import { NzAffixModule } from 'ng-zorro-antd/affix'; ``` +## API + + ### nz-affix | 成员 | 说明 | 类型 | 默认值 | diff --git a/components/alert/doc/index.en-US.md b/components/alert/doc/index.en-US.md index 551cd7f0cc3..ce44427e375 100644 --- a/components/alert/doc/index.en-US.md +++ b/components/alert/doc/index.en-US.md @@ -11,16 +11,16 @@ Alert component for feedback. - When you need to show alert messages to users. - When you need a persistent static container which is closable by user actions. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzAlertModule } from 'ng-zorro-antd'; +import { NzAlertModule } from 'ng-zorro-antd/alert'; ``` +## API + ### nz-alert | Property | Description | Type | Default | diff --git a/components/alert/doc/index.zh-CN.md b/components/alert/doc/index.zh-CN.md index 179ba5bf61e..613ef85740a 100644 --- a/components/alert/doc/index.zh-CN.md +++ b/components/alert/doc/index.zh-CN.md @@ -12,16 +12,16 @@ title: Alert - 当某个页面需要向用户显示警告的信息时。 - 非浮层的静态展现形式，始终展现，不会自动消失，用户可以点击关闭。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzAlertModule } from 'ng-zorro-antd'; +import { NzAlertModule } from 'ng-zorro-antd/alert'; ``` +## API + ### nz-alert | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/anchor/doc/index.en-US.md b/components/anchor/doc/index.en-US.md index 5d319be4b05..c86595849f5 100755 --- a/components/anchor/doc/index.en-US.md +++ b/components/anchor/doc/index.en-US.md @@ -10,16 +10,16 @@ Hyperlinks to scroll on one page. For displaying anchor hyperlinks on page and jumping between them. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzAnchorModule } from 'ng-zorro-antd'; +import { NzAnchorModule } from 'ng-zorro-antd/anchor'; ``` +## API + ### nz-anchor | Property | Description | Type | Default | diff --git a/components/anchor/doc/index.zh-CN.md b/components/anchor/doc/index.zh-CN.md index 9916b1dc46c..390487af7f5 100755 --- a/components/anchor/doc/index.zh-CN.md +++ b/components/anchor/doc/index.zh-CN.md @@ -11,16 +11,17 @@ title: Anchor 需要展现当前页面上可供跳转的锚点链接，以及快速在锚点之间跳转。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzAnchorModule } from 'ng-zorro-antd'; +import { NzAnchorModule } from 'ng-zorro-antd/anchor'; ``` + +## API + ### nz-anchor | 成员 | 说明 | 类型 | 默认值 | diff --git a/components/auto-complete/doc/index.en-US.md b/components/auto-complete/doc/index.en-US.md index d5e57f4e5ea..376f9a55494 100644 --- a/components/auto-complete/doc/index.en-US.md +++ b/components/auto-complete/doc/index.en-US.md @@ -10,6 +10,14 @@ Autocomplete function of input field. When there is a need for autocomplete functionality. +## Import this Component Individually + +You can get more detail [here](/docs/getting-started/en#import-a-component-individually). + +```ts +import { NzAutocompleteModule } from 'ng-zorro-antd/auto-complete'; +``` + ## API ```html @@ -26,14 +34,6 @@ When there is a need for autocomplete functionality. ``` -### Import this Component Individually - -You can get more detail [here](/docs/getting-started/en#import-a-component-individually). - -```ts -import { NzAutocompleteModule } from 'ng-zorro-antd'; -``` - ### [nzAutocomplete] | Property | Description | Type | Default | diff --git a/components/auto-complete/doc/index.zh-CN.md b/components/auto-complete/doc/index.zh-CN.md index 3234aaaa557..c1d0fcbd73c 100644 --- a/components/auto-complete/doc/index.zh-CN.md +++ b/components/auto-complete/doc/index.zh-CN.md @@ -11,6 +11,14 @@ subtitle: 自动完成 需要自动完成时。 +## 单独引入此组件 + +想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 + +```ts +import { NzAutocompleteModule } from 'ng-zorro-antd/auto-complete'; +``` + ## API ```html @@ -27,14 +35,6 @@ subtitle: 自动完成 ``` -### 单独引入此组件 - -想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 - -```ts -import { NzAutocompleteModule } from 'ng-zorro-antd'; -``` - ### [nzAutocomplete] | 属性 | 说明 | 类型 | 默认值 | diff --git a/components/avatar/doc/index.en-US.md b/components/avatar/doc/index.en-US.md index bb4f20e0f86..a8334f20562 100644 --- a/components/avatar/doc/index.en-US.md +++ b/components/avatar/doc/index.en-US.md @@ -6,16 +6,16 @@ title: Avatar Avatars can be used to represent people or objects. It supports images, `Icon`s, or letters. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzAvatarModule } from 'ng-zorro-antd'; +import { NzAvatarModule } from 'ng-zorro-antd/avatar'; ``` +## API + ### nz-avatar | Property | Description | Type | Default | diff --git a/components/avatar/doc/index.zh-CN.md b/components/avatar/doc/index.zh-CN.md index f90a3081c2a..362603fc0de 100644 --- a/components/avatar/doc/index.zh-CN.md +++ b/components/avatar/doc/index.zh-CN.md @@ -7,16 +7,16 @@ title: Avatar 用来代表用户或事物，支持图片、图标或字符展示。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzAvatarModule } from 'ng-zorro-antd'; +import { NzAvatarModule } from 'ng-zorro-antd/avatar'; ``` +## API + ### nz-avatar | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/back-top/doc/index.en-US.md b/components/back-top/doc/index.en-US.md index dd04fa6ed4d..d67a47e85c2 100644 --- a/components/back-top/doc/index.en-US.md +++ b/components/back-top/doc/index.en-US.md @@ -11,16 +11,16 @@ title: BackTop - When the page content is very long. - When you need to go back to the top very frequently in order to view the contents. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzBackTopModule } from 'ng-zorro-antd'; +import { NzBackTopModule } from 'ng-zorro-antd/back-top'; ``` +## API + ### nz-back-top > The distance to the bottom is set to `50px` by default, which is overridable. diff --git a/components/back-top/doc/index.zh-CN.md b/components/back-top/doc/index.zh-CN.md index 0ea947e7652..67643f5dbe1 100644 --- a/components/back-top/doc/index.zh-CN.md +++ b/components/back-top/doc/index.zh-CN.md @@ -12,16 +12,16 @@ title: BackTop - 当页面内容区域比较长时； - 当用户需要频繁返回顶部查看相关内容时。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzBackTopModule } from 'ng-zorro-antd'; +import { NzBackTopModule } from 'ng-zorro-antd/back-top'; ``` +## API + ### nz-back-top > 有默认样式，距离底部 `50px`，可覆盖。 diff --git a/components/badge/doc/index.en-US.md b/components/badge/doc/index.en-US.md index 24f85c134bf..2ce494b7a80 100644 --- a/components/badge/doc/index.en-US.md +++ b/components/badge/doc/index.en-US.md @@ -10,6 +10,14 @@ Small numerical value or status descriptor for UI elements. Badge normally appears in proximity to notifications or user avatars with eye-catching appeal, typically displaying unread messages count. +## Import this Component Individually + +You can get more detail [here](/docs/getting-started/en#import-a-component-individually). + +```ts +import { NzBadgeModule } from 'ng-zorro-antd/badge'; +``` + ## API ```html @@ -22,14 +30,6 @@ Badge normally appears in proximity to notifications or user avatars with eye-ca ``` -### Import this Component Individually - -You can get more detail [here](/docs/getting-started/en#import-a-component-individually). - -```ts -import { NzBadgeModule } from 'ng-zorro-antd'; -``` - ### nz-badge | Property | Description | Type | Default | diff --git a/components/badge/doc/index.zh-CN.md b/components/badge/doc/index.zh-CN.md index 4de1e7c2b9f..50f40b55988 100644 --- a/components/badge/doc/index.zh-CN.md +++ b/components/badge/doc/index.zh-CN.md @@ -11,6 +11,14 @@ title: Badge 一般出现在通知图标或头像的右上角，用于显示需要处理的消息条数，通过醒目视觉形式吸引用户处理。 +## 单独引入此组件 + +想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 + +```ts +import { NzBadgeModule } from 'ng-zorro-antd/badge'; +``` + ## API ```html @@ -23,14 +31,6 @@ title: Badge ``` -### 单独引入此组件 - -想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 - -```ts -import { NzBadgeModule } from 'ng-zorro-antd'; -``` - ### nz-badge | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/breadcrumb/doc/index.en-US.md b/components/breadcrumb/doc/index.en-US.md index a802ec52278..d395161ab70 100755 --- a/components/breadcrumb/doc/index.en-US.md +++ b/components/breadcrumb/doc/index.en-US.md @@ -13,16 +13,16 @@ A breadcrumb displays the current location within a hierarchy. It allows going b - When the user may need to navigate back to a higher level. - When the application has multi-layer architecture. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzBreadCrumbModule } from 'ng-zorro-antd'; +import { NzBreadCrumbModule } from 'ng-zorro-antd/breadcrumb'; ``` +## API + ### nz-breadcrumb | Property | Description | Type | Default | diff --git a/components/breadcrumb/doc/index.zh-CN.md b/components/breadcrumb/doc/index.zh-CN.md index 538896b9c32..70ac9c976ff 100755 --- a/components/breadcrumb/doc/index.zh-CN.md +++ b/components/breadcrumb/doc/index.zh-CN.md @@ -13,16 +13,16 @@ title: Breadcrumb - 当需要告知用户『你在哪里』时； - 当需要向上导航的功能时。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzBreadCrumbModule } from 'ng-zorro-antd'; +import { NzBreadCrumbModule } from 'ng-zorro-antd/breadcrumb'; ``` +## API + ### nz-breadcrumb | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/button/doc/index.en-US.md b/components/button/doc/index.en-US.md index c84338d986a..c8a9c647afb 100644 --- a/components/button/doc/index.en-US.md +++ b/components/button/doc/index.en-US.md @@ -10,16 +10,16 @@ To trigger an operation. A button means an operation (or a series of operations). Clicking a button will trigger corresponding business logic. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzButtonModule } from 'ng-zorro-antd'; +import { NzButtonModule } from 'ng-zorro-antd/button'; ``` +## API + ### [nz-button] To get a customized button, just set `nzType`/`nzShape`/`nzSize`/`nzLoading`/`disabled`. diff --git a/components/button/doc/index.zh-CN.md b/components/button/doc/index.zh-CN.md index 1263b327700..80f50f67282 100644 --- a/components/button/doc/index.zh-CN.md +++ b/components/button/doc/index.zh-CN.md @@ -11,16 +11,16 @@ subtitle: 按钮 标记了一个（或封装一组）操作命令，响应用户点击行为，触发相应的业务逻辑。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzButtonModule } from 'ng-zorro-antd'; +import { NzButtonModule } from 'ng-zorro-antd/button'; ``` +## API + ### [nz-button] 通过设置 Button 的属性来产生不同的按钮样式，推荐顺序为：`nzType` -> `nzShape` -> `nzSize` -> `nzLoading` -> `disabled` diff --git a/components/calendar/doc/index.en-US.md b/components/calendar/doc/index.en-US.md index bb43e15a251..c84ae721095 100644 --- a/components/calendar/doc/index.en-US.md +++ b/components/calendar/doc/index.en-US.md @@ -11,6 +11,15 @@ Container for displaying data in calendar form. When data is in the form of dates, such as schedules, timetables, prices calendar, lunar calendar. This component also supports Year/Month switch. +## Import this Component Individually + +You can get more detail [here](/docs/getting-started/en#import-a-component-individually). + +```ts +import { NzCalendarModule } from 'ng-zorro-antd/calendar'; +``` + + ## API **Note:** Some of Calendar's locale are coming from [Angular i18n](https://angular.io/guide/i18n), that should be provided in the file of `app.module.ts`. @@ -36,14 +45,6 @@ registerLocaleData(en); {{ date | date:'d'}} ``` -### Import this Component Individually - -You can get more detail [here](/docs/getting-started/en#import-a-component-individually). - -```ts -import { NzCalendarModule } from 'ng-zorro-antd'; -``` - ### nz-calendar | Property | Description | Type | Default | diff --git a/components/calendar/doc/index.zh-CN.md b/components/calendar/doc/index.zh-CN.md index 390e5969c51..c0258a79bde 100644 --- a/components/calendar/doc/index.zh-CN.md +++ b/components/calendar/doc/index.zh-CN.md @@ -12,6 +12,14 @@ title: Calendar 当数据是日期或按照日期划分时，例如日程、课表、价格日历等，农历等。目前支持年/月切换。 +## 单独引入此组件 + +想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 + +```ts +import { NzCalendarModule } from 'ng-zorro-antd/calendar'; +``` + ## API **注意：**Calendar 的部分 locale 来自于 Angular 自身的国际化支持，需要在 app.module.ts 文件中 引入相应的 Angular 语言包。 @@ -37,14 +45,6 @@ registerLocaleData(zh); {{ date | date:'d'}} ``` -### 单独引入此组件 - -想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 - -```ts -import { NzCalendarModule } from 'ng-zorro-antd'; -``` - ### nz-calendar | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/card/doc/index.en-US.md b/components/card/doc/index.en-US.md index 693e7e2b3aa..c06233824dc 100644 --- a/components/card/doc/index.en-US.md +++ b/components/card/doc/index.en-US.md @@ -11,18 +11,18 @@ Simple rectangular container. A card can be used to display content related to a single subject. The content can consist of multiple elements of varying types and sizes. -## API - -```html -卡片内容 -``` - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzCardModule } from 'ng-zorro-antd'; +import { NzCardModule } from 'ng-zorro-antd/card'; +``` + +## API + +```html +卡片内容 ``` ### nz-card diff --git a/components/card/doc/index.zh-CN.md b/components/card/doc/index.zh-CN.md index 6abcd6cd00e..4cf938697cb 100644 --- a/components/card/doc/index.zh-CN.md +++ b/components/card/doc/index.zh-CN.md @@ -12,18 +12,18 @@ cols: 1 最基础的卡片容器，可承载文字、列表、图片、段落，常用于后台概览页面。 -## API - -```html -卡片内容 -``` - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzCardModule } from 'ng-zorro-antd'; +import { NzCardModule } from 'ng-zorro-antd/card'; +``` + +## API + +```html +卡片内容 ``` ### nz-card diff --git a/components/carousel/doc/index.en-US.md b/components/carousel/doc/index.en-US.md index ca969a3b8f4..71220759103 100644 --- a/components/carousel/doc/index.en-US.md +++ b/components/carousel/doc/index.en-US.md @@ -12,16 +12,16 @@ A carousel component. Scales with its container. - When there is insufficient content space, it can be used to save space in the form of a revolving door. - Commonly used for a group of pictures/cards. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzCarouselModule } from 'ng-zorro-antd'; +import { NzCarouselModule } from 'ng-zorro-antd/carousel'; ``` +## API + ### nz-carousel | Property | Description | Type | Default | Version since | diff --git a/components/carousel/doc/index.zh-CN.md b/components/carousel/doc/index.zh-CN.md index c77c5df62de..8457b8d0fcd 100644 --- a/components/carousel/doc/index.zh-CN.md +++ b/components/carousel/doc/index.zh-CN.md @@ -13,16 +13,16 @@ subtitle: 走马灯 - 当内容空间不足时，可以用走马灯的形式进行收纳，进行轮播展现。 - 常用于一组图片或卡片轮播。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzCarouselModule } from 'ng-zorro-antd'; +import { NzCarouselModule } from 'ng-zorro-antd/carousel'; ``` +## API + ### nz-carousel | 参数 | 说明 | 类型 | 默认值 | 版本 | diff --git a/components/cascader/doc/index.en-US.md b/components/cascader/doc/index.en-US.md index 813e261833c..d95ac66cacd 100755 --- a/components/cascader/doc/index.en-US.md +++ b/components/cascader/doc/index.en-US.md @@ -12,18 +12,18 @@ Cascade selection box. - When selecting from a large data set, with multi-stage classification separated for easy selection. - Chooses cascade items in one float layer for better user experience. -## API - -```html - -``` - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzCascaderModule } from 'ng-zorro-antd'; +import { NzCascaderModule } from 'ng-zorro-antd/cascader'; +``` + +## API + +```html + ``` ### nz-cascader diff --git a/components/cascader/doc/index.zh-CN.md b/components/cascader/doc/index.zh-CN.md index c9ad3b69f8c..d6af9e4aaa2 100755 --- a/components/cascader/doc/index.zh-CN.md +++ b/components/cascader/doc/index.zh-CN.md @@ -13,18 +13,18 @@ subtitle: 级联选择 - 从一个较大的数据集合中进行选择时，用多级分类进行分隔，方便选择。 - 比起 Select 组件，可以在同一个浮层中完成选择，有较好的体验。 -## API - -```html - -``` - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzCascaderModule } from 'ng-zorro-antd'; +import { NzCascaderModule } from 'ng-zorro-antd/cascader'; +``` + +## API + +```html + ``` ### nz-cascader diff --git a/components/checkbox/doc/index.en-US.md b/components/checkbox/doc/index.en-US.md index 8476850782a..a4148cb883c 100755 --- a/components/checkbox/doc/index.en-US.md +++ b/components/checkbox/doc/index.en-US.md @@ -11,16 +11,16 @@ Checkbox. - Used for selecting multiple values from several options. - If you use only one checkbox, it is the same as using Switch to toggle between two states. The difference is that Switch will trigger the state change directly, but Checkbox just marks the state as changed and this needs to be submitted. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzCheckboxModule } from 'ng-zorro-antd'; +import { NzCheckboxModule } from 'ng-zorro-antd/checkbox'; ``` +## API + ### [nz-checkbox] | Property | Description | Type | Default | diff --git a/components/checkbox/doc/index.zh-CN.md b/components/checkbox/doc/index.zh-CN.md index b2d0132af4f..0ce4814d1be 100755 --- a/components/checkbox/doc/index.zh-CN.md +++ b/components/checkbox/doc/index.zh-CN.md @@ -12,16 +12,16 @@ title: Checkbox - 在一组可选项中进行多项选择时； - 单独使用可以表示两种状态之间的切换，和 `switch` 类似。区别在于切换 `switch` 会直接触发状态改变，而 `checkbox` 一般用于状态标记，需要和提交操作配合。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzCheckboxModule } from 'ng-zorro-antd'; +import { NzCheckboxModule } from 'ng-zorro-antd/checkbox'; ``` +## API + ### [nz-checkbox] | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/collapse/doc/index.en-US.md b/components/collapse/doc/index.en-US.md index a92198126a7..e7e3e162209 100755 --- a/components/collapse/doc/index.en-US.md +++ b/components/collapse/doc/index.en-US.md @@ -12,16 +12,16 @@ A content area which can be collapsed and expanded. - Can be used to group or hide complex regions to keep the page clean. - `Accordion` is a special kind of `Collapse`, which allows only one panel to be expanded at a time. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzCollapseModule } from 'ng-zorro-antd'; +import { NzCollapseModule } from 'ng-zorro-antd/collapse'; ``` +## API + ### nz-collapse | Property | Description | Type | Default | diff --git a/components/collapse/doc/index.zh-CN.md b/components/collapse/doc/index.zh-CN.md index 2585ebf17ca..eb9f1f8aa12 100755 --- a/components/collapse/doc/index.zh-CN.md +++ b/components/collapse/doc/index.zh-CN.md @@ -13,16 +13,16 @@ cols: 1 - 对复杂区域进行分组和隐藏，保持页面的整洁。 - `手风琴` 是一种特殊的折叠面板，只允许单个内容区域展开。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzCollapseModule } from 'ng-zorro-antd'; +import { NzCollapseModule } from 'ng-zorro-antd/collapse'; ``` +## API + ### nz-collapse | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/comment/doc/index.en-US.md b/components/comment/doc/index.en-US.md index 024bd340138..9c4c107f93b 100644 --- a/components/comment/doc/index.en-US.md +++ b/components/comment/doc/index.en-US.md @@ -11,6 +11,14 @@ A comment displays user feedback and discussion to website content. Comments can be used to enable discussions on an entity such as a page, blog post, issue or other. +## Import this Component Individually + +You can get more detail [here](/docs/getting-started/en#import-a-component-individually). + +```ts +import { NzCommentModule } from 'ng-zorro-antd/comment'; +``` + ## API | Property | Description | Type | Default | @@ -18,14 +26,6 @@ Comments can be used to enable discussions on an entity such as a page, blog pos | [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 - -You can get more detail [here](/docs/getting-started/en#import-a-component-individually). - -```ts -import { NzCommentModule } from 'ng-zorro-antd'; -``` - ### Comment sections | Element | Description | | ----- | ----------- | diff --git a/components/comment/doc/index.zh-CN.md b/components/comment/doc/index.zh-CN.md index a4fd855787f..17d1cdc69c5 100644 --- a/components/comment/doc/index.zh-CN.md +++ b/components/comment/doc/index.zh-CN.md @@ -12,6 +12,14 @@ cols: 1 评论组件可用于对事物的讨论，例如页面、博客文章、问题等等。 +## 单独引入此组件 + +想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 + +```ts +import { NzCommentModule } from 'ng-zorro-antd/comment'; +``` + ## API | Property | Description | Type | Default | @@ -19,14 +27,6 @@ cols: 1 | [nzAuthor] | 显示评论的作者 | `string \| TemplateRef` | - | | [nzDatetime] | 展示时间描述 | `string \| TemplateRef` | - | -### 单独引入此组件 - -想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 - -```ts -import { NzCommentModule } from 'ng-zorro-antd'; -``` - ### 评论组成部分 | 元素 | 说明 | | ----- | ----------- | diff --git a/components/date-picker/doc/index.en-US.md b/components/date-picker/doc/index.en-US.md index 2f362217b2b..7040bc143c7 100644 --- a/components/date-picker/doc/index.en-US.md +++ b/components/date-picker/doc/index.en-US.md @@ -10,6 +10,14 @@ To select or input a date. By clicking the input box, you can select a date from a popup calendar. +## Import this Component Individually + +You can get more detail [here](/docs/getting-started/en#import-a-component-individually). + +```ts +import { NzDatePickerModule } from 'ng-zorro-antd/date-picker'; +``` + ## API **Note:** Some of nz-date-picker's locale are coming from [Angular i18n](https://angular.io/guide/i18n), that should be provided in the file of `app.module.ts`. @@ -30,14 +38,6 @@ There are four kinds of picker: **Note:** All input and output date objects are [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date), you can manpulate it with [date-fns](https://date-fns.org/). -### Import this Component Individually - -You can get more detail [here](/docs/getting-started/en#import-a-component-individually). - -```ts -import { NzDatePickerModule } from 'ng-zorro-antd'; -``` - ### Common API The following APIs are shared by nz-date-picker, nz-month-picker, nz-range-picker, nz-week-picker. diff --git a/components/date-picker/doc/index.zh-CN.md b/components/date-picker/doc/index.zh-CN.md index 1ede6e3c9cb..9ca7ac670fc 100644 --- a/components/date-picker/doc/index.zh-CN.md +++ b/components/date-picker/doc/index.zh-CN.md @@ -11,6 +11,14 @@ subtitle: 日期选择框 当用户需要输入一个日期，可以点击标准输入框，弹出日期面板进行选择。 +## 单独引入此组件 + +想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 + +```ts +import { NzDatePickerModule } from 'ng-zorro-antd/date-picker'; +``` + ## API **注意：**nz-date-picker 的部分 locale 来自于 Angular 自身的[国际化支持](https://angular.io/guide/i18n)，需要在 `app.module.ts` 文件中 引入相应的 Angular 语言包。 @@ -30,14 +38,6 @@ registerLocaleData(zh); **注意：** 所有输入输出日期对象均为 [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)，你可以通过 [date-fns](https://date-fns.org/) 工具库获得你需要的数据。 -### 单独引入此组件 - -想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 - -```ts -import { NzDatePickerModule } from 'ng-zorro-antd'; -``` - ### 共同的 API 以下 API 为 nz-date-picker、nz-month-picker、nz-range-picker, nz-week-picker 共享的 API。 diff --git a/components/descriptions/doc/index.en-US.md b/components/descriptions/doc/index.en-US.md index dacc68012ba..47e367886a5 100644 --- a/components/descriptions/doc/index.en-US.md +++ b/components/descriptions/doc/index.en-US.md @@ -11,6 +11,14 @@ Display multiple read-only fields in groups. Commonly displayed on the details page. +## Import this Component Individually + +You can get more detail [here](/docs/getting-started/en#import-a-component-individually). + +```ts +import { NzDescriptionsModule } from 'ng-zorro-antd/descriptions'; +``` + ## API ### nz-descriptions @@ -22,14 +30,6 @@ Commonly displayed on the details page. | `[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'` | -### Import this Component Individually - -You can get more detail [here](/docs/getting-started/en#import-a-component-individually). - -```ts -import { NzDescriptionsModule } from 'ng-zorro-antd'; -``` - ### nz-descriptions-item | Property | Description | Type | Default | diff --git a/components/descriptions/doc/index.zh-CN.md b/components/descriptions/doc/index.zh-CN.md index 77f33db79e8..88c0ab66f09 100644 --- a/components/descriptions/doc/index.zh-CN.md +++ b/components/descriptions/doc/index.zh-CN.md @@ -12,6 +12,14 @@ cols: 1 常见于详情页的信息展示。 +## 单独引入此组件 + +想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 + +```ts +import { NzDescriptionsModule } from 'ng-zorro-antd/descriptions'; +``` + ## API ### nz-descriptions @@ -23,14 +31,6 @@ cols: 1 | `[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'` | -### 单独引入此组件 - -想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 - -```ts -import { NzDescriptionsModule } from 'ng-zorro-antd'; -``` - ### nz-descriptions-item | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/divider/doc/index.en-US.md b/components/divider/doc/index.en-US.md index c41e556c490..8c8f5bfceb0 100644 --- a/components/divider/doc/index.en-US.md +++ b/components/divider/doc/index.en-US.md @@ -11,16 +11,16 @@ A divider line separates different content. - Divide sections of article. - Divide inline text and links such as the operation column of table. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzDividerModule } from 'ng-zorro-antd'; +import { NzDividerModule } from 'ng-zorro-antd/divider'; ``` +## API + ### nz-divider | Property | Description | Type | Default | diff --git a/components/divider/doc/index.zh-CN.md b/components/divider/doc/index.zh-CN.md index 63fd1595869..57d3e5461c0 100644 --- a/components/divider/doc/index.zh-CN.md +++ b/components/divider/doc/index.zh-CN.md @@ -12,16 +12,16 @@ subtitle: 分割线 - 对不同章节的文本段落进行分割。 - 对行内文字/链接进行分割，例如表格的操作列。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzDividerModule } from 'ng-zorro-antd'; +import { NzDividerModule } from 'ng-zorro-antd/divider'; ``` +## API + ### nz-divider | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/drawer/doc/index.en-US.md b/components/drawer/doc/index.en-US.md index 2af8add75a1..0e67c5aed8c 100755 --- a/components/drawer/doc/index.en-US.md +++ b/components/drawer/doc/index.en-US.md @@ -13,16 +13,16 @@ A Drawer is a panel that is typically overlaid on top of a page and slides in fr * Processing subtasks. When subtasks are too heavy for Popover and we still want to keep the subtasks in the context of the main task, Drawer comes very handy. * When a same Form is needed in multiple places. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzDrawerModule } from 'ng-zorro-antd'; +import { NzDrawerModule } from 'ng-zorro-antd/drawer'; ``` +## API + ### nz-drawer | Props | Description | Type | Default | diff --git a/components/drawer/doc/index.zh-CN.md b/components/drawer/doc/index.zh-CN.md index d8fc9159601..cba3bddde77 100755 --- a/components/drawer/doc/index.zh-CN.md +++ b/components/drawer/doc/index.zh-CN.md @@ -9,21 +9,19 @@ title: Drawer ## 何时使用 - * 当需要一个附加的面板来控制父窗体内容，这个面板在需要时呼出。比如，控制界面展示样式，往界面中添加内容。 * 当需要在当前任务流中插入临时任务，创建或预览附加内容。比如展示协议条款，创建子对象。 - -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzDrawerModule } from 'ng-zorro-antd'; +import { NzDrawerModule } from 'ng-zorro-antd/drawer'; ``` +## API + ### nz-drawer | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/dropdown/doc/index.en-US.md b/components/dropdown/doc/index.en-US.md index 9ed1b92fa0d..3dba992c636 100755 --- a/components/dropdown/doc/index.en-US.md +++ b/components/dropdown/doc/index.en-US.md @@ -10,16 +10,16 @@ A dropdown list. If there are too many operations to display, you can wrap them in a `Dropdown`. By clicking/hovering on the trigger, a dropdown menu should appear, which allows you to choose one option and execute relevant actions. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzDropDownModule } from 'ng-zorro-antd'; +import { NzDropDownModule } from 'ng-zorro-antd/dropdown'; ``` +## API + ### [nz-dropdown] | Property | Description | Type | Default | diff --git a/components/dropdown/doc/index.zh-CN.md b/components/dropdown/doc/index.zh-CN.md index ed793a1385d..21890a4ab90 100755 --- a/components/dropdown/doc/index.zh-CN.md +++ b/components/dropdown/doc/index.zh-CN.md @@ -11,16 +11,16 @@ title: Dropdown 当页面上的操作命令过多时，用此组件可以收纳操作元素。点击或移入触点，会出现一个下拉菜单。可在列表中进行选择，并执行相应的命令。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzDropDownModule } from 'ng-zorro-antd'; +import { NzDropDownModule } from 'ng-zorro-antd/dropdown'; ``` +## API + ### [nz-dropdown] | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/empty/doc/index.en-US.md b/components/empty/doc/index.en-US.md index 9164737d905..c4d7dfc9062 100644 --- a/components/empty/doc/index.en-US.md +++ b/components/empty/doc/index.en-US.md @@ -11,16 +11,16 @@ Empty state placeholder. When there is no data provided, display for friendly tips. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzEmptyModule } from 'ng-zorro-antd'; +import { NzEmptyModule } from 'ng-zorro-antd/empty'; ``` +## API + ### nz-empty | Property | Description | Type | Default | diff --git a/components/empty/doc/index.zh-CN.md b/components/empty/doc/index.zh-CN.md index 683a98a7f0b..c0511a3c993 100644 --- a/components/empty/doc/index.zh-CN.md +++ b/components/empty/doc/index.zh-CN.md @@ -12,16 +12,16 @@ cols: 1 当目前没有数据时，用于显式的用户提示。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzEmptyModule } from 'ng-zorro-antd'; +import { NzEmptyModule } from 'ng-zorro-antd/empty'; ``` +## API + ### nz-empty | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/form/doc/index.en-US.md b/components/form/doc/index.en-US.md index d0973724198..bad3ebcda57 100644 --- a/components/form/doc/index.en-US.md +++ b/components/form/doc/index.en-US.md @@ -42,17 +42,16 @@ A form consists of one or more form fields whose type includes input, textarea, ``` - -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzFormModule } from 'ng-zorro-antd'; +import { NzFormModule } from 'ng-zorro-antd/form'; ``` +## API + ### nz-form diff --git a/components/form/doc/index.zh-CN.md b/components/form/doc/index.zh-CN.md index a9443944981..3feeabd3e2b 100644 --- a/components/form/doc/index.zh-CN.md +++ b/components/form/doc/index.zh-CN.md @@ -42,16 +42,16 @@ title: Form ``` -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzFormModule } from 'ng-zorro-antd'; +import { NzFormModule } from 'ng-zorro-antd/form'; ``` +## API + ### nz-form | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/grid/doc/index.en-US.md b/components/grid/doc/index.en-US.md index 87979ef2bcb..236b475953f 100755 --- a/components/grid/doc/index.en-US.md +++ b/components/grid/doc/index.en-US.md @@ -79,16 +79,16 @@ Our grid systems support Flex layout to allow the elements within the parent to Flex layout uses a 24 grid layout to define the width of each "box", but does not rigidly adhere to the grid layout. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzGridModule } from 'ng-zorro-antd'; +import { NzGridModule } from 'ng-zorro-antd/grid'; ``` +## API + ### [nz-row] | Property | Description | Type | Default | diff --git a/components/grid/doc/index.zh-CN.md b/components/grid/doc/index.zh-CN.md index c039158d8ca..1891f27861a 100755 --- a/components/grid/doc/index.zh-CN.md +++ b/components/grid/doc/index.zh-CN.md @@ -78,16 +78,16 @@ title: Grid Flex 布局是基于 24 栅格来定义每一个『盒子』的宽度，但排版则不拘泥于栅格。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzGridModule } from 'ng-zorro-antd'; +import { NzGridModule } from 'ng-zorro-antd/grid'; ``` +## API + ### [nz-row] | 成员 | 说明 | 类型 | 默认值 | diff --git a/components/icon/doc/index.en-US.md b/components/icon/doc/index.en-US.md index 7f26ca631e8..f9f6ac35126 100755 --- a/components/icon/doc/index.en-US.md +++ b/components/icon/doc/index.en-US.md @@ -18,16 +18,16 @@ Semantic vector graphics. We are still adding two-tone icons right now, syncing to [antd](https://ant.design/components/icon-cn/#components-icon-demo-iconfont). -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzIconModule } from 'ng-zorro-antd'; +import { NzIconModule } from 'ng-zorro-antd/icon'; ``` +## API + ### [nz-icon] | Property | Description | Type | Default | diff --git a/components/icon/doc/index.zh-CN.md b/components/icon/doc/index.zh-CN.md index 9814c9da789..8ac20062f06 100755 --- a/components/icon/doc/index.zh-CN.md +++ b/components/icon/doc/index.zh-CN.md @@ -19,16 +19,16 @@ hasPageDemo: true 新版图标可能略有缺失，我们将与 [Ant Design](https://ant.design/components/icon-cn/#components-icon-demo-iconfont) 同步保持图标的更新。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzIconModule } from 'ng-zorro-antd'; +import { NzIconModule } from 'ng-zorro-antd/icon'; ``` +## API + ### [nz-icon] | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/input-number/doc/index.en-US.md b/components/input-number/doc/index.en-US.md index c62e02138ad..e5b829d9681 100755 --- a/components/input-number/doc/index.en-US.md +++ b/components/input-number/doc/index.en-US.md @@ -12,16 +12,16 @@ Enter a number within certain range with the mouse or keyboard. When a numeric value needs to be provided. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzInputNumberModule } from 'ng-zorro-antd'; +import { NzInputNumberModule } from 'ng-zorro-antd/input-number'; ``` +## API + ### nz-input-number The value entered in `nz-input-number` will not be verified at the time of input, but will be fed back to `[ngModel]` and `(ngModelChange)` at a specific timing (Enter key, up and down keys, blur, etc.), otherwise input data such as `-0.12` or `1e10`, the `ngModel` will always be `undefined`. diff --git a/components/input-number/doc/index.zh-CN.md b/components/input-number/doc/index.zh-CN.md index 844c66cbeee..447fdbab62f 100755 --- a/components/input-number/doc/index.zh-CN.md +++ b/components/input-number/doc/index.zh-CN.md @@ -13,18 +13,16 @@ title: InputNumber 当需要获取标准数值时。 -## API - -属性如下 - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzInputNumberModule } from 'ng-zorro-antd'; +import { NzInputNumberModule } from 'ng-zorro-antd/input-number'; ``` +## API + ### nz-input-number 在 `nz-input-number` 中输入的数值不会在输入时进行校验，而是在特定时机（回车键，上下键，失去焦点等）时才会校验后反馈到 `[ngModel]` 和 `(ngModelChange)` 中，否则输入 `-0.12` 或者 `1e10` 这种类型数据时，双向绑定的数据会永远是 `undefined` diff --git a/components/input/doc/index.en-US.md b/components/input/doc/index.en-US.md index acb273df26d..e9b6ed35237 100755 --- a/components/input/doc/index.en-US.md +++ b/components/input/doc/index.en-US.md @@ -12,16 +12,16 @@ Keyboard and mouse can be used for providing or changing data. - A user input in a form field is needed. - A search input is required. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzInputModule } from 'ng-zorro-antd'; +import { NzInputModule } from 'ng-zorro-antd/input'; ``` +## API + ### [nz-input] All props of input supported by [w3c standards](https://www.w3schools.com/tags/tag_input.asp) and Angular can used in `nz-input`. diff --git a/components/input/doc/index.zh-CN.md b/components/input/doc/index.zh-CN.md index ffeac48984f..af840ca1d0e 100755 --- a/components/input/doc/index.zh-CN.md +++ b/components/input/doc/index.zh-CN.md @@ -12,16 +12,16 @@ title: Input - 需要用户输入表单域内容时。 - 提供组合型输入框，带搜索的输入框，还可以进行大小选择。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzInputModule } from 'ng-zorro-antd'; +import { NzInputModule } from 'ng-zorro-antd/input'; ``` +## API + ### [nz-input] nz-input 可以使用所有的W3C标准下的所有 [使用方式](https://www.w3schools.com/tags/tag_input.asp) 和 Angular对 input 的全部额外功能支持。 diff --git a/components/layout/doc/index.en-US.md b/components/layout/doc/index.en-US.md index 94d5641c068..d58220200ca 100755 --- a/components/layout/doc/index.en-US.md +++ b/components/layout/doc/index.en-US.md @@ -7,6 +7,14 @@ title: Layout Handling the overall layout of a page. +## Import this Component Individually + +You can get more detail [here](/docs/getting-started/en#import-a-component-individually). + +```ts +import { NzLayoutModule } from 'ng-zorro-antd/layout'; +``` + ## Specification ### Size @@ -69,14 +77,6 @@ The first level navigation is inclined left near a logo, and the secondary menu ``` -### Import this Component Individually - -You can get more detail [here](/docs/getting-started/en#import-a-component-individually). - -```ts -import { NzLayoutModule } from 'ng-zorro-antd'; -``` - ### nz-sider The sidebar. diff --git a/components/layout/doc/index.zh-CN.md b/components/layout/doc/index.zh-CN.md index 3d69498e643..21eebe343e1 100755 --- a/components/layout/doc/index.zh-CN.md +++ b/components/layout/doc/index.zh-CN.md @@ -8,6 +8,14 @@ title: Layout 协助进行页面级整体布局。 +## 单独引入此组件 + +想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 + +```ts +import { NzLayoutModule } from 'ng-zorro-antd/layout'; +``` + ## 设计规则 ### 尺寸 @@ -70,14 +78,6 @@ title: Layout ``` -### 单独引入此组件 - -想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 - -```ts -import { NzLayoutModule } from 'ng-zorro-antd'; -``` - ### nz-sider 侧边栏。 diff --git a/components/list/doc/index.en-US.md b/components/list/doc/index.en-US.md index bda85048b80..596cadc1cae 100644 --- a/components/list/doc/index.en-US.md +++ b/components/list/doc/index.en-US.md @@ -11,16 +11,16 @@ Simple List. A list can be used to display content related to a single subject. The content can consist of multiple elements of varying type and size. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzListModule } from 'ng-zorro-antd'; +import { NzListModule } from 'ng-zorro-antd/list'; ``` +## API + ### nz-list | Property | Description | Type | Default diff --git a/components/list/doc/index.zh-CN.md b/components/list/doc/index.zh-CN.md index 399c2e19101..5fd961406f5 100644 --- a/components/list/doc/index.zh-CN.md +++ b/components/list/doc/index.zh-CN.md @@ -12,16 +12,16 @@ cols: 1 最基础的列表展示，可承载文字、列表、图片、段落，常用于后台数据展示页面。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzListModule } from 'ng-zorro-antd'; +import { NzListModule } from 'ng-zorro-antd/list'; ``` +## API + ### nz-list | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/mention/doc/index.en-US.md b/components/mention/doc/index.en-US.md index bdc156944f0..edfb5c1c077 100644 --- a/components/mention/doc/index.en-US.md +++ b/components/mention/doc/index.en-US.md @@ -10,6 +10,14 @@ Mention component. When need to mention someone or something. +## Import this Component Individually + +You can get more detail [here](/docs/getting-started/en#import-a-component-individually). + +```ts +import { NzMentionModule } from 'ng-zorro-antd/mention'; +``` + ## API ```html @@ -22,14 +30,6 @@ When need to mention someone or something. ``` -### Import this Component Individually - -You can get more detail [here](/docs/getting-started/en#import-a-component-individually). - -```ts -import { NzMentionModule } from 'ng-zorro-antd'; -``` - ### nz-mention | Property | Description | Type | Default | diff --git a/components/mention/doc/index.zh-CN.md b/components/mention/doc/index.zh-CN.md index 27f861b260c..ce512887ce9 100644 --- a/components/mention/doc/index.zh-CN.md +++ b/components/mention/doc/index.zh-CN.md @@ -11,6 +11,14 @@ title: Mention 用于在输入中提及某人或某事，常用于发布、聊天或评论功能。 +## 单独引入此组件 + +想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 + +```ts +import { NzMentionModule } from 'ng-zorro-antd/mention'; +``` + ## API ```html @@ -23,14 +31,6 @@ title: Mention ``` -### 单独引入此组件 - -想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 - -```ts -import { NzMentionModule } from 'ng-zorro-antd'; -``` - ### nz-mention | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/menu/doc/index.en-US.md b/components/menu/doc/index.en-US.md index e8ef99ed1cc..2d2a39a1f23 100755 --- a/components/menu/doc/index.en-US.md +++ b/components/menu/doc/index.en-US.md @@ -13,6 +13,14 @@ Navigation menu is important for a website, it helps users jump from one site se More layouts with navigation: [layout](/components/layout/en). +## Import this Component Individually + +You can get more detail [here](/docs/getting-started/en#import-a-component-individually). + +```ts +import { NzMenuModule } from 'ng-zorro-antd/menu'; +``` + ## API ```html @@ -29,14 +37,6 @@ More layouts with navigation: [layout](/components/layout/en). ``` -### Import this Component Individually - -You can get more detail [here](/docs/getting-started/en#import-a-component-individually). - -```ts -import { NzMenuModule } from 'ng-zorro-antd'; -``` - ### [nz-menu] | Param | Description | Type | Default value | diff --git a/components/menu/doc/index.zh-CN.md b/components/menu/doc/index.zh-CN.md index 1c36e8444a2..49b2a9dc3f6 100755 --- a/components/menu/doc/index.zh-CN.md +++ b/components/menu/doc/index.zh-CN.md @@ -14,6 +14,14 @@ subtitle: 导航菜单 更多布局和导航的使用可以参考：[通用布局](/components/layout/zh)。 +## 单独引入此组件 + +想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 + +```ts +import { NzMenuModule } from 'ng-zorro-antd/menu'; +``` + ## API ```html @@ -30,14 +38,6 @@ subtitle: 导航菜单 ``` -### 单独引入此组件 - -想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 - -```ts -import { NzMenuModule } from 'ng-zorro-antd'; -``` - ### [nz-menu] | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/message/doc/index.en-US.md b/components/message/doc/index.en-US.md index 2a7ef878d7d..837c71ea4db 100644 --- a/components/message/doc/index.en-US.md +++ b/components/message/doc/index.en-US.md @@ -12,6 +12,14 @@ Display global messages as feedback in response to user operations. - To provide feedback such as success, warning, error etc. - A message is displayed at top and center and will be dismissed automatically, as a non-interrupting light-weighted prompt. +## Import this Component Individually + +You can get more detail [here](/docs/getting-started/en#import-a-component-individually). + +```ts +import { NzMessageModule } from 'ng-zorro-antd/message'; +``` + ## How To Use If you want to modify the global default configuration, you can modify the value of provider `NZ_MESSAGE_CONFIG`. @@ -29,14 +37,6 @@ The default global configuration is: ## API -### Import this Component Individually - -You can get more detail [here](/docs/getting-started/en#import-a-component-individually). - -```ts -import { NzMessageModule } from 'ng-zorro-antd'; -``` - ### NzMessageService This components provides some service methods, with usage and arguments as following: diff --git a/components/message/doc/index.zh-CN.md b/components/message/doc/index.zh-CN.md index d65255b45c8..156fd2368db 100644 --- a/components/message/doc/index.zh-CN.md +++ b/components/message/doc/index.zh-CN.md @@ -13,6 +13,14 @@ title: Message - 可提供成功、警告和错误等反馈信息。 - 顶部居中显示并自动消失，是一种不打断用户操作的轻量级提示方式。 +## 单独引入此组件 + +想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 + +```ts +import { NzMessageModule } from 'ng-zorro-antd/message'; +``` + ## 如何使用 如果要修改全局默认配置，你可以设置提供商 `NZ_MESSAGE_CONFIG` 的值来修改。 @@ -30,14 +38,6 @@ title: Message ## API -### 单独引入此组件 - -想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 - -```ts -import { NzMessageModule } from 'ng-zorro-antd'; -``` - ### NzMessageService 组件提供了一些服务方法，使用方式和参数如下： diff --git a/components/modal/doc/index.en-US.md b/components/modal/doc/index.en-US.md index b3f3f3cf5ed..721cb9dec92 100644 --- a/components/modal/doc/index.en-US.md +++ b/components/modal/doc/index.en-US.md @@ -16,16 +16,16 @@ and so on. It is recommended to use the `Component` way to pop up the Modal, so that the component logic of the popup layer can be completely isolated from the outer component, and can be reused at any time. In the popup layer component, you can obtain Modal's component instance by injecting `NzModalRef` to control the behavior of the modal box. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzModalModule } from 'ng-zorro-antd'; +import { NzModalModule } from 'ng-zorro-antd/modal'; ``` +## API + ### NzModalService The dialog is currently divided into 2 modes, `normal mode` and `confirm box mode` (ie the `Confirm` dialog, which is called by calling `confirm/info/success/error/warning`). The degree of API support for the two modes is slightly different. diff --git a/components/modal/doc/index.zh-CN.md b/components/modal/doc/index.zh-CN.md index 24695468d56..b370c8f3d4c 100644 --- a/components/modal/doc/index.zh-CN.md +++ b/components/modal/doc/index.zh-CN.md @@ -17,16 +17,16 @@ title: Modal 在弹出层Component中可以通过依赖注入`NzModalRef`方式直接获取模态框的组件实例，用于控制在弹出层组件中控制模态框行为。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzModalModule } from 'ng-zorro-antd'; +import { NzModalModule } from 'ng-zorro-antd/modal'; ``` +## API + ### NzModalService 对话框当前分为2种模式，`普通模式` 和 `确认框模式`（即`Confirm`对话框，通过调用`confirm/info/success/error/warning`弹出），两种模式对API的支持程度稍有不同。 diff --git a/components/notification/doc/index.en-US.md b/components/notification/doc/index.en-US.md index e1d41fb5077..1b1ecdda33e 100644 --- a/components/notification/doc/index.en-US.md +++ b/components/notification/doc/index.en-US.md @@ -17,6 +17,14 @@ used in the following cases: about upcoming steps the user may have to follow. - A notification that is pushed by the application. +## Import this Component Individually + +You can get more detail [here](/docs/getting-started/en#import-a-component-individually). + +```ts +import { NzNotificationModule } from 'ng-zorro-antd/notification'; +``` + ## How To Use Similar to `NzMessage`, if you want to modify the global default configuration, you can modify the value of provider `NZ_NOTIFICATION_CONFIG`. @@ -37,14 +45,6 @@ The default global configuration is: ## API -### Import this Component Individually - -You can get more detail [here](/docs/getting-started/en#import-a-component-individually). - -```ts -import { NzNotificationModule } from 'ng-zorro-antd'; -``` - ### NzNotificationService The component provides a number of service methods using the following methods and parameters: diff --git a/components/notification/doc/index.zh-CN.md b/components/notification/doc/index.zh-CN.md index 88ae28f8c66..6eb585e26d6 100644 --- a/components/notification/doc/index.zh-CN.md +++ b/components/notification/doc/index.zh-CN.md @@ -16,6 +16,14 @@ subtitle: 通知提醒框 - 带有交互的通知，给出用户下一步的行动点。 - 系统主动推送。 +## 单独引入此组件 + +想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 + +```ts +import { NzNotificationModule } from 'ng-zorro-antd/notification'; +``` + ## 如何使用 与`NzMessage`类似，如果要修改全局默认配置，你可以设置提供商 `NZ_NOTIFICATION_CONFIG` 的值来修改。 @@ -36,14 +44,6 @@ subtitle: 通知提醒框 ## API -### 单独引入此组件 - -想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 - -```ts -import { NzNotificationModule } from 'ng-zorro-antd'; -``` - ### NzNotificationService 组件提供了一些服务方法，使用方式和参数如下： diff --git a/components/page-header/doc/index.en-US.md b/components/page-header/doc/index.en-US.md index c6d13e50405..54598e3591d 100644 --- a/components/page-header/doc/index.en-US.md +++ b/components/page-header/doc/index.en-US.md @@ -11,18 +11,18 @@ The header is used to declare the theme of the page, which contains the most imp Use when you need the user to quickly understand what the current page is and what its features are. -## API - -```html - -``` - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzPageHeaderModule } from 'ng-zorro-antd'; +import { NzPageHeaderModule } from 'ng-zorro-antd/page-header'; +``` + +## API + +```html + ``` ### nz-page-header diff --git a/components/page-header/doc/index.zh-CN.md b/components/page-header/doc/index.zh-CN.md index 54967493cc5..0420ecee7ce 100644 --- a/components/page-header/doc/index.zh-CN.md +++ b/components/page-header/doc/index.zh-CN.md @@ -12,18 +12,18 @@ subtitle: 页头 当需要用户快速理解当前页面是什么以及它的功能时使用。 -## API - -```html - -``` - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzPageHeaderModule } from 'ng-zorro-antd'; +import { NzPageHeaderModule } from 'ng-zorro-antd/page-header'; +``` + +## API + +```html + ``` ### nz-page-header diff --git a/components/pagination/doc/index.en-US.md b/components/pagination/doc/index.en-US.md index 88ea29e6266..4272445e206 100755 --- a/components/pagination/doc/index.en-US.md +++ b/components/pagination/doc/index.en-US.md @@ -12,18 +12,18 @@ A long list can be divided into several pages by `Pagination`, and only one page - When it will take a long time to load/render all items. - If you want to browse the data by navigating through pages. -## API - -```html - -``` - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzPaginationModule } from 'ng-zorro-antd'; +import { NzPaginationModule } from 'ng-zorro-antd/pagination'; +``` + +## API + +```html + ``` ### nz-pagination diff --git a/components/pagination/doc/index.zh-CN.md b/components/pagination/doc/index.zh-CN.md index 254d2aaef86..8be4666ad43 100755 --- a/components/pagination/doc/index.zh-CN.md +++ b/components/pagination/doc/index.zh-CN.md @@ -13,18 +13,18 @@ cols: 1 - 当加载/渲染所有数据将花费很多时间时； - 可切换页码浏览数据。 -## API - -```html - -``` - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzPaginationModule } from 'ng-zorro-antd'; +import { NzPaginationModule } from 'ng-zorro-antd/pagination'; +``` + +## API + +```html + ``` ### nz-pagination diff --git a/components/popconfirm/doc/index.en-US.md b/components/popconfirm/doc/index.en-US.md index b239d8445df..b3b90da18d1 100644 --- a/components/popconfirm/doc/index.en-US.md +++ b/components/popconfirm/doc/index.en-US.md @@ -12,16 +12,16 @@ A simple and compact dialog used for asking for user confirmation. The difference with the `confirm` modal dialog is that it's more lightweight than the static popped full-screen confirm modal. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzPopconfirmModule } from 'ng-zorro-antd'; +import { NzPopconfirmModule } from 'ng-zorro-antd/popconfirm'; ``` +## API + ### [nz-popconfirm] | Param | Description | Type | Default value | diff --git a/components/popconfirm/doc/index.zh-CN.md b/components/popconfirm/doc/index.zh-CN.md index 7c40afdfb9d..d0b6c561648 100644 --- a/components/popconfirm/doc/index.zh-CN.md +++ b/components/popconfirm/doc/index.zh-CN.md @@ -13,16 +13,16 @@ title: Popconfirm 和 `confirm` 弹出的全屏居中模态对话框相比，交互形式更轻量。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzPopconfirmModule } from 'ng-zorro-antd'; +import { NzPopconfirmModule } from 'ng-zorro-antd/popconfirm'; ``` +## API + ### [nz-popconfirm] | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/popover/doc/index.en-US.md b/components/popover/doc/index.en-US.md index 24c740dee95..b28e5abea08 100644 --- a/components/popover/doc/index.en-US.md +++ b/components/popover/doc/index.en-US.md @@ -12,16 +12,16 @@ A simple popup menu to provide extra information or operations. Comparing with `Tooltip`, besides information `Popover` card can also provide action elements like links and buttons. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzPopoverModule } from 'ng-zorro-antd'; +import { NzPopoverModule } from 'ng-zorro-antd/popover'; ``` +## API + ### [nz-popover] | Param | Description | Type | Default value | diff --git a/components/popover/doc/index.zh-CN.md b/components/popover/doc/index.zh-CN.md index d14a1c93159..499a1258a0d 100644 --- a/components/popover/doc/index.zh-CN.md +++ b/components/popover/doc/index.zh-CN.md @@ -13,16 +13,16 @@ title: Popover 和 `Tooltip` 的区别是，用户可以对浮层上的元素进行操作，因此它可以承载更复杂的内容，比如链接或按钮等。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzPopoverModule } from 'ng-zorro-antd'; +import { NzPopoverModule } from 'ng-zorro-antd/popover'; ``` +## API + ### [nz-popover] | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/progress/doc/index.en-US.md b/components/progress/doc/index.en-US.md index 8675a0e43db..ea1a82648b9 100644 --- a/components/progress/doc/index.en-US.md +++ b/components/progress/doc/index.en-US.md @@ -13,16 +13,16 @@ If it will take a long time to complete an operation, you can use `Progress` to - When an operation will interrupt the current interface, or it needs to run in the background for more than 2 seconds. - When you need to display the completion percentage of an operation. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzProgressModule } from 'ng-zorro-antd'; +import { NzProgressModule } from 'ng-zorro-antd/progress'; ``` +## API + ### nz-progress | Property | Description | Type | Default | diff --git a/components/progress/doc/index.zh-CN.md b/components/progress/doc/index.zh-CN.md index 3dcae72ce3c..f456cbcb777 100644 --- a/components/progress/doc/index.zh-CN.md +++ b/components/progress/doc/index.zh-CN.md @@ -14,16 +14,16 @@ title: Progress - 当一个操作会打断当前界面，或者需要在后台运行，且耗时可能超过2秒时； - 当需要显示一个操作完成的百分比时。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzProgressModule } from 'ng-zorro-antd'; +import { NzProgressModule } from 'ng-zorro-antd/progress'; ``` +## API + ### nz-progress | 属性 | 说明 | 类型 | 默认值 | diff --git a/components/radio/doc/index.en-US.md b/components/radio/doc/index.en-US.md index 5291f7f9e6e..7c50347a376 100644 --- a/components/radio/doc/index.en-US.md +++ b/components/radio/doc/index.en-US.md @@ -11,16 +11,16 @@ Radio. - Used to select a single state in multiple options. - The difference between Select is that Radio is visible to user and can facilitate the comparison of choice. So, when you want to use Radio, option should not be too much. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzRadioModule } from 'ng-zorro-antd'; +import { NzRadioModule } from 'ng-zorro-antd/radio'; ``` +## API + ### [nz-radio] | [nz-radio-button] | Property | Description | Type | Default | diff --git a/components/radio/doc/index.zh-CN.md b/components/radio/doc/index.zh-CN.md index c27430e5297..d4097553a11 100644 --- a/components/radio/doc/index.zh-CN.md +++ b/components/radio/doc/index.zh-CN.md @@ -12,16 +12,16 @@ title: Radio - 用于在多个备选项中选中单个状态。 - 和 Select 的区别是，Radio 所有选项默认可见，方便用户在比较中选择，因此选项不宜过多。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzRadioModule } from 'ng-zorro-antd'; +import { NzRadioModule } from 'ng-zorro-antd/radio'; ``` +## API + ### [nz-radio] | [nz-radio-button] | 参数 | 说明 | 类型 | 默认值 | diff --git a/components/rate/doc/index.en-US.md b/components/rate/doc/index.en-US.md index 281428ee74c..8a8da53ae50 100644 --- a/components/rate/doc/index.en-US.md +++ b/components/rate/doc/index.en-US.md @@ -11,16 +11,16 @@ Rate component. - Show evaluation. - A quick rating operation on something. -## API - -### Import this Component Individually +## Import this Component Individually You can get more detail [here](/docs/getting-started/en#import-a-component-individually). ```ts -import { NzRateModule } from 'ng-zorro-antd'; +import { NzRateModule } from 'ng-zorro-antd/rate'; ``` +## API + ### nz-rate | Property | Description | type | Default | diff --git a/components/rate/doc/index.zh-CN.md b/components/rate/doc/index.zh-CN.md index 1fdbf2b41fa..bc38e5f4f50 100644 --- a/components/rate/doc/index.zh-CN.md +++ b/components/rate/doc/index.zh-CN.md @@ -12,16 +12,16 @@ title: Rate - 对评价进行展示。 - 对事物进行快速的评级操作。 -## API - -### 单独引入此组件 +## 单独引入此组件 想要了解更多关于单独引入组件的内容，可以在[快速上手](/docs/getting-started/zh#单独引入某个组件)页面进行查看。 ```ts -import { NzRateModule } from 'ng-zorro-antd'; +import { NzRateModule } from 'ng-zorro-antd/rate'; ``` +## API + ### nz-rate | 属性 | 说明 | 类型 | 默认值 | diff --git a/components/select/doc/index.en-US.md b/components/select/doc/index.en-US.md index 46abd5edb3e..13a3c071e15 100644 --- a/components/select/doc/index.en-US.md +++ b/components/select/doc/index.en-US.md @@ -11,6 +11,14 @@ Select component to select value from options. - A dropdown menu for displaying choices - an elegant alternative to the native `