mirror/element-plus
2
0
Fork 0
mirror of https://github.com/element-plus/element-plus.git synced 2025-01-18 10:59:10 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(components): update docs (#5854)

Browse Source 
* docs(components): update docs
This commit is contained in:
C.Y.Kun 2022-02-11 20:29:52 +08:00 committed by GitHub
parent fc294561c2
commit f9a6bd8444
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 21 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/en-US/component/date-picker.md
View File

@ -163,8 +163,9 @@ Note, date time locale (month name, first day of the week ...) are also configur
| prefix-icon | custom prefix icon component | string / Component | — | Date |
| clear-icon | custom clear icon component | string / Component | — | CircleClose |
| validate-event | whether to trigger form validation | boolean | - | true |
| disabledDate | a function determining if a date is disabled with that date as its parameter. Should return a Boolean | function | — | — |
| disabled-date | a function determining if a date is disabled with that date as its parameter. Should return a Boolean | function | — | — |
| shortcuts | an object array to set shortcut options | object[{ text: string, value: date / function }] | — | — |
| cell-class-name | set custom className | Function(Date) | — | — |
## Events

11
docs/en-US/component/datetime-picker.md
View File

@ -81,8 +81,8 @@ datetime-picker/default-time
| id | same as `id` in native input | string / array(string) | String `id="my-datetime"` or array `:id="['my-range-start', 'my-range-end']"` for date range | - |
| name | same as `name` in native input | string | — | — |
| unlink-panels | unllink two date-panels in range-picker | boolean | — | false |
| prefix-icon | Custom prefix icon component | string | — | Date |
| clear-icon | Custom clear icon component | string | — | CircleClose |
| prefix-icon | Custom prefix icon component | string / Component | — | Date |
| clear-icon | Custom clear icon component | string / Component | — | CircleClose |
| shortcuts | an object array to set shortcut options | object[{ text: string, value: date / function }] | — | — |
| disabledDate | a function determining if a date is disabled with that date as its parameter. Should return a Boolean | function | — | — |
| cellClassName | set custom className | Function(Date) | — | — |
@ -102,3 +102,10 @@ datetime-picker/default-time
| Method | Description | Parameters |
| ------ | ------------------------- | ---------- |
| focus | focus the Input component | — |
## Slots
| Name | Description |
| --------------- | ------------------------------ |
| default | custom cell content |
| range-separator | custom range separator content |

2
docs/en-US/component/dropdown.md
View File

@ -130,7 +130,7 @@ dropdown/sizes
| command | a command to be dispatched to Dropdown's `command` callback | string/number/object | — | — |
| disabled | whether the item is disabled | boolean | — | false |
| divided | whether a divider is displayed | boolean | — | false |
| icon | icon class name | string | — | — |
| icon | custom icon | string / Component | — | — |
## Dropdown-Item Slots

4
docs/en-US/component/input.md
View File

@ -212,8 +212,8 @@ input/length-limiting
| name | same as `name` in native input | string | — | — |
| select-when-unmatched | whether to emit a `select` event on enter when there is no autocomplete match | boolean | — | false |
| label | label text | string | — | — |
| prefix-icon | prefix icon class | string | — | — |
| suffix-icon | suffix icon class | string | — | — |
| prefix-icon | prefix icon class | string / Component | — | — |
| suffix-icon | suffix icon class | string / Component | — | — |
| hide-loading | whether to hide the loading icon in remote search | boolean | — | false |
| popper-append-to-body(deprecated) | whether to append the dropdown to body. If the positioning of the dropdown is wrong, you can try to set this prop to false | boolean | - | false |
| teleported | whether select dropdown is teleported to the body | boolean | true / false | true |

4
docs/en-US/component/steps.md
View File

@ -98,10 +98,10 @@ steps/simple
## Step Attributes
| Attribute | Description | Type | Accepted Values | Default |
| ----------- | ------------------------------------------------------------------------ | ------ | ----------------------------------------- | ------- |
| ----------- | ------------------------------------------------------------------------ | ------------------ | ----------------------------------------- | ------- |
| title | step title | string | — | — |
| description | step description | string | — | — |
| icon | step icon's class name. Icons can be passed via named slot as well | string | — | — |
| icon | step custom icon. Icons can be passed via named slot as well | string / Component | — | — |
| status | current status. It will be automatically set by Steps if not configured. | string | wait / process / finish / error / success | — |
## Step Slots

2
docs/en-US/component/tree-v2.md
View File

@ -84,7 +84,7 @@ tree-v2/filter
| current-node-key | key of initially selected node | string, number | — |
| filter-method | this function will be executed on each node when use filter method. if return `false`, tree node will be hidden. | Function(value, data) | — |
| indent | horizontal indentation of nodes in adjacent levels in pixels | number | 16 |
| icon | custome tree node icon | string | - |
| icon | custome tree node icon | string / Component | - |
## props

1
docs/en-US/component/upload.md
View File

@ -111,7 +111,6 @@ upload/manual
| on-change | hook function when select file or upload file success or upload file fail | function(file, fileList) | — | — |
| before-upload | hook function before uploading with the file to be uploaded as its parameter. If `false` is returned or a `Promise` is returned and then is rejected, uploading will be aborted | function(file) | — | — |
| before-remove | hook function before removing a file with the file and file list as its parameters. If `false` is returned or a `Promise` is returned and then is rejected, removing will be aborted. | function(file, fileList) | — | — |
| thumbnail-mode | whether thumbnail is displayed | boolean | — | false |
| file-list | default uploaded files, e.g. [{name: 'food.jpg', url: 'https://xxx.cdn.com/xxx.jpg'}] | array | — | [] |
| list-type | type of fileList | string | text/picture/picture-card | text |
| auto-upload | whether to auto upload file | boolean | — | true |