Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor(utils): refactor iconPropType #9502

Merged
merged 3 commits into from Aug 28, 2022
Merged

refactor(utils): refactor iconPropType #9502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
74b1373
refactor(utils): refactor `iconTypes`
holazz Aug 28, 2022
69e67b1
chore: update docs
holazz Aug 28, 2022
aa4e6b8
chore: fix lint error
holazz Aug 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 0 additions & 3 deletions docs/en-US/component/autocomplete.md
View file
Open in desktop
Expand Up @@ -41,7 +41,6 @@ autocomplete/remote-search
| clearable | whether to show clear button | boolean | — | false |
| disabled | whether Autocomplete is disabled | boolean | — | false |
| value-key | key name of the input suggestion object for display | string | — | value |
| icon | icon component | string / Component | — | — |
| model-value / v-model | binding value | string | — | — |
| debounce | debounce delay when typing, in milliseconds | number | — | 300 |
| placement | placement of the popup menu | string | top / top-start / top-end / bottom / bottom-start / bottom-end | bottom-start |
Expand All @@ -51,8 +50,6 @@ autocomplete/remote-search
| 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 / 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 |
Expand Down
8 changes: 4 additions & 4 deletions docs/en-US/component/breadcrumb.md
View file
Open in desktop
Expand Up @@ -25,10 +25,10 @@ breadcrumb/icon

## Breadcrumb Attributes

| Attribute | Description | Type | Accepted Values | Default |
| -------------- | -------------------------------- | ------------------ | --------------- | ------- |
| separator | separator character | string | — | / |
| separator-icon | icon component of icon separator | string / Component | — | - |
| Attribute | Description | Type | Accepted Values | Default |
| -------------- | -------------------------------- | ---------------------------- | --------------- | ------- |
| separator | separator character | string | — | / |
| separator-icon | icon component of icon separator | `Component \| (() => VNode)` | — | - |

## Breadcrumb Slots

Expand Down
34 changes: 17 additions & 17 deletions docs/en-US/component/button.md
View file
Open in desktop
Expand Up @@ -125,23 +125,23 @@ button/custom

## Button Attributes

| Attribute | Description | Type | Accepted Values | Default |
| ----------------------------------- | --------------------------------------------------------------- | ------------------ | ------------------------------------------------------------- | ------- |
| size | button size | string | large / default /small | — |
| type | button type | string | primary / success / warning / danger / info / <del>text</del> | — |
| plain | determine whether it's a plain button | boolean | — | false |
| text <VersionTag version="2.2.0" /> | determine whether it's a text button | boolean | — | false |
| bg <VersionTag version="2.2.0" /> | determine whether the text button background color is always on | boolean | — | false |
| link <VersionTag version="2.2.1" /> | determine whether it's a link button | boolean | — | false |
| round | determine whether it's a round button | boolean | — | false |
| circle | determine whether it's a circle button | boolean | — | false |
| loading | determine whether it's loading | boolean | — | false |
| loading-icon | customize loading icon component | string / Component | — | Loading |
| disabled | disable the button | boolean | — | false |
| icon | icon component | string / Component | — | — |
| autofocus | same as native button's `autofocus` | boolean | — | false |
| native-type | same as native button's `type` | string | button / submit / reset | button |
| auto-insert-space | automatically insert a space between two chinese characters | boolean | | — |
| Attribute | Description | Type | Accepted Values | Default |
| ----------------------------------- | --------------------------------------------------------------- | ---------------------------- | ------------------------------------------------------------- | ------- |
| size | button size | string | large / default /small | — |
| type | button type | string | primary / success / warning / danger / info / <del>text</del> | — |
| plain | determine whether it's a plain button | boolean | — | false |
| text <VersionTag version="2.2.0" /> | determine whether it's a text button | boolean | — | false |
| bg <VersionTag version="2.2.0" /> | determine whether the text button background color is always on | boolean | — | false |
| link <VersionTag version="2.2.1" /> | determine whether it's a link button | boolean | — | false |
| round | determine whether it's a round button | boolean | — | false |
| circle | determine whether it's a circle button | boolean | — | false |
| loading | determine whether it's loading | boolean | — | false |
| loading-icon | customize loading icon component | `Component \| (() => VNode)` | — | Loading |
| disabled | disable the button | boolean | — | false |
| icon | icon component | `Component \| (() => VNode)` | — | — |
| autofocus | same as native button's `autofocus` | boolean | — | false |
| native-type | same as native button's `type` | string | button / submit / reset | button |
| auto-insert-space | automatically insert a space between two chinese characters | boolean | | — |

## Button Slots

Expand Down
4 changes: 2 additions & 2 deletions docs/en-US/component/date-picker.md
View file
Open in desktop
Expand Up @@ -160,8 +160,8 @@ Note, date time locale (month name, first day of the week ...) are also configur
| id | same as `id` in native input | string / array(string) | String `id="my-date"` or array `:id="['my-range-start', 'my-range-end']"` for date range | - |
| name | same as `name` in native input | string | — | — |
| unlink-panels | unlink two date-panels in range-picker | boolean | — | false |
| prefix-icon | custom prefix icon component | string / Component | — | Date |
| clear-icon | custom clear icon component | string / Component | — | CircleClose |
| prefix-icon | custom prefix icon component | `Component \| (() => VNode)` | — | Date |
| clear-icon | custom clear icon component | `Component \| (() => VNode)` | — | CircleClose |
| validate-event | whether to trigger form validation | boolean | - | true |
| 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 }] | — | — |
Expand Down
4 changes: 2 additions & 2 deletions docs/en-US/component/datetime-picker.md
View file
Open in desktop
Expand Up @@ -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 / Component | — | Date |
| clear-icon | Custom clear icon component | string / Component | — | CircleClose |
| prefix-icon | Custom prefix icon component | `Component \| (() => VNode)` | — | Date |
| clear-icon | Custom clear icon component | `Component \| (() => VNode)` | — | 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) | — | — |
Expand Down