forked from NG-ZORRO/ng-zorro-antd
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: documents can be converted to data (NG-ZORRO#2734)
* docs: documents can be converted to data - 使用【|】中文竖线符,表示 Union Types - 例如:【有四种选择 `success`、`info`、`warning`、`error`】**应**在【类型列】表示【`success|info|warning|error`】 - 【参数列】 - 保持纯粹性 - 例如:【`[nzValidateStatus]`(Reactive Forms)】**应**在【说明列】统一描述 - 【类型列】 - **应**包含【``】代码包裹(保护 `TemplateRef<void>` 的有效性) - 【默认值列】 - 保持纯粹性 - 例如:【`info`,`banner` 模式下默认值为 `warning`】**应**把额外描述放置【说明列】 - 无默认值时**应**使用【-】替代,“无”应替代成【-】 - 站点样式:强制移除【类型列】所有 `code` 样式 ## 完整示例 | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | `[nzBanner]` | 是否用作顶部公告 | `boolean` | `false` | | `[nzCloseText]` | 自定义关闭按钮 | `string|TemplateRef<void>` | - | | `[nzShowIcon]` | 是否显示辅助图标,`nzBanner` 模式下默认值为 `true` | `boolean` | `false` | | `[nzType]` | 指定警告提示的样式,`nzBanner` 模式下默认值为 `warning` | `success丨info丨warning丨error` | `info` | | `[nzValidateStatus]` | (Reactive Forms)会根据 FormControl 的状态自动生成校验状态 | `FormControl丨FormControlName` | `nz-form-control` 中包裹的第一个 `FormControl` | | `[nzValidateStatus]` | (Template-driven Forms)校验状态 | `success丨warning丨error丨validating` | - | * chore: remove code style in Type column * docs: fix missing & losing component name * docs: update all * chore: remove type and default column code style * chore: 移除中文竖线,全部使用英文全角坚线 * chore: 修正不同组件之间相互引用相同属性 * chore: fix losing nz-popover in english * docs: remove 'or'
- Loading branch information
Showing
107 changed files
with
1,313 additions
and
1,296 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.