Skip to content

Commit

Permalink
docs(components): [select] description and comment begins in lower case
Browse files Browse the repository at this point in the history
  • Loading branch information
@wzc520pyfm
wzc520pyfm committed Jun 21, 2023
1 parent 0ef0925 commit e8caf41
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions docs/en-US/component/select.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ select/value-key
| collapse-tags-tooltip | whether show all selected tags when mouse hover text of collapse-tags. To use this, `collapse-tags` must be true | ^[boolean] | false |
| multiple-limit | maximum number of options user can select when `multiple` is `true`. No limit when set to 0 | ^[number] | 0 |
| name | the name attribute of select input | ^[string] | — |
| effect | Tooltip theme, built-in theme: `dark` / `light` | ^[enum]`'dark' \| 'light'` / ^[string] | light |
| effect | tooltip theme, built-in theme: `dark` / `light` | ^[enum]`'dark' \| 'light'` / ^[string] | light |
| autocomplete | the autocomplete attribute of select input | ^[string] | off |
| placeholder | placeholder, default is 'Select' | ^[string] | — |
| filterable | whether Select is filterable | ^[boolean] | false |
Expand All @@ -154,14 +154,14 @@ select/value-key
| 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 |
| automatic-dropdown | for non-filterable Select, this prop decides if the option menu pops up when the input is focused | ^[boolean] | false |
| 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 |
| 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 |
| validate-event | whether to trigger form validation | ^[boolean] | true |
| placement | 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 |
| max-collapse-tags ^(2.3.0) | The max tags number to be shown. To use this, `collapse-tags` must be true | ^[number] | 1 |
| max-collapse-tags ^(2.3.0) | the max tags number to be shown. To use this, `collapse-tags` must be true | ^[number] | 1 |
| popper-options | [popper.js](https://popper.js.org/docs/v2/) parameters | ^[object]refer to [popper.js](https://popper.js.org/docs/v2/) doc | {} |

:::warning
Expand All @@ -185,7 +185,7 @@ select/value-key

| Name | Description | Subtags |
| ------- | -------------------------------- | --------------------- |
| default | Option component list | Option Group / Option |
| default | option component list | Option Group / Option |
| prefix | content as Select prefix | — |
| empty | content when there is no options | — |

Expand Down
8 changes: 4 additions & 4 deletions packages/components/select/src/select.vue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ export default defineComponent({
validator: isValidComponentSize,
},
/**
* @description Tooltip theme, built-in theme: `dark` / `light`
* @description tooltip theme, built-in theme: `dark` / `light`
*/
effect: {
type: String as PropType<'light' | 'dark' | string>,
Expand Down Expand Up @@ -486,7 +486,7 @@ export default defineComponent({
*/
collapseTagsTooltip: Boolean,
/**
* @description The max tags number to be shown. To use this, `collapse-tags` must be true
* @description the max tags number to be shown. To use this, `collapse-tags` must be true
*/
maxCollapseTags: {
type: Number,
Expand All @@ -504,7 +504,7 @@ export default defineComponent({
default: true,
},
/**
* @description Custom clear icon component
* @description custom clear icon component
*/
clearIcon: {
type: iconPropType,
Expand All @@ -515,7 +515,7 @@ export default defineComponent({
*/
fitInputWidth: Boolean,
/**
* @description Custom suffix icon component
* @description custom suffix icon component
*/
suffixIcon: {
type: iconPropType,
Expand Down

0 comments on commit e8caf41

Please sign in to comment.