test/element-plus
1
0
Fork 0
mirror of https://gitee.com/element-plus/element-plus.git synced 2024-11-29 17:58:08 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: move deprecated APIs to the end of the table (#18547)

Browse Source
This commit is contained in:
dopamine 2024-10-15 08:10:59 +08:00 committed by GitHub
parent 72dd11aac2
commit da3e68791b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
18 changed files with 48 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/en-US/component/autocomplete.md
View File

@ -67,10 +67,10 @@ autocomplete/custom-loading
| aria-label ^(a11y) ^(2.7.2) | native `aria-label` attribute | ^[string] | — | | aria-label ^(a11y) ^(2.7.2) | native `aria-label` attribute | ^[string] | — |
| hide-loading | whether to hide the loading icon in remote search | ^[boolean] | false | | hide-loading | whether to hide the loading icon in remote search | ^[boolean] | false |
| popper-class | custom class name for autocomplete's dropdown | ^[string] | — | | popper-class | custom class name for autocomplete's dropdown | ^[string] | — |
| 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 | | teleported | whether select dropdown is teleported to the body | ^[boolean] | true |
| highlight-first-item | whether to highlight first item in remote search suggestions by default | ^[boolean] | false | | highlight-first-item | whether to highlight first item in remote search suggestions by default | ^[boolean] | false |
| fit-input-width | whether the width of the dropdown is the same as the input | ^[boolean] | false | | fit-input-width | whether the width of the dropdown is the same as the input | ^[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 |
### Events ### Events
@ -96,18 +96,18 @@ autocomplete/custom-loading
### Exposes ### Exposes
| Name | Description | Type | | Name | Description | Type |
| ---------------- | ------------------------------------------- | ----------------------------------------- | | ---------------- | ------------------------------------------- | ------------------------------------------ |
| activated | if autocomplete activated | ^[object]`Ref<boolean>` | | activated | if autocomplete activated | ^[object]`Ref<boolean>` |
| blur | blur the input element | ^[Function]`() => void` | | blur | blur the input element | ^[Function]`() => void` |
| close | collapse suggestion list | ^[Function]`() => void` | | close | collapse suggestion list | ^[Function]`() => void` |
| focus | focus the input element | ^[Function]`() => void` | | focus | focus the input element | ^[Function]`() => void` |
| handleSelect | triggers when a suggestion is clicked | ^[Function]`(item: any) => promise<void>` | | handleSelect | triggers when a suggestion is clicked | ^[Function]`(item: any) => promise<void>` |
| handleKeyEnter | handle keyboard enter event | ^[Function]`() => promise<void>` | | handleKeyEnter | handle keyboard enter event | ^[Function]`() => promise<void>` |
| highlightedIndex | the index of the currently highlighted item | ^[object]`Ref<number>` | | highlightedIndex | the index of the currently highlighted item | ^[object]`Ref<number>` |
| highlight | highlight an item in a suggestion | ^[Function]`(itemIndex: number) => void` | | highlight | highlight an item in a suggestion | ^[Function]`(itemIndex: number) => void` |
| inputRef | el-input component instance | ^[object]`Ref<ElInputInstance>` | | inputRef | el-input component instance | ^[object]`Ref<ElInputInstance>` |
| loading | remote search loading indicator | ^[object]`Ref<boolean>` | | loading | remote search loading indicator | ^[object]`Ref<boolean>` |
| popperRef | el-tooltip component instance | ^[object]`Ref<ElTooltipInstance>` | | popperRef | el-tooltip component instance | ^[object]`Ref<ElTooltipInstance>` |
| suggestions | fetch suggestions result | ^[object]`Ref<record<string, any>>` | | suggestions | fetch suggestions result | ^[object]`Ref<record<string, any>>` |
| getData ^(2.8.4) | loading suggestion list | ^[Function]`(queryString: string) => void`| | getData ^(2.8.4) | loading suggestion list | ^[Function]`(queryString: string) => void` |

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

@ -150,7 +150,6 @@ cascader/panel
| before-filter | hook function before filtering with the value to be filtered as its parameter. If `false` is returned or a `Promise` is returned and then is rejected, filtering will be aborted | ^[Function]`(value: string) => boolean` | — | | before-filter | hook function before filtering with the value to be filtered as its parameter. If `false` is returned or a `Promise` is returned and then is rejected, filtering will be aborted | ^[Function]`(value: string) => boolean` | — |
| popper-class | custom class name for Cascader's dropdown | ^[string] | '' | | popper-class | custom class name for Cascader's dropdown | ^[string] | '' |
| teleported | whether cascader popup is teleported | ^[boolean] | true | | teleported | whether cascader popup is teleported | ^[boolean] | true |
| popper-append-to-body ^(deprecated) | whether to append the popper menu to body. If the positioning of the popper is wrong, you can try to set this prop to false | ^[boolean] | true |
| tag-type | tag type | ^[enum]`'success' \| 'info' \| 'warning' \| 'danger'` | info | | tag-type | tag type | ^[enum]`'success' \| 'info' \| 'warning' \| 'danger'` | info |
| tag-effect ^(2.7.8) | tag effect | ^[enum]`'light' \| 'dark' \| 'plain'` | light | | tag-effect ^(2.7.8) | tag effect | ^[enum]`'light' \| 'dark' \| 'plain'` | light |
| validate-event | whether to trigger form validation | ^[boolean] | true | | validate-event | whether to trigger form validation | ^[boolean] | true |
@ -160,6 +159,7 @@ cascader/panel
| persistent ^(2.7.8) | when dropdown is inactive and `persistent` is `false`, dropdown will be destroyed | ^[boolean] | true | | persistent ^(2.7.8) | when dropdown is inactive and `persistent` is `false`, dropdown will be destroyed | ^[boolean] | true |
| fallback-placements ^(2.8.1) | list of possible positions for Tooltip [popper.js](https://popper.js.org/docs/v2/modifiers/flip/#fallbackplacements) | ^[arrary]`Placement[]` | — | | fallback-placements ^(2.8.1) | list of possible positions for Tooltip [popper.js](https://popper.js.org/docs/v2/modifiers/flip/#fallbackplacements) | ^[arrary]`Placement[]` | — |
| placement ^(2.8.1) | position of dropdown | ^[enum]`'top' \| 'top-start' \| 'top-end' \| 'bottom' \| 'bottom-start' \| 'bottom-end' \| 'left' \| 'left-start' \| 'left-end' \| 'right' \| 'right-start' \| 'right-end'` | bottom-start | | placement ^(2.8.1) | position of dropdown | ^[enum]`'top' \| 'top-start' \| 'top-end' \| 'bottom' \| 'bottom-start' \| 'bottom-end' \| 'left' \| 'left-start' \| 'left-end' \| 'right' \| 'right-start' \| 'right-end'` | bottom-start |
| popper-append-to-body ^(deprecated) | whether to append the popper menu to body. If the positioning of the popper is wrong, you can try to set this prop to false | ^[boolean] | true |
### Cascader Events ### Cascader Events
@ -188,7 +188,7 @@ cascader/panel
| cascaderPanelRef | cascader panel ref | ^[object]`ComputedRef<any>` | | cascaderPanelRef | cascader panel ref | ^[object]`ComputedRef<any>` |
| togglePopperVisible ^(2.2.31) | toggle the visible type of popper | ^[Function]`(visible?: boolean) => void` | | togglePopperVisible ^(2.2.31) | toggle the visible type of popper | ^[Function]`(visible?: boolean) => void` |
| contentRef | cascader content ref | ^[object]`ComputedRef<any>` | | contentRef | cascader content ref | ^[object]`ComputedRef<any>` |
| presentText ^(2.8.4) | selected content text | ^[object]`ComputedRef<string>` | | presentText ^(2.8.4) | selected content text | ^[object]`ComputedRef<string>` |
## CascaderPanel API ## CascaderPanel API

12
docs/en-US/component/checkbox.md
View File

@ -110,8 +110,6 @@ checkbox/with-border
| label | label of the Checkbox when used inside a `checkbox-group`. If there's no value, `label` will act as `value` | ^[string] / ^[number] / ^[boolean] / ^[object] | — | | label | label of the Checkbox when used inside a `checkbox-group`. If there's no value, `label` will act as `value` | ^[string] / ^[number] / ^[boolean] / ^[object] | — |
| true-value ^(2.6.0) | value of the Checkbox if it's checked | ^[string] / ^[number] | — | | true-value ^(2.6.0) | value of the Checkbox if it's checked | ^[string] / ^[number] | — |
| false-value ^(2.6.0) | value of the Checkbox if it's not checked | ^[string] / ^[number] | — | | false-value ^(2.6.0) | value of the Checkbox if it's not checked | ^[string] / ^[number] | — |
| true-label ^(deprecated) | value of the Checkbox if it's checked | ^[string] / ^[number] | — |
| false-label ^(deprecated) | value of the Checkbox if it's not checked | ^[string] / ^[number] | — |
| disabled | whether the Checkbox is disabled | ^[boolean] | false | | disabled | whether the Checkbox is disabled | ^[boolean] | false |
| border | whether to add a border around Checkbox | ^[boolean] | false | | border | whether to add a border around Checkbox | ^[boolean] | false |
| size | size of the Checkbox | ^[enum]`'large' \| 'default' \| 'small'` | — | | size | size of the Checkbox | ^[enum]`'large' \| 'default' \| 'small'` | — |
@ -121,8 +119,10 @@ checkbox/with-border
| validate-event | whether to trigger form validation | ^[boolean] | true | | validate-event | whether to trigger form validation | ^[boolean] | true |
| tabindex | input tabindex | ^[string] / ^[number] | — | | tabindex | input tabindex | ^[string] / ^[number] | — |
| id | input id | ^[string] | — | | id | input id | ^[string] | — |
| controls ^(a11y) ^(deprecated) | same as [aria-controls](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-controls), takes effect when `indeterminate` is `true` | ^[string] | — |
| aria-controls ^(a11y) ^(2.7.2) | same as [aria-controls](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-controls), takes effect when `indeterminate` is `true` | ^[string] | — | | aria-controls ^(a11y) ^(2.7.2) | same as [aria-controls](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-controls), takes effect when `indeterminate` is `true` | ^[string] | — |
| true-label ^(deprecated) | value of the Checkbox if it's checked | ^[string] / ^[number] | — |
| false-label ^(deprecated) | value of the Checkbox if it's not checked | ^[string] / ^[number] | — |
| controls ^(a11y) ^(deprecated) | same as [aria-controls](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-controls), takes effect when `indeterminate` is `true` | ^[string] | — |
### Checkbox Events ### Checkbox Events
@ -147,12 +147,12 @@ checkbox/with-border
| disabled | whether the nesting checkboxes are disabled | ^[boolean] | false | | disabled | whether the nesting checkboxes are disabled | ^[boolean] | false |
| min | minimum number of checkbox checked | ^[number] | — | | min | minimum number of checkbox checked | ^[number] | — |
| max | maximum number of checkbox checked | ^[number] | — | | max | maximum number of checkbox checked | ^[number] | — |
| label ^(a11y) ^(deprecated) | native `aria-label` attribute | ^[string] | — |
| aria-label ^(a11y) ^(2.7.2) | native `aria-label` attribute | ^[string] | — | | aria-label ^(a11y) ^(2.7.2) | native `aria-label` attribute | ^[string] | — |
| text-color | font color when button is active | ^[string] | #ffffff | | text-color | font color when button is active | ^[string] | #ffffff |
| fill | border and background color when button is active | ^[string] | #409eff | | fill | border and background color when button is active | ^[string] | #409eff |
| tag | element tag of the checkbox group | ^[string] | div | | tag | element tag of the checkbox group | ^[string] | div |
| validate-event | whether to trigger form validation | ^[boolean] | true | | validate-event | whether to trigger form validation | ^[boolean] | true |
| label ^(a11y) ^(deprecated) | native `aria-label` attribute | ^[string] | — |
### CheckboxGroup Events ### CheckboxGroup Events
@ -176,11 +176,11 @@ checkbox/with-border
| label | label of the checkbox when used inside a `checkbox-group`. If there's no value, `label` will act as `value` | ^[string] / ^[number] / ^[boolean] / ^[object] | — | | label | label of the checkbox when used inside a `checkbox-group`. If there's no value, `label` will act as `value` | ^[string] / ^[number] / ^[boolean] / ^[object] | — |
| true-value ^(2.6.0) | value of the checkbox if it's checked | ^[string] / ^[number] | — | | true-value ^(2.6.0) | value of the checkbox if it's checked | ^[string] / ^[number] | — |
| false-value ^(2.6.0) | value of the checkbox if it's not checked | ^[string] / ^[number] | — | | false-value ^(2.6.0) | value of the checkbox if it's not checked | ^[string] / ^[number] | — |
| true-label ^(deprecated) | value of the checkbox if it's checked | ^[string] / ^[number] | — |
| false-label ^(deprecated) | value of the checkbox if it's not checked | ^[string] / ^[number] | — |
| disabled | whether the checkbox is disabled | ^[boolean] | false | | disabled | whether the checkbox is disabled | ^[boolean] | false |
| name | native 'name' attribute | ^[string] | — | | name | native 'name' attribute | ^[string] | — |
| checked | if the checkbox is checked | ^[boolean] | false | | checked | if the checkbox is checked | ^[boolean] | false |
| true-label ^(deprecated) | value of the checkbox if it's checked | ^[string] / ^[number] | — |
| false-label ^(deprecated) | value of the checkbox if it's not checked | ^[string] / ^[number] | — |
### CheckboxButton Slots ### CheckboxButton Slots

2
docs/en-US/component/color-picker.md
View File

@ -54,10 +54,10 @@ color-picker/sizes
| predefine | predefined color options | ^[object]`string[]` | — | | predefine | predefined color options | ^[object]`string[]` | — |
| validate-event | whether to trigger form validation | ^[boolean] | true | | validate-event | whether to trigger form validation | ^[boolean] | true |
| tabindex | ColorPicker tabindex | ^[string] / ^[number] | 0 | | tabindex | ColorPicker tabindex | ^[string] / ^[number] | 0 |
| label ^(a11y) ^(deprecated) | ColorPicker aria-label | ^[string] | — |
| aria-label ^(a11y) ^(2.7.2) | ColorPicker aria-label | ^[string] | — | | aria-label ^(a11y) ^(2.7.2) | ColorPicker aria-label | ^[string] | — |
| id | ColorPicker id | ^[string] | — | | id | ColorPicker id | ^[string] | — |
| teleported ^(2.7.2) | whether color-picker popper is teleported to the body | ^[boolean] | true | | teleported ^(2.7.2) | whether color-picker popper is teleported to the body | ^[boolean] | true |
| label ^(a11y) ^(deprecated) | ColorPicker aria-label | ^[string] | — |
### Events ### Events

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

@ -121,7 +121,6 @@ When using `modal` = false, please make sure that `append-to-body` was set to **
| append-to-body | whether to append Dialog itself to body. A nested Dialog should have this attribute set to `true` | ^[boolean] | false | | append-to-body | whether to append Dialog itself to body. A nested Dialog should have this attribute set to `true` | ^[boolean] | false |
| append-to ^(2.4.3) | which element the Dialog appends to. Will override `append-to-body` | ^[string] / ^[HTMLElement] | body | | append-to ^(2.4.3) | which element the Dialog appends to. Will override `append-to-body` | ^[string] / ^[HTMLElement] | body |
| lock-scroll | whether scroll of body is disabled while Dialog is displayed | ^[boolean] | true | | lock-scroll | whether scroll of body is disabled while Dialog is displayed | ^[boolean] | true |
| custom-class ^(deprecated) | custom class names for Dialog | ^[string] | '' |
| open-delay | the Time(milliseconds) before open | ^[number] | 0 | | open-delay | the Time(milliseconds) before open | ^[number] | 0 |
| close-delay | the Time(milliseconds) before close | ^[number] | 0 | | close-delay | the Time(milliseconds) before close | ^[number] | 0 |
| close-on-click-modal | whether the Dialog can be closed by clicking the mask | ^[boolean] | true | | close-on-click-modal | whether the Dialog can be closed by clicking the mask | ^[boolean] | true |
@ -136,6 +135,7 @@ When using `modal` = false, please make sure that `append-to-body` was set to **
| close-icon | custom close icon, default is Close | ^[string] / ^[Component] | — | | close-icon | custom close icon, default is Close | ^[string] / ^[Component] | — |
| z-index | same as z-index in native CSS, z-order of dialog | ^[number] | — | | z-index | same as z-index in native CSS, z-order of dialog | ^[number] | — |
| header-aria-level ^(a11y) | header's `aria-level` attribute | ^[string] | 2 | | header-aria-level ^(a11y) | header's `aria-level` attribute | ^[string] | 2 |
| custom-class ^(deprecated) | custom class names for Dialog | ^[string] | '' |
:::warning :::warning
@ -149,8 +149,8 @@ When using `modal` = false, please make sure that `append-to-body` was set to **
| ------------------- | ----------------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------------- |
| — | content of Dialog | | — | content of Dialog |
| header | content of the Dialog header; Replacing this removes the title, but does not remove the close button. | | header | content of the Dialog header; Replacing this removes the title, but does not remove the close button. |
| title ^(deprecated) | works the same as the header slot. Use that instead. |
| footer | content of the Dialog footer | | footer | content of the Dialog footer |
| title ^(deprecated) | works the same as the header slot. Use that instead. |
:::warning :::warning

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

@ -90,7 +90,6 @@ Drawer provides an API called `destroyOnClose`, which is a flag variable that in
| close-on-press-escape | Indicates whether Drawer can be closed by pressing ESC | ^[boolean] | true | | close-on-press-escape | Indicates whether Drawer can be closed by pressing ESC | ^[boolean] | true |
| open-delay | Time(milliseconds) before open | ^[number] | 0 | | open-delay | Time(milliseconds) before open | ^[number] | 0 |
| close-delay | Time(milliseconds) before close | ^[number] | 0 | | close-delay | Time(milliseconds) before close | ^[number] | 0 |
| custom-class ^(deprecated) | Extra class names for Drawer | ^[string] | — |
| destroy-on-close | Indicates whether children should be destroyed after Drawer closed | ^[boolean] | false | | destroy-on-close | Indicates whether children should be destroyed after Drawer closed | ^[boolean] | false |
| modal | Should show shadowing layer | ^[boolean] | true | | modal | Should show shadowing layer | ^[boolean] | true |
| direction | Drawer's opening direction | ^[enum]`'rtl' \| 'ltr' \| 'ttb' \| 'btt'` | rtl | | direction | Drawer's opening direction | ^[enum]`'rtl' \| 'ltr' \| 'ttb' \| 'btt'` | rtl |
@ -101,6 +100,7 @@ Drawer provides an API called `destroyOnClose`, which is a flag variable that in
| modal-class | Extra class names for shadowing layer | ^[string] | — | | modal-class | Extra class names for shadowing layer | ^[string] | — |
| z-index | set z-index | ^[number] | — | | z-index | set z-index | ^[number] | — |
| header-aria-level ^(a11y) | header's `aria-level` attribute | ^[string] | 2 | | header-aria-level ^(a11y) | header's `aria-level` attribute | ^[string] | 2 |
| custom-class ^(deprecated) | Extra class names for Drawer | ^[string] | — |
:::warning :::warning
@ -125,8 +125,8 @@ Drawer provides an API called `destroyOnClose`, which is a flag variable that in
| ------------------- | ---------------------------------------------------------------------------------------------- | | ------------------- | ---------------------------------------------------------------------------------------------- |
| default | Drawer's Content | | default | Drawer's Content |
| header | Drawer header section; Replacing this removes the title, but does not remove the close button. | | header | Drawer header section; Replacing this removes the title, but does not remove the close button. |
| title ^(deprecated) | Works the same as the header slot. Use that instead. |
| footer | Drawer footer Section | | footer | Drawer footer Section |
| title ^(deprecated) | Works the same as the header slot. Use that instead. |
### Exposes ### Exposes

5
docs/en-US/component/input-number.md
View File

@ -113,16 +113,17 @@ input-number/with-prefix-suffix
| controls | whether to enable the control buttons | ^[boolean] | true | | controls | whether to enable the control buttons | ^[boolean] | true |
| controls-position | position of the control buttons | ^[enum]`'' \| 'right'` | — | | controls-position | position of the control buttons | ^[enum]`'' \| 'right'` | — |
| name | same as `name` in native input | ^[string] | — | | name | same as `name` in native input | ^[string] | — |
| label ^(a11y) ^(deprecated) | same as `aria-label` in native input | ^[string] | — |
| aria-label ^(a11y) ^(2.7.2) | same as `aria-label` in native input | ^[string] | — | | aria-label ^(a11y) ^(2.7.2) | same as `aria-label` in native input | ^[string] | — |
| placeholder | same as `placeholder` in native input | ^[string] | — | | placeholder | same as `placeholder` in native input | ^[string] | — |
| id | same as `id` in native input | ^[string] | — | | id | same as `id` in native input | ^[string] | — |
| value-on-clear ^(2.2.0) | value should be set when input box is cleared | ^[number] / ^[null] / ^[enum]`'min' \| 'max'` | — | | value-on-clear ^(2.2.0) | value should be set when input box is cleared | ^[number] / ^[null] / ^[enum]`'min' \| 'max'` | — |
| validate-event | whether to trigger form validation | ^[boolean] | true | | validate-event | whether to trigger form validation | ^[boolean] | true |
| label ^(a11y) ^(deprecated) | same as `aria-label` in native input | ^[string] | — |
### Slots ### Slots
| Name | Description | | Name | Description |
|------------------------| ------------------------------------- | | ---------------------- | ------------------------------------- |
| decrease-icon ^(2.6.3) | custom input box button decrease icon | | decrease-icon ^(2.6.3) | custom input box button decrease icon |
| increase-icon ^(2.6.3) | custom input box button increase icon | | increase-icon ^(2.6.3) | custom input box button increase icon |
| prefix ^(2.8.4) | content as Input prefix | | prefix ^(2.8.4) | content as Input prefix |

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

@ -146,11 +146,11 @@ input/length-limiting
| resize | control the resizability | ^[enum]`'none' \| 'both' \| 'horizontal' \| 'vertical'` | — | | resize | control the resizability | ^[enum]`'none' \| 'both' \| 'horizontal' \| 'vertical'` | — |
| autofocus | same as `autofocus` in native input | ^[boolean] | false | | autofocus | same as `autofocus` in native input | ^[boolean] | false |
| form | same as `form` in native input | `string` | — | | form | same as `form` in native input | `string` | — |
| label ^(a11y) ^(deprecated) | same as `aria-label` in native input | ^[string] | — |
| aria-label ^(a11y) ^(2.7.2) | same as `aria-label` in native input | ^[string] | — | | aria-label ^(a11y) ^(2.7.2) | same as `aria-label` in native input | ^[string] | — |
| tabindex | input tabindex | ^[string] / ^[number] | — | | tabindex | input tabindex | ^[string] / ^[number] | — |
| validate-event | whether to trigger form validation | ^[boolean] | true | | validate-event | whether to trigger form validation | ^[boolean] | true |
| input-style | the style of the input element or textarea element | ^[string] / ^[object]`CSSProperties \| CSSProperties[] \| string[]` | {} | | input-style | the style of the input element or textarea element | ^[string] / ^[object]`CSSProperties \| CSSProperties[] \| string[]` | {} |
| label ^(a11y) ^(deprecated) | same as `aria-label` in native input | ^[string] | — |
### Events ### Events

6
docs/en-US/component/menu.md
View File

@ -78,9 +78,6 @@ menu/popper-offset
| ellipsis | whether the menu is ellipsis (available only in horizontal mode) | ^[boolean] | true | | ellipsis | whether the menu is ellipsis (available only in horizontal mode) | ^[boolean] | true |
| ellipsis-icon ^(2.4.4) | custom ellipsis icon (available only in horizontal mode and ellipsis is true) | ^[string] / ^[Component] | — | | ellipsis-icon ^(2.4.4) | custom ellipsis icon (available only in horizontal mode and ellipsis is true) | ^[string] / ^[Component] | — |
| popper-offset ^(2.4.4) | offset of the popper (effective for all submenus) | ^[number] | 6 | | popper-offset ^(2.4.4) | offset of the popper (effective for all submenus) | ^[number] | 6 |
| background-color ^(deprecated) | background color of Menu (hex format) (deprecated, use `--el-menu-bg-color` in a style class instead) | ^[string] | #ffffff |
| text-color ^(deprecated) | text color of Menu (hex format) (deprecated, use `--el-menu-text-color` in a style class instead) | ^[string] | #303133 |
| active-text-color ^(deprecated) | text color of currently active menu item (hex format) (deprecated, use `--el-menu-active-color` in a style class instead) | ^[string] | #409eff |
| default-active | index of active menu on page load | ^[string] | '' | | default-active | index of active menu on page load | ^[string] | '' |
| default-openeds | array that contains indexes of currently active sub-menus | ^[object]`string[]` | [] | | default-openeds | array that contains indexes of currently active sub-menus | ^[object]`string[]` | [] |
| unique-opened | whether only one sub-menu can be active | ^[boolean] | false | | unique-opened | whether only one sub-menu can be active | ^[boolean] | false |
@ -92,6 +89,9 @@ menu/popper-offset
| popper-class ^(2.5.0) | custom class name for all popup menus | ^[string] | — | | popper-class ^(2.5.0) | custom class name for all popup menus | ^[string] | — |
| show-timeout ^(2.5.0) | control timeout for all menus before showing | ^[number] | 300 | | show-timeout ^(2.5.0) | control timeout for all menus before showing | ^[number] | 300 |
| hide-timeout ^(2.5.0) | control timeout for all menus before hiding | ^[number] | 300 | | hide-timeout ^(2.5.0) | control timeout for all menus before hiding | ^[number] | 300 |
| background-color ^(deprecated) | background color of Menu (hex format) (use `--el-menu-bg-color` in a style class instead) | ^[string] | #ffffff |
| text-color ^(deprecated) | text color of Menu (hex format) ( use `--el-menu-text-color` in a style class instead) | ^[string] | #303133 |
| active-text-color ^(deprecated) | text color of currently active menu item (hex format) ( use `--el-menu-active-color` in a style class instead) | ^[string] | #409eff |
### Menu Events ### Menu Events

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

@ -67,7 +67,6 @@ pagination/more-elements
| Name | Description | Type | Default | | Name | Description | Type | Default |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------------ | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------------ |
| small ^(deprecated) | whether to use small pagination | ^[boolean] | false |
| size ^(2.7.6) | pagination size | ^[enum]`'large' \| 'default' \| 'small'` | 'default' | | size ^(2.7.6) | pagination size | ^[enum]`'large' \| 'default' \| 'small'` | 'default' |
| background | whether the buttons have a background color | ^[boolean] | false | | background | whether the buttons have a background color | ^[boolean] | false |
| page-size / v-model:page-size | item count of each page | ^[number] | — | | page-size / v-model:page-size | item count of each page | ^[number] | — |
@ -88,6 +87,7 @@ pagination/more-elements
| disabled | whether Pagination is disabled | ^[boolean] | false | | disabled | whether Pagination is disabled | ^[boolean] | false |
| teleported ^(2.3.13) | whether Pagination select dropdown is teleported to the body | ^[boolean] | true | | teleported ^(2.3.13) | whether Pagination select dropdown is teleported to the body | ^[boolean] | true |
| hide-on-single-page | whether to hide when there's only one page | ^[boolean] | false | | hide-on-single-page | whether to hide when there's only one page | ^[boolean] | false |
| small ^(deprecated) | whether to use small pagination | ^[boolean] | false |
:::warning :::warning

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

@ -117,10 +117,10 @@ radio/with-borders
| text-color | font color when button is active | ^[string] | #ffffff | | text-color | font color when button is active | ^[string] | #ffffff |
| fill | border and background color when button is active | ^[string] | #409eff | | fill | border and background color when button is active | ^[string] | #409eff |
| validate-event | whether to trigger form validation | ^[boolean] | true | | validate-event | whether to trigger form validation | ^[boolean] | true |
| label ^(a11y) ^(deprecated) | same as `aria-label` in RadioGroup | ^[string] | — |
| aria-label ^(a11y) ^(2.7.2) | same as `aria-label` in RadioGroup | ^[string] | — | | aria-label ^(a11y) ^(2.7.2) | same as `aria-label` in RadioGroup | ^[string] | — |
| name | native `name` attribute | ^[string] | — | | name | native `name` attribute | ^[string] | — |
| id | native `id` attribute | ^[string] | — | | id | native `id` attribute | ^[string] | — |
| label ^(a11y) ^(deprecated) | same as `aria-label` in RadioGroup | ^[string] | — |
### RadioGroup Events ### RadioGroup Events

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

@ -109,8 +109,8 @@ Use `css/scss` language to change the global or local color. We set some global
| score-template | score template | ^[string] | {value} | | score-template | score template | ^[string] | {value} |
| clearable ^(2.2.18) | whether value can be reset to `0` | ^[boolean] | false | | clearable ^(2.2.18) | whether value can be reset to `0` | ^[boolean] | false |
| id | native `id` attribute | ^[string] | — | | id | native `id` attribute | ^[string] | — |
| label ^(a11y) ^(deprecated) | same as `aria-label` in Rate | ^[string] | — |
| aria-label ^(a11y) ^(2.7.2) | same as `aria-label` in Rate | ^[string] | — | | aria-label ^(a11y) ^(2.7.2) | same as `aria-label` in Rate | ^[string] | — |
| label ^(a11y) ^(deprecated) | same as `aria-label` in Rate | ^[string] | — |
### Events ### Events

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

@ -243,7 +243,6 @@ select-v2/custom-label
| no-match-text | displayed text when no data matches the filtering query, you can also use slot `empty`, default is 'No matching data' | ^[string] | — | | no-match-text | displayed text when no data matches the filtering query, you can also use slot `empty`, default is 'No matching data' | ^[string] | — |
| no-data-text | displayed text when there is no options, you can also use slot empty | ^[string] | No Data | | no-data-text | displayed text when there is no options, you can also use slot empty | ^[string] | No Data |
| popper-class | custom class name for Select's dropdown | ^[string] | '' | | popper-class | custom class name for Select's dropdown | ^[string] | '' |
| popper-append-to-body ^(deprecated) | whether to append the popper menu to body. If the positioning of the popper is wrong, you can try to set this prop to false | ^[boolean] | false |
| teleported | whether select dropdown is teleported to the body | ^[boolean] | true | | teleported | whether select dropdown is teleported to the body | ^[boolean] | true |
| persistent | when select dropdown is inactive and `persistent` is `false`, select dropdown will be destroyed | ^[boolean] | true | | persistent | when select dropdown is inactive and `persistent` is `false`, select dropdown will be destroyed | ^[boolean] | true |
| popper-options | [popper.js](https://popper.js.org/docs/v2/) parameters | ^[object]refer to [popper.js](https://popper.js.org/docs/v2/) doc | {} | | popper-options | [popper.js](https://popper.js.org/docs/v2/) parameters | ^[object]refer to [popper.js](https://popper.js.org/docs/v2/) doc | {} |
@ -263,6 +262,7 @@ select-v2/custom-label
| aria-label ^(a11y) ^(2.5.0) | same as `aria-label` in native input | ^[string] | — | | aria-label ^(a11y) ^(2.5.0) | same as `aria-label` in native input | ^[string] | — |
| empty-values ^(2.7.0) | empty values of component, [see config-provider](/en-US/component/config-provider#empty-values-configurations) | ^[array] | — | | empty-values ^(2.7.0) | empty values of component, [see config-provider](/en-US/component/config-provider#empty-values-configurations) | ^[array] | — |
| value-on-clear ^(2.7.0) | clear return value, [see config-provider](/en-US/component/config-provider#empty-values-configurations) | ^[string] / ^[number] / ^[boolean] / ^[Function] | — | | value-on-clear ^(2.7.0) | clear return value, [see config-provider](/en-US/component/config-provider#empty-values-configurations) | ^[string] / ^[number] / ^[boolean] / ^[Function] | — |
| popper-append-to-body ^(deprecated) | whether to append the popper menu to body. If the positioning of the popper is wrong, you can try to set this prop to false | ^[boolean] | false |
### props ### props

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

@ -220,7 +220,6 @@ select/custom-label
| clear-icon | custom clear icon component | ^[string] / ^[object]`Component` | CircleClose | | clear-icon | custom clear icon component | ^[string] / ^[object]`Component` | CircleClose |
| fit-input-width | whether the width of the dropdown is the same as the input | ^[boolean] | false | | fit-input-width | whether the width of the dropdown is the same as the input | ^[boolean] | false |
| suffix-icon | custom suffix icon component | ^[string] / ^[object]`Component` | ArrowDown | | suffix-icon | custom suffix icon component | ^[string] / ^[object]`Component` | ArrowDown |
| suffix-transition ^(deprecated) | animation when dropdown appears/disappears icon | ^[boolean] | true |
| tag-type | tag type | ^[enum]`'' \| 'success' \| 'info' \| 'warning' \| 'danger'` | info | | tag-type | tag type | ^[enum]`'' \| 'success' \| 'info' \| 'warning' \| 'danger'` | info |
| tag-effect ^(2.7.7) | tag effect | ^[enum]`'' \| 'light' \| 'dark' \| 'plain'` | light | | tag-effect ^(2.7.7) | tag effect | ^[enum]`'' \| 'light' \| 'dark' \| 'plain'` | light |
| validate-event | whether to trigger form validation | ^[boolean] | true | | validate-event | whether to trigger form validation | ^[boolean] | true |
@ -231,6 +230,7 @@ select/custom-label
| aria-label ^(a11y) | same as `aria-label` in native input | ^[string] | — | | aria-label ^(a11y) | same as `aria-label` in native input | ^[string] | — |
| empty-values ^(2.7.0) | empty values of component, [see config-provider](/en-US/component/config-provider#empty-values-configurations) | ^[array] | — | | empty-values ^(2.7.0) | empty values of component, [see config-provider](/en-US/component/config-provider#empty-values-configurations) | ^[array] | — |
| value-on-clear ^(2.7.0) | clear return value, [see config-provider](/en-US/component/config-provider#empty-values-configurations) | ^[string] / ^[number] / ^[boolean] / ^[Function] | — | | value-on-clear ^(2.7.0) | clear return value, [see config-provider](/en-US/component/config-provider#empty-values-configurations) | ^[string] / ^[number] / ^[boolean] / ^[Function] | — |
| suffix-transition ^(deprecated) | animation when dropdown appears/disappears icon | ^[boolean] | true |
:::warning :::warning

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

@ -102,7 +102,6 @@ slider/show-marks
| range | whether to select a range | ^[boolean] | false | | range | whether to select a range | ^[boolean] | false |
| vertical | vertical mode | ^[boolean] | false | | vertical | vertical mode | ^[boolean] | false |
| height | slider height, required in vertical mode | ^[string] | — | | height | slider height, required in vertical mode | ^[string] | — |
| label ^(a11y) ^(deprecated) | native `aria-label` attribute | ^[string] | — |
| aria-label ^(a11y) ^(2.7.2) | native `aria-label` attribute | ^[string] | — | | aria-label ^(a11y) ^(2.7.2) | native `aria-label` attribute | ^[string] | — |
| range-start-label | when `range` is true, screen reader label for the start of the range | ^[string] | — | | range-start-label | when `range` is true, screen reader label for the start of the range | ^[string] | — |
| range-end-label | when `range` is true, screen reader label for the end of the range | ^[string] | — | | range-end-label | when `range` is true, screen reader label for the end of the range | ^[string] | — |
@ -112,6 +111,7 @@ slider/show-marks
| placement | position of Tooltip | ^[enum]`'top' \| 'top-start' \| 'top-end' \| 'bottom' \| 'bottom-start' \| 'bottom-end' \| 'left' \| 'left-start' \| 'left-end' \| 'right' \| 'right-start' \| 'right-end'` | top | | placement | position of Tooltip | ^[enum]`'top' \| 'top-start' \| 'top-end' \| 'bottom' \| 'bottom-start' \| 'bottom-end' \| 'left' \| 'left-start' \| 'left-end' \| 'right' \| 'right-start' \| 'right-end'` | top |
| marks | marks, type of key must be `number` and must in closed interval `[min, max]`, each mark can custom style | ^[object]`SliderMarks` | — | | marks | marks, type of key must be `number` and must in closed interval `[min, max]`, each mark can custom style | ^[object]`SliderMarks` | — |
| validate-event | whether to trigger form validation | ^[boolean] | true | | validate-event | whether to trigger form validation | ^[boolean] | true |
| label ^(a11y) ^(deprecated) | native `aria-label` attribute | ^[string] | — |
### Events ### Events

8
docs/en-US/component/switch.md
View File

@ -115,16 +115,16 @@ switch/custom-action-slot
| inactive-text | text displayed when in `off` state | ^[string] | '' | | inactive-text | text displayed when in `off` state | ^[string] | '' |
| active-value | switch value when in `on` state | ^[boolean] / ^[string] / ^[number] | true | | active-value | switch value when in `on` state | ^[boolean] / ^[string] / ^[number] | true |
| inactive-value | switch value when in `off` state | ^[boolean] / ^[string] / ^[number] | false | | inactive-value | switch value when in `off` state | ^[boolean] / ^[string] / ^[number] | false |
| active-color ^(deprecated) | background color when in `on` state ( deprecated, use CSS var `--el-switch-on-color` instead ) | ^[string] | '' |
| inactive-color ^(deprecated) | background color when in `off` state ( deprecated, use CSS var `--el-switch-off-color` instead ) | ^[string] | '' |
| border-color ^(deprecated) | border color of the switch ( deprecated, use CSS var `--el-switch-border-color` instead ) | ^[string] | '' |
| name | input name of Switch | ^[string] | '' | | name | input name of Switch | ^[string] | '' |
| validate-event | whether to trigger form validation | ^[boolean] | true | | validate-event | whether to trigger form validation | ^[boolean] | true |
| before-change | before-change hook before the switch state changes. If `false` is returned or a `Promise` is returned and then is rejected, will stop switching | ^[boolean] / ^[Function]`() => Promise<boolean>` | — | | before-change | before-change hook before the switch state changes. If `false` is returned or a `Promise` is returned and then is rejected, will stop switching | ^[boolean] / ^[Function]`() => Promise<boolean>` | — |
| id | id for input | ^[string] | — | | id | id for input | ^[string] | — |
| tabindex | tabindex for input | ^[string] / ^[number] | — | | tabindex | tabindex for input | ^[string] / ^[number] | — |
| label ^(a11y) ^(deprecated) | same as `aria-label` in native input | ^[string] | — |
| aria-label ^(a11y) ^(2.7.2) | same as `aria-label` in native input | ^[string] | — | | aria-label ^(a11y) ^(2.7.2) | same as `aria-label` in native input | ^[string] | — |
| active-color ^(deprecated) | background color when in `on` state ( use CSS var `--el-switch-on-color` instead ) | ^[string] | '' |
| inactive-color ^(deprecated) | background color when in `off` state ( use CSS var `--el-switch-off-color` instead ) | ^[string] | '' |
| border-color ^(deprecated) | border color of the switch ( use CSS var `--el-switch-border-color` instead ) | ^[string] | '' |
| label ^(a11y) ^(deprecated) | same as `aria-label` in native input | ^[string] | — |
### Events ### Events

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

@ -113,8 +113,8 @@ tabs/customized-trigger
| Name | Description | Subtags | | Name | Description | Subtags |
| ------------------------------ | ------------------------- | -------- | | ------------------------------ | ------------------------- | -------- |
| default | customize default content | Tab-pane | | default | customize default content | Tab-pane |
| addIcon ^(2.4.0) ^(deprecated) | customize add button icon | — |
| add-icon ^(2.5.4) | customize add button icon | — | | add-icon ^(2.5.4) | customize add button icon | — |
| addIcon ^(2.4.0) ^(deprecated) | customize add button icon | — |
## Tab-pane API ## Tab-pane API

2
docs/en-US/component/time-picker.md
View File

@ -61,7 +61,6 @@ time-picker/range
| value-format | optional, format of binding value. If not specified, the binding value will be a Date object | ^[string] see [date formats](/en-US/component/date-picker#date-formats) | — | | value-format | optional, format of binding value. If not specified, the binding value will be a Date object | ^[string] see [date formats](/en-US/component/date-picker#date-formats) | — |
| id | same as `id` in native input | ^[string] / ^[object]`[string, string]` | — | | id | same as `id` in native input | ^[string] / ^[object]`[string, string]` | — |
| name | same as `name` in native input | ^[string] | '' | | name | same as `name` in native input | ^[string] | '' |
| label ^(a11y) ^(deprecated) | same as `aria-label` in native input | ^[string] | — |
| aria-label ^(a11y) ^(2.7.2) | same as `aria-label` in native input | ^[string] | — | | aria-label ^(a11y) ^(2.7.2) | same as `aria-label` in native input | ^[string] | — |
| prefix-icon | Custom prefix icon component | ^[string] / ^[Component] | Clock | | prefix-icon | Custom prefix icon component | ^[string] / ^[Component] | Clock |
| clear-icon | Custom clear icon component | ^[string] / ^[Component] | CircleClose | | clear-icon | Custom clear icon component | ^[string] / ^[Component] | CircleClose |
@ -72,6 +71,7 @@ time-picker/range
| tabindex | input tabindex | ^[string] / ^[number] | 0 | | tabindex | input tabindex | ^[string] / ^[number] | 0 |
| empty-values ^(2.7.0) | empty values of component, [see config-provider](/en-US/component/config-provider#empty-values-configurations) | ^[array] | — | | empty-values ^(2.7.0) | empty values of component, [see config-provider](/en-US/component/config-provider#empty-values-configurations) | ^[array] | — |
| value-on-clear ^(2.7.0) | clear return value, [see config-provider](/en-US/component/config-provider#empty-values-configurations) | ^[string] / ^[number] / ^[boolean] / ^[Function] | — | | value-on-clear ^(2.7.0) | clear return value, [see config-provider](/en-US/component/config-provider#empty-values-configurations) | ^[string] / ^[number] / ^[boolean] / ^[Function] | — |
| label ^(a11y) ^(deprecated) | same as `aria-label` in native input | ^[string] | — |
### Events ### Events