docs: replace the new tag with the supported version of the component (…

…#8500) * docs: replace the new tag with the supported version of the component * docs: replace the new tag with the supported version of the component * docs: improve style of menus * docs: fix menu tag style Co-authored-by: HyperLife1119 <hyperlife1119@qq.com> * docs: fix menu tag style * docs: fix codefactor issue --------- Co-authored-by: hyperlife1119 <hyperlife1119@qq.com>
NG-ZORRO · Apr 18, 2024 · 201d0c2 · 201d0c2
1 parent ee68a2c
commit 201d0c2
Show file tree

Hide file tree

Showing 12 changed files with 173 additions and 112 deletions.
diff --git a/components/color-picker/doc/index.en-US.md b/components/color-picker/doc/index.en-US.md
@@ -2,18 +2,28 @@
 category: Components
 type: Data Entry
 title: ColorPicker
-tag: New
+tag: 16.2.0
 cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*PpY4RYNM8UcAAAAAAAAAAAAADrJ8AQ/original
 ---
 
 ## When To Use
 
 Used when the user needs to customize the color selection.
 
+### Import Module
+
+module:
+
 ```ts
 import { NzColorPickerModule } from 'ng-zorro-antd/color-picker';
 ```
 
+standalone:
+
+```ts
+import { NzColorPickerComponent } from 'ng-zorro-antd/color-picker';
+```
+
 ## API
 
 ### nz-color-picker:standalone

diff --git a/components/color-picker/doc/index.zh-CN.md b/components/color-picker/doc/index.zh-CN.md
@@ -3,18 +3,28 @@ category: Components
 subtitle: 颜色选择器
 type: 数据录入
 title: ColorPicker
-tag: New
+tag: 16.2.0
 cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*PpY4RYNM8UcAAAAAAAAAAAAADrJ8AQ/original
 ---
 
 ## 何时使用
 
 当用户需要自定义颜色选择的时候使用。
 
+### 引入模块
+
+module:
+
 ```ts
 import { NzColorPickerModule } from 'ng-zorro-antd/color-picker';
 ```
 
+standalone:
+
+```ts
+import { NzColorPickerComponent } from 'ng-zorro-antd/color-picker'
+```
+
 ## API
 
 ### nz-color-picker:standalone

diff --git a/components/flex/doc/index.en-US.md b/components/flex/doc/index.en-US.md
@@ -4,10 +4,10 @@ type: Layout
 cols: 1
 title: Flex
 cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*SMzgSJZE_AwAAAAAAAAAAAAADrJ8AQ/original
-tag: New
+tag: 17.1.0
 ---
 
-Wrapper for `Display: flex`.
+Wrapper for `display: flex`.
 
 ## When To Use
 
@@ -16,8 +16,10 @@ Wrapper for `Display: flex`.
 
 ### Difference with Space component
 
-- Space is used to set the spacing between inline elements. It will add a wrapper element for each child element for inline alignment. Suitable for equidistant arrangement of multiple child elements in rows and columns.
-- Flex is used to set the layout of block-level elements. It does not add a wrapper element. Suitable for layout of child elements in vertical or horizontal direction, and provides more flexibility and control.
+- Space is used to set the spacing between inline elements. It will add a wrapper element for each child element for
+  inline alignment. Suitable for equidistant arrangement of multiple child elements in rows and columns.
+- Flex is used to set the layout of block-level elements. It does not add a wrapper element. Suitable for layout of
+  child elements in vertical or horizontal direction, and provides more flexibility and control.
 
 ### Import Module
 
@@ -30,7 +32,7 @@ import { NzFlexModule } from 'ng-zorro-antd/flex';
 ### [nz-flex]:standalone
 
 | Property       | Description                                                                | Type                                                                                          | Default    |
-| -------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ---------- |
+|----------------|----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|------------|
 | `[nzVertical]` | Is direction of the flex vertical, use `flex-direction: column`            | `boolean`                                                                                     | `false`    |
 | `[nzJustify]`  | Sets the alignment of elements in the direction of the main axis           | reference [justify-content](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content) | `'normal'` |
 | `[nzAlign]`    | Sets the alignment of elements in the direction of the cross axis          | reference [align-items](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items)         | `'normal'` |

diff --git a/components/flex/doc/index.zh-CN.md b/components/flex/doc/index.zh-CN.md
@@ -5,7 +5,7 @@ type: 布局
 cols: 1
 title: Flex
 cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*SMzgSJZE_AwAAAAAAAAAAAAADrJ8AQ/original
-tag: New
+tag: 17.1.0
 ---
 
 弹性布局
@@ -30,11 +30,11 @@ import { NzFlexModule } from 'ng-zorro-antd/flex';
 
 ### [nz-flex]:standalone
 
-| 参数  | 说明   | 类型   | 默认值  |
-| -------- | ---------------- | --------------- | ---------- |
-| `[nzVertical]` | 使用 `flex-direction: column`描述flex的垂直方向  | `boolean`  | `false`  |
-| `[nzJustify]` | 设置元素在主轴方向上的对齐方式，参照 [justify-content](https://developer.mozilla.org/zh-CN/docs/Web/CSS/justify-content) | `NzJustify` | `'normal'` |
-| `[nzAlign]` | 设置元素在交叉轴方向上的对齐方式，参照 [align-items](https://developer.mozilla.org/zh-CN/docs/Web/CSS/align-items) | `NzAlign` | `'normal'` |
-| `[nzGap]`  | 设置项目的间隙   | `'small' \| 'middle' \| 'large' \| number \| string`    | `0`    |
-| `[nzWrap]` | 指定 flex 元素单行显示还是多行显示，参照 [flex-wrap](https://developer.mozilla.org/zh-CN/docs/Web/CSS/flex-wrap) | `NzWrap` | `'nowrap'` |
-| `[nzFlex]` | flex css简写属性，参照 [flex](https://developer.mozilla.org/zh-CN/docs/Web/CSS/flex)   |   `NzFlex`   | `'unset'` |
+| 参数             | 说明                                                                                                     | 类型                                                   | 默认值        |
+|----------------|--------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------|
+| `[nzVertical]` | 使用 `flex-direction: column`描述flex的垂直方向                                                                 | `boolean`                                            | `false`    |
+| `[nzJustify]`  | 设置元素在主轴方向上的对齐方式，参照 [justify-content](https://developer.mozilla.org/zh-CN/docs/Web/CSS/justify-content) | `NzJustify`                                          | `'normal'` |
+| `[nzAlign]`    | 设置元素在交叉轴方向上的对齐方式，参照 [align-items](https://developer.mozilla.org/zh-CN/docs/Web/CSS/align-items)        | `NzAlign`                                            | `'normal'` |
+| `[nzGap]`      | 设置项目的间隙                                                                                                | `'small' \| 'middle' \| 'large' \| number \| string` | `0`        |
+| `[nzWrap]`     | 指定 flex 元素单行显示还是多行显示，参照 [flex-wrap](https://developer.mozilla.org/zh-CN/docs/Web/CSS/flex-wrap)        | `NzWrap`                                             | `'nowrap'` |
+| `[nzFlex]`     | flex css简写属性，参照 [flex](https://developer.mozilla.org/zh-CN/docs/Web/CSS/flex)                          | `NzFlex`                                             | `'unset'`  |
diff --git a/components/hash-code/doc/index.en-US.md b/components/hash-code/doc/index.en-US.md
@@ -2,21 +2,25 @@
 category: Components
 type: Featured Components
 title: HashCode
-tag: New
+tag: 17.0.0
 cover: https://img.alicdn.com/imgextra/i3/O1CN01ePPF8q1cxXFz041Q9_!!6000000003667-0-tps-172-57.jpg
 ---
 
 ## Import Module
 
-- The hash code component is styled for 64-bit design, and if the data given is less than or more than 64-bit, it may bring some differences in presentation.
+The hash code component is styled for 64-bit design, and if the data given is less than or more than 64-bit, it may
+bring some differences in presentation.
 
 ### Import Module
 
 module:
+
 ```ts
 import { NzHashCodeModule } from 'ng-zorro-antd/hash-code';
 ```
+
 standalone:
+
 ```ts
 import { NzHashCodeComponent } from 'ng-zorro-antd/hash-code';
 ```
@@ -25,11 +29,11 @@ import { NzHashCodeComponent } from 'ng-zorro-antd/hash-code';
 
 ### nz-hashCode:standalone
 
-| Property              | Description                                         | Type                            | Default   |
-| -------------- |-----------------------------------------------------|-------------------------------------|------------|
-| `[nzValue]`    | The value of the hash code                          | `string`                            | -          |
-| `[nzTitle]`    | Description of the content in the upper left corner | `string`                            | `HashCode` |
-| `[nzLogo]` | Display in the upper right corner                   | `TemplateRef<void> \| string`       | -          |
-| `[nzMode]`     | Demonstration Mode               | `single \| double \| strip \| rect` | `double`   |
-| `[nzType]`  | style             | `defalut \| primary`                | `primary`  |
-| `(nzOnCopy)`  | Clicking the Copy callback            | `EventEmitter<string>`              | -          |
+| Property     | Description                                         | Type                                | Default    |
+|--------------|-----------------------------------------------------|-------------------------------------|------------|
+| `[nzValue]`  | The value of the hash code                          | `string`                            | -          |
+| `[nzTitle]`  | Description of the content in the upper left corner | `string`                            | `HashCode` |
+| `[nzLogo]`   | Display in the upper right corner                   | `TemplateRef<void> \| string`       | -          |
+| `[nzMode]`   | Demonstration Mode                                  | `single \| double \| strip \| rect` | `double`   |
+| `[nzType]`   | style                                               | `defalut \| primary`                | `primary`  |
+| `(nzOnCopy)` | Clicking the Copy callback                          | `EventEmitter<string>`              | -          |
diff --git a/components/hash-code/doc/index.zh-CN.md b/components/hash-code/doc/index.zh-CN.md
@@ -3,21 +3,24 @@ category: Components
 subtitle: 哈希码
 type: 特色组件
 title: HashCode
-tag: New
+tag: 17.0.0
 cover: https://img.alicdn.com/imgextra/i3/O1CN01ePPF8q1cxXFz041Q9_!!6000000003667-0-tps-172-57.jpg
 ---
 
 ## 何时使用
 
-- 哈希码组件是以 64 位设计的样式，如果给出的数据不足或者高于 64 位，可能会带来一些展示上的差异。
+哈希码组件是以 64 位设计的样式，如果给出的数据不足或者高于 64 位，可能会带来一些展示上的差异。
 
 ### 引入模块
 
 module:
+
 ```ts
 import { NzHashCodeModule } from 'ng-zorro-antd/hash-code';
 ```
+
 standalone:
+
 ```ts
 import { NzHashCodeComponent } from 'ng-zorro-antd/hash-code';
 ```
@@ -27,10 +30,10 @@ import { NzHashCodeComponent } from 'ng-zorro-antd/hash-code';
 ### nz-hashCode:standalone
 
 | 参数           | 说明        | 类型                                  | 默认值        |
-| -------------- |-----------|-------------------------------------|------------|
-| `[nzValue]`    | 哈希码的值     | `string`                            | -          |
-| `[nzTitle]`    | 左上角的描述内容  | `string`                            | `HashCode` |
-| `[nzLogo]` | 右上角的展示    | `TemplateRef<void> \| string`       | -          |
-| `[nzMode]`     | 展示模式      | `single \| double \| strip \| rect` | `double`   |
-| `[nzType]`  | 样式        | `defalut \| primary`                | `primary`  |
-| `(nzOnCopy)`  | 点击"复制"的回调 | `EventEmitter<string>`              | -          |
+|--------------|-----------|-------------------------------------|------------|
+| `[nzValue]`  | 哈希码的值     | `string`                            | -          |
+| `[nzTitle]`  | 左上角的描述内容  | `string`                            | `HashCode` |
+| `[nzLogo]`   | 右上角的展示    | `TemplateRef<void> \| string`       | -          |
+| `[nzMode]`   | 展示模式      | `single \| double \| strip \| rect` | `double`   |
+| `[nzType]`   | 样式        | `defalut \| primary`                | `primary`  |
+| `(nzOnCopy)` | 点击"复制"的回调 | `EventEmitter<string>`              | -          |
diff --git a/components/qr-code/doc/index.en-US.md b/components/qr-code/doc/index.en-US.md
@@ -2,7 +2,7 @@
 category: Components
 type: Data Display
 title: QRCode
-tag: New
+tag: 15.1.0
 cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*cJopQrf0ncwAAAAAAAAAAAAADrJ8AQ/original
 ---
 
@@ -20,30 +20,36 @@ import { NzQRCodeModule } from 'ng-zorro-antd/qr-code';
 
 ### nz-qrcode:standalone
 
-| Property       | Description                         | Type                              | Default   |
-| -------------- | ----------------------------------- | --------------------------------- | --------- |
-| `[nzValue]`    | scanned link                        | `string`                          | -         |
-| `[nzColor]`    | QR code Color                       | `string`                          | `#000`    |
-| `[nzBgColor]`  | QR code background color            | `string`                          | `#FFFFFF` |
-| `[nzSize]`     | QR code Size                        | `number`                          | `160`     |
-| `[nzPadding]`  | QR code Padding                     | `number \| number[]`              | `0`       |
-| `[nzIcon]`     | Icon address in QR code             | `string`                          | -         |
-| `[nzIconSize]` | The size of the icon in the QR code | `number`                          | `40`      |
-| `[nzBordered]` | Whether has border style            | `boolean`                         | `true`    |
+| Property       | Description                         | Type                            | Default   |
+|----------------|-------------------------------------|---------------------------------|-----------|
+| `[nzValue]`    | scanned link                        | `string`                        | -         |
+| `[nzColor]`    | QR code Color                       | `string`                        | `#000`    |
+| `[nzBgColor]`  | QR code background color            | `string`                        | `#FFFFFF` |
+| `[nzSize]`     | QR code Size                        | `number`                        | `160`     |
+| `[nzPadding]`  | QR code Padding                     | `number \| number[]`            | `0`       |
+| `[nzIcon]`     | Icon address in QR code             | `string`                        | -         |
+| `[nzIconSize]` | The size of the icon in the QR code | `number`                        | `40`      |
+| `[nzBordered]` | Whether has border style            | `boolean`                       | `true`    |
 | `[nzStatus]`   | QR code status                      | `'active'｜'expired' ｜'loading'` | `active`  |
-| `[nzLevel]`    | Error Code Level                    | `'L'｜'M'｜'Q'｜'H'`              | `M`       |
-| `(nzRefresh)`  | callback                            | `EventEmitter<string>`            | -         |
+| `[nzLevel]`    | Error Code Level                    | `'L'｜'M'｜'Q'｜'H'`               | `M`       |
+| `(nzRefresh)`  | callback                            | `EventEmitter<string>`          | -         |
 
 ## Note
 
 ### Invalid QR Code
 
-`nzValue` has a conservative upper limit of 738 or fewer strings. If error correction levels are used, the `nzValue` upper limit will be lowered.
+`nzValue` has a conservative upper limit of 738 or fewer strings. If error correction levels are used, the `nzValue`
+upper limit will be lowered.
 
 ### QR Code error correction level
 
-The ErrorLevel means that the QR code can be scanned normally after being blocked, and the maximum area that can be blocked is the error correction rate.
+The ErrorLevel means that the QR code can be scanned normally after being blocked, and the maximum area that can be
+blocked is the error correction rate.
 
-Generally, the QR code is divided into 4 error correction levels: Level `L` can correct about `7%` errors, Level `M` can correct about `15%` errors, Level `Q` can correct about `25%` errors, and Level `H` can correct about `30%` errors. When the content encoding of the QR code carries less information, in other words, when the value link is short, set different error correction levels, and the generated image will not change.
+Generally, the QR code is divided into 4 error correction levels: Level `L` can correct about `7%` errors, Level `M` can
+correct about `15%` errors, Level `Q` can correct about `25%` errors, and Level `H` can correct about `30%` errors. When
+the content encoding of the QR code carries less information, in other words, when the value link is short, set
+different error correction levels, and the generated image will not change.
 
-> For more information, see the: [https://www.qrcode.com/en/about/error_correction](https://www.qrcode.com/en/about/error_correction.html)
+> For more information, see
+> the: [https://www.qrcode.com/en/about/error_correction](https://www.qrcode.com/en/about/error_correction.html)