Skip to content

Commit 407e76a

Browse files
EnochGaoEnochGao
authored
fix(module: docs): fix progress, code-editor docs error (#8383)
1 parent f8b29c1 commit 407e76a

4 files changed

Lines changed: 21 additions & 21 deletions

File tree

‎components/code-editor/doc/index.en-US.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ You can set the default configuration of the `CodeEditor` component through the
9393
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ------- |
9494
| `assetsRoot` | Where should the component load resource of monaco editor | `string` \| `SafeUrl` | - |
9595
| `defaultEditorOption` | Default options. [Please refer to the doc of monaco editor](https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.IEditorOptions.html) | `IEditorConstructionOptions` | `{}` |
96-
| `onLoad` | The hook invoked when the resource of monaco editor is loaded. At this moment and afterwards the global variable `monaco` is usable (`window.MonacoEnvironment = { globalAP: true }` is required if monaco-editor's version is greater or equal to 0.22.0) | `() => void` | - |
96+
| `onLoad` | The hook invoked when the resource of monaco editor is loaded. At this moment and afterwards the global variable `monaco` is usable (`window.MonacoEnvironment = { globalAPI: true }` is required if monaco-editor's version is greater or equal to 0.22.0) | `() => void` | - |
9797
| `onFirstEditorInit` | The hook invoked when the first monaco editor is initialized | `() => void` | - |
9898
| `onInit` | The hook invoked every time a monaco editor is initialized | `() => void` | - |
9999
| `useStaticLoading` | Load monaco editor statically | `boolean` | `false` |

‎components/code-editor/doc/index.zh-CN.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ npm install monaco-editor
9898
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ------- |
9999
| `assetsRoot` | 组件加载 monaco editor 资源文件的位置 | `string` \| `SafeUrl` | - |
100100
| `defaultEditorOption` | 默认的编辑器设置，[参考 monaco editor 的定义](https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.ieditorconstructionoptions.html) | `IEditorConstructionOptions` | `{}` |
101-
| `onLoad` | 当 monaco editor 资源加载完毕时触发的钩子，此时全局对象 `monaco` 可用 (monaco-editor 版本不小于 0.22.0 时需定义 `window.MonacoEnvironment = { globalAP: true }`) | `() => void` | - |
101+
| `onLoad` | 当 monaco editor 资源加载完毕时触发的钩子，此时全局对象 `monaco` 可用 (monaco-editor 版本不小于 0.22.0 时需定义 `window.MonacoEnvironment = { globalAPI: true }`) | `() => void` | - |
102102
| `onFirstEditorInit` | 当第一个编辑器请求初始化时触发的钩子 | `() => void` | - |
103103
| `onInit` | 每个编辑器请求初始化时触发的钩子 | `() => void` | - |
104104
| `useStaticLoading` | 使用静态加载 | `boolean` | `false` |

‎components/progress/doc/index.en-US.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ import { NzProgressModule } from 'ng-zorro-antd/progress';
2222

2323
### nz-progress:standalone
2424

25-
| Property | Description | Type | Default |
25+
| Property | Description | Type | Default | Global Config |
2626
| -------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------- | --- |
27-
| `[nzType]` | to set the type | `'line' \| 'circle' \| 'dashboard'` | `'line'` |
28-
| `[nzFormat]` | template function of the content | `(percent: number) => string \| TemplateRef<{ $implicit: number }>` | `percent => percent + '%'` |
29-
| `[nzPercent]` | to set the completion percentage | `number` | `0` |
27+
| `[nzType]` | to set the type | `'line' \| 'circle' \| 'dashboard'` | `'line'` ||
28+
| `[nzFormat]` | template function of the content | `(percent: number) => string \| TemplateRef<{ $implicit: number }>` | `percent => percent + '%'` ||
29+
| `[nzPercent]` | to set the completion percentage | `number` | `0` ||
3030
| `[nzShowInfo]` | whether to display the progress value and the status icon | `boolean` | `true` | ✅ |
31-
| `[nzStatus]` | to set the status of the Progress | `'success' \| 'exception' \| 'active' \| 'normal'` | - |
31+
| `[nzStatus]` | to set the status of the Progress | `'success' \| 'exception' \| 'active' \| 'normal'` | - ||
3232
| `[nzStrokeLinecap]` | to set the style of the progress linecap | `'round' \| 'square'` | `'round'` | ✅ |
3333
| `[nzStrokeColor]` | color of progress bar, render linear-gradient when passing an object | `string \| { from: string; to: string: direction: string; [percent: string]: string }` | - | ✅ |
34-
| `[nzSuccessPercent]` | segmented success percent | `number` | 0 |
34+
| `[nzSuccessPercent]` | segmented success percent | `number` | 0 ||
3535

3636
### `nzType="line"`
3737

@@ -42,16 +42,16 @@ import { NzProgressModule } from 'ng-zorro-antd/progress';
4242

4343
### `nzType="circle"`
4444

45-
| Property | Description | Type | Default |
45+
| Property | Description | Type | Default | Global Config |
4646
| ----------------- | ----------------------------------------------------------------------------------- | -------- | ------- | --- |
47-
| `[nzWidth]` | to set the canvas width of the circular progress bar, unit: `px` | `number` | `132` |
47+
| `[nzWidth]` | to set the canvas width of the circular progress bar, unit: `px` | `number` | `132` ||
4848
| `[nzStrokeWidth]` | to set the width of the circular progress bar, unit: percentage of the canvas width | `number` | `6` | ✅ |
4949

5050
### `nzType="dashboard"`
5151

52-
| Property | Description | Type | Default |
52+
| Property | Description | Type | Default | Global Config |
5353
| ----------------- | ------------------------------------------------------------------------------------ | ---------------------------------------- | ------- | --- |
54-
| `[nzWidth]` | to set the canvas width of the dashboard progress bar, unit: `px` | `number` | `132` |
54+
| `[nzWidth]` | to set the canvas width of the dashboard progress bar, unit: `px` | `number` | `132` ||
5555
| `[nzStrokeWidth]` | to set the width of the dashboard progress bar, unit: percentage of the canvas width | `number` | `6` | ✅ |
5656
| `[nzGapDegree]` | the gap degree of half circle, 0 ~ 360 | `number` | `0` | ✅ |
5757
| `[nzGapPosition]` | the gap position | `'top' \| 'right' \| 'bottom' \| 'left'` | `'top'` | ✅ |

‎components/progress/doc/index.zh-CN.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ import { NzProgressModule } from 'ng-zorro-antd/progress';
2525

2626
各类型通用的属性。
2727

28-
| 属性 | 说明 | 类型 | 默认值 |
28+
| 属性 | 说明 | 类型 | 默认值 |全局配置|
2929
| -------------------- | ---------------------------- | -------------------------------------------------------------------------------------- | -------------------------- | --- |
30-
| `[nzType]` | 类型 | `'line' \| 'circle' \| 'dashboard'` | `'line'` |
30+
| `[nzType]` | 类型 | `'line' \| 'circle' \| 'dashboard'` | `'line'` ||
3131
| `[nzFormat]` | 内容的模板函数 | `(percent: number) => string \| TemplateRef<{ $implicit: number }>` | `percent => percent + '%'` |
32-
| `[nzPercent]` | 百分比 | `number` | `0` |
32+
| `[nzPercent]` | 百分比 | `number` | `0` ||
3333
| `[nzShowInfo]` | 是否显示进度数值或状态图标 | `boolean` | `true` | ✅ |
34-
| `[nzStatus]` | 状态 | `'success' \| 'exception' \| 'active' \| 'normal'` | - |
34+
| `[nzStatus]` | 状态 | `'success' \| 'exception' \| 'active' \| 'normal'` | - ||
3535
| `[nzStrokeLinecap]` | 进度条端点形状 | `'round' \| 'square'` | `'round'` | ✅ |
3636
| `[nzStrokeColor]` | 进度条颜色，传入对象时为渐变 | `string \| { from: string; to: string: direction: string; [percent: string]: string }` | - | ✅ |
37-
| `[nzSuccessPercent]` | 已完成的分段百分比 | `number` | 0 |
37+
| `[nzSuccessPercent]` | 已完成的分段百分比 | `number` | 0 ||
3838

3939
### `nzType="line"`
4040

@@ -45,16 +45,16 @@ import { NzProgressModule } from 'ng-zorro-antd/progress';
4545

4646
### `nzType="circle"`
4747

48-
| 属性 | 说明 | 类型 | 默认值 |
48+
| 属性 | 说明 | 类型 | 默认值 |全局配置|
4949
| ----------------- | ------------------------------------------------ | -------- | ------ | --- |
50-
| `[nzWidth]` | 圆形进度条画布宽度，单位 px | `number` | `132` |
50+
| `[nzWidth]` | 圆形进度条画布宽度，单位 px | `number` | `132` ||
5151
| `[nzStrokeWidth]` | 圆形进度条线的宽度，单位是进度条画布宽度的百分比 | `number` | `6` | ✅ |
5252

5353
### `nzType="dashboard"`
5454

55-
| 属性 | 说明 | 类型 | 默认值 |
55+
| 属性 | 说明 | 类型 | 默认值 |全局配置|
5656
| ----------------- | -------------------------------------------------- | ---------------------------------------- | ------- | --- |
57-
| `[nzWidth]` | 仪表盘进度条画布宽度，单位 px | `number` | `132` |
57+
| `[nzWidth]` | 仪表盘进度条画布宽度，单位 px | `number` | `132` ||
5858
| `[nzStrokeWidth]` | 仪表盘进度条线的宽度，单位是进度条画布宽度的百分比 | `number` | `6` | ✅ |
5959
| `[nzGapDegree]` | 仪表盘进度条缺口角度，可取值 0 ~ 360 | `number` | `0` | ✅ |
6060
| `[nzGapPosition]` | 仪表盘进度条缺口位置 | `'top' \| 'right' \| 'bottom' \| 'left'` | `'top'` | ✅ |

0 commit comments

Comments
 (0)