mirror/naive-ui
2
0
Fork 0
mirror of https://github.com/tusen-ai/naive-ui.git synced 2025-01-06 12:17:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(descriptions): add description in api table (#297)

Browse Source 
* docs: add descriptions doc

* feat: add descript docs

* Update src/descriptions/demos/enUS/index.demo-entry.md

Co-authored-by: 07akioni <07akioni2@gmail.com>

* Update src/descriptions/demos/enUS/index.demo-entry.md

Co-authored-by: 07akioni <07akioni2@gmail.com>

* Update src/descriptions/demos/enUS/index.demo-entry.md

Co-authored-by: 07akioni <07akioni2@gmail.com>

* Update src/descriptions/demos/enUS/index.demo-entry.md

Co-authored-by: 07akioni <07akioni2@gmail.com>

* fix: change zhCN docs

Co-authored-by: yugang.cao <yugang.cao@tusimple.ai>
Co-authored-by: 07akioni <07akioni2@gmail.com>
This commit is contained in:
caoyugang_1 2021-06-26 00:07:16 +08:00 committed by GitHub
parent c371207c36
commit cf01833f1c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 38 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/descriptions/demos/enUS/index.demo-entry.md
View File

@ -21,32 +21,32 @@ size
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| bordered | `boolean` | `false` | |
| column | `number` | `3` | |
| label-align | `'center' \| 'left' \| 'right'` | `'left'` | |
| label-placement | `'top' \| 'left'` | `'top'` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| title | `string` | `undefined` | |
| bordered | `boolean` | `false` | Whether to display border. |
| column | `number` | `3` | Total columns. |
| label-align | `'center' \| 'left' \| 'right'` | `'left'` | Label align. |
| label-placement | `'top' \| 'left'` | `'top'` | Label placement. |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | Size of the description. |
| title | `string` | `undefined` | Title of the description. |
### Description Item Props
| Name | Type | Default | Description |
| ----- | -------- | ----------- | ----------- |
| label | `string` | `undefined` | |
| span | `number` | `1` | |
| Name | Type | Default | Description |
| ----- | -------- | ----------- | ------------------------ |
| label | `string` | `undefined` | Label of the item. |
| span | `number` | `1` | Column span of the item. |
## Slots
### Descriptions Slots
| Name | Parameters | Description |
| ------- | ---------- | ----------- |
| default | `()` | |
| header | `()` | |
| Name | Parameters | Description |
| ------- | ---------- | --------------- |
| default | `()` | Content. |
| header | `()` | Header content. |
### Description Item Slots
| Name | Parameters | Description |
| ------- | ---------- | ----------- |
| default | `()` | |
| label | `()` | |
| Name | Parameters | Description |
| ------- | ---------- | ------------- |
| default | `()` | Item content. |
| label | `()` | Item label. |

40
src/descriptions/demos/zhCN/index.demo-entry.md
View File

@ -19,34 +19,34 @@ size
### Descriptions Props
| 名称 | 类型 | 默认值 | 说明 |
| --------------- | -------------------------------- | ----------- | ---- |
| bordered | `boolean` | `false` | |
| column | `number` | `3` | |
| label-align | `'center' \| 'left' \| 'right'` | `'left'` | |
| label-placement | `'top' \| 'left'` | `'top'` | |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | |
| title | `string` | `undefined` | |
| 名称 | 类型 | 默认值 | 说明 |
| --- | --- | --- | --- |
| bordered | `boolean` | `false` | 是否显示 border |
| column | `number` | `3` | 设置的总列数 |
| label-align | `'center' \| 'left' \| 'right'` | `'left'` | label 对齐方式 |
| label-placement | `'top' \| 'left'` | `'top'` | label 显示位置 |
| size | `'small' \| 'medium' \| 'large'` | `'medium'` | 尺寸 |
| title | `string` | `undefined` | 标题 |
### Description Item Props
| 名称 | 类型 | 默认值 | 说明 |
| ----- | -------- | ----------- | ---- |
| label | `string` | `undefined` | |
| span | `number` | `1` | |
| 名称 | 类型 | 默认值 | 说明 |
| ----- | -------- | ----------- | --------------- |
| label | `string` | `undefined` | 显示的 label 值 |
| span | `number` | `1` | 所占的单元格数 |
## Slots
### Descriptions Slots
| 名称 | 参数 | 说明 |
| ------- | ---- | ---- |
| default | `()` | |
| header | `()` | |
| 名称 | 参数 | 说明 |
| ------- | ---- | ----------- |
| default | `()` | 描述的内容 |
| header | `()` | header 内容 |
### Description Item Slots
| 名称 | 参数 | 说明 |
| ------- | ---- | ---- |
| default | `()` | |
| label | `()` | |
| 名称 | 参数 | 说明 |
| ------- | ---- | ------------------- |
| default | `()` | 描述项的内容 |
| label | `()` | 描述项的 label 信息 |