Skip to content

Commit

Permalink
fix(module: docs): fix progress, code-editor docs error (#8383)
Browse files Browse the repository at this point in the history
  • Loading branch information
@EnochGao
EnochGao committed Jan 31, 2024
1 parent f8b29c1 commit 407e76a
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion components/code-editor/doc/index.en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ You can set the default configuration of the `CodeEditor` component through the
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ------- |
| `assetsRoot` | Where should the component load resource of monaco editor | `string` \| `SafeUrl` | - |
| `defaultEditorOption` | Default options. [Please refer to the doc of monaco editor](https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.IEditorOptions.html) | `IEditorConstructionOptions` | `{}` |
| `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` | - |
| `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` | - |
| `onFirstEditorInit` | The hook invoked when the first monaco editor is initialized | `() => void` | - |
| `onInit` | The hook invoked every time a monaco editor is initialized | `() => void` | - |
| `useStaticLoading` | Load monaco editor statically | `boolean` | `false` |
2 changes: 1 addition & 1 deletion components/code-editor/doc/index.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ npm install monaco-editor
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ------- |
| `assetsRoot` | 组件加载 monaco editor 资源文件的位置 | `string` \| `SafeUrl` | - |
| `defaultEditorOption` | 默认的编辑器设置，[参考 monaco editor 的定义](https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.ieditorconstructionoptions.html) | `IEditorConstructionOptions` | `{}` |
| `onLoad` | 当 monaco editor 资源加载完毕时触发的钩子，此时全局对象 `monaco` 可用 (monaco-editor 版本不小于 0.22.0 时需定义 `window.MonacoEnvironment = { globalAP: true }`) | `() => void` | - |
| `onLoad` | 当 monaco editor 资源加载完毕时触发的钩子，此时全局对象 `monaco` 可用 (monaco-editor 版本不小于 0.22.0 时需定义 `window.MonacoEnvironment = { globalAPI: true }`) | `() => void` | - |
| `onFirstEditorInit` | 当第一个编辑器请求初始化时触发的钩子 | `() => void` | - |
| `onInit` | 每个编辑器请求初始化时触发的钩子 | `() => void` | - |
| `useStaticLoading` | 使用静态加载 | `boolean` | `false` |
20 changes: 10 additions & 10 deletions components/progress/doc/index.en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ import { NzProgressModule } from 'ng-zorro-antd/progress';

### nz-progress:standalone

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

### `nzType="line"`

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

### `nzType="circle"`

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

### `nzType="dashboard"`

| Property | Description | Type | Default |
| Property | Description | Type | Default | Global Config |
| ----------------- | ------------------------------------------------------------------------------------ | ---------------------------------------- | ------- | --- |
| `[nzWidth]` | to set the canvas width of the dashboard progress bar, unit: `px` | `number` | `132` |
| `[nzWidth]` | to set the canvas width of the dashboard progress bar, unit: `px` | `number` | `132` ||
| `[nzStrokeWidth]` | to set the width of the dashboard progress bar, unit: percentage of the canvas width | `number` | `6` | ✅ |
| `[nzGapDegree]` | the gap degree of half circle, 0 ~ 360 | `number` | `0` | ✅ |
| `[nzGapPosition]` | the gap position | `'top' \| 'right' \| 'bottom' \| 'left'` | `'top'` | ✅ |
18 changes: 9 additions & 9 deletions components/progress/doc/index.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,16 @@ import { NzProgressModule } from 'ng-zorro-antd/progress';

各类型通用的属性。

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

### `nzType="line"`

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

### `nzType="circle"`

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

### `nzType="dashboard"`

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

0 comments on commit 407e76a

Please sign in to comment.