docs(radio, metion): update api table(#532)

* docs(icon): 更新图标组件的说明文档

* docs(pageHeader): 更新页头组件的说明文档

* docs(pageHeader): 更新页头组件的文档中的错别字

* docs(typography): 更新排印组件的说明文档

* Update src/typography/demos/zhCN/index.demo-entry.md

* docs(mention): 更新提及组件的说明文档

* docs(mention): 更新提及组件的一部分参数说明

* docs(radio): 更新单选组件的说明文档

Co-authored-by: 07akioni <07akioni2@gmail.com>
This commit is contained in:
songjianet 2021-07-17 22:11:49 +08:00 committed by GitHub
parent daae2e77b3
commit d994613a5e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 19 deletions

View File

@ -19,19 +19,20 @@ size
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| checked | `boolean` | `undefined` | |
| default-checked | `boolean` | `false` | |
| checked | `boolean` | `undefined` | Checked status. |
| default-checked | `boolean` | `false` | Default checked status. |
| disabled | `boolean` | `false` | Disabled status. |
| name | `string` | `undefined` | The name attribute of the radio element. If not set, name of `radio-group` will be used. |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | 只用于 `n-radio` |
| value | `string` | `undefined` | |
| on-update:checked | `(check: boolean) => void` | `undefined` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | Size. |
| value | `string` | `undefined` | Checked value. |
| on-update:checked | `(check: boolean) => void` | `undefined` | Callback method triggered when a change occurs. |
### RadioGroup Props
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| disabled | `boolean` | `false` | |
| disabled | `boolean` | `false` | Disabled status. |
| name | `string` | `undefined` | The name attribute of the radio elements inside the group. |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `string \| null` | `null` | |
| on-update:value | `(value: string) => void` | `undefined` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | Size. |
| value | `string \| null` | `null` | Checked value. |
| on-update:value | `(value: string) => void` | `undefined` | Callback method triggered when a change occurs. |

View File

@ -20,20 +20,20 @@ radio-focus-debug
| 名称 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| checked | `boolean` | `undefined` | |
| default-checked | `boolean` | `false` | |
| disabled | `boolean` | `false` | |
| checked | `boolean` | `undefined` | 选中状态 |
| default-checked | `boolean` | `false` | 默认选中的状态 |
| disabled | `boolean` | `false` | 禁用状态 |
| name | `string` | `undefined` | 单选按钮 radio 元素的 name 属性。如果没有设定会使用 `n-radio-group``name` |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `string` | `undefined` | |
| on-update:checked-value | `(checked: boolean) => void` | `undefined` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | 大小 |
| value | `string` | `undefined` | 选中的值 |
| on-update:checked-value | `(checked: boolean) => void` | `undefined` | 发生变化时触发的回调方法 |
### RadioGroup Props
| 名称 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| disabled | `boolean` | `false` | |
| disabled | `boolean` | `false` | 禁用状态 |
| name | `string` | `undefined` | 选项组内部 radio 元素的 name 属性 |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| value | `string \| null` | `null` | |
| on-update:value | `(value: string) => void` | `undefined` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | 大小 |
| value | `string \| null` | `null` | 选中的值 |
| on-update:value | `(value: string) => void` | `undefined` | 发生变化时触发的回调方法 |