Skip to content

Commit

Permalink
Merge branch 'dev' into dropdown
Browse files Browse the repository at this point in the history
  • Loading branch information
@consultation-applio
consultation-applio committed Oct 11, 2022
2 parents fd68335 + 31f713b commit b816d79
Show file tree
Hide file tree
Showing 52 changed files with 456 additions and 264 deletions.
4 changes: 3 additions & 1 deletion docs/.vitepress/vitepress/components/globals/contributors.vue
View file
Expand Up @@ -5,7 +5,9 @@ import VpLink from '../common/vp-link.vue'
const props = defineProps<{ id: string }>()
const contributors = computed(() => _contributors[props.id])
const contributors = computed(() =>
_contributors[props.id]?.filter((c) => c.login !== 'renovate[bot]')
)
</script>

<template>
Expand Down
16 changes: 8 additions & 8 deletions docs/en-US/component/calendar.md
View file
Expand Up @@ -47,14 +47,14 @@ Note, date time locale (month name, first day of the week ...) are also configur

## Attributes

| Name | Description | Type | Accepted Values | Default |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | --------------- | ------- |
| model-value / v-model | binding value | Date | — | — |
| range | time range, including start time and end time. Start time must be start day of week, end time must be end day of week, the time span cannot exceed two months. | Array\<Date\> | — | — |
| Name | Description | Type | Default |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------- |
| `model-value / v-model` | binding value | `Date` | — |
| `range` | time range, including start time and end time. Start time must be start day of week, end time must be end day of week, the time span cannot exceed two months. | `[Date, Date]` | — |

## Slots

| Name | Description | Attribute |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| date-cell | { type, isSelected, day, date }. `type` indicates which month the date belongs, optional values are prev-month, current-month, next-month; `isSelected` indicates whether the date is selected; `day` is the formatted date in the format YYYY-MM-DD; `date` is date the cell represents | data |
| header | content of the Calendar header | — |
| Name | Description | Type |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `date-cell` | `type` indicates which month the date belongs, optional values are prev-month, current-month, next-month; `isSelected` indicates whether the date is selected; `day` is the formatted date in the format YYYY-MM-DD; `date` is date the cell represents | `{ type: 'prev-month' \| 'current-month' \| 'next-month', isSelected: boolean, day: string, date: Date }` |
| `header` | content of the Calendar header | — |
2 changes: 1 addition & 1 deletion docs/en-US/component/date-picker.md
View file
Expand Up @@ -164,7 +164,7 @@ Note, date time locale (month name, first day of the week ...) are also configur
| clear-icon | custom clear icon component | `string \| Component` | — | 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 | Array\<{ text: string, value: Date \| Function }\> | — | — |
| shortcuts | an object array to set shortcut options | `Array<{ text: string, value: Date \| Function }>` | — | — |
| cell-class-name | set custom className | Function(Date) | — | — |
| teleported | whether date-picker dropdown is teleported to the body | boolean | true / false | true |

Expand Down
4 changes: 2 additions & 2 deletions docs/en-US/component/form.md
View file
Expand Up @@ -133,7 +133,7 @@ form/accessibility
| `label-position` | Position of label. If set to `'left'` or `'right'`, `label-width` prop is also required. | `'left' \| 'right' \| 'top'` | `'right'` |
| `label-width` | Width of label, e.g. `'50px'`. All its direct child form items will inherit this value. `auto` is supported. | `string \| number` | — |
| `label-suffix` | Suffix of the label. | `string` | — |
| `hide-required-asterisk` | Whether to hide required fields should have a red asterisk (star) beside their labels. | `boolean` | `false` |
| `hide-required-asterisk` | Whether to hide required fields should have a red asterisk (star) beside their labels. | `boolean` | `false` |
| `require-asterisk-position` | Position of asterisk. | `'left' \| 'right'` | `'left'` |
| `show-message` | Whether to show the error message. | `boolean` | `true` |
| `inline-message` | Whether to display the error message inline with the form item. | `boolean` | `false` |
Expand Down Expand Up @@ -175,7 +175,7 @@ form/accessibility
| `label` | Label text. | `string` | — |
| `label-width` | Width of label, e.g. `'50px'`. `'auto'` is supported. | `string \| number` | — |
| `required` | Whether the field is required or not, will be determined by validation rules if omitted. | `boolean` | `false` |
| `rules` | Validation rules of form, see the [following table](#formitemrule), more advanced usage at [async-validator](https://github.com/yiminghe/async-validator). | `FormItemRule / FormItemRule[]` | — |
| `rules` | Validation rules of form, see the [following table](#formitemrule), more advanced usage at [async-validator](https://github.com/yiminghe/async-validator). | `FormItemRule \| FormItemRule[]` | — |
| `error` | Field error message, set its value and the field will validate error and show this message immediately. | `string` | — |
| `show-message` | Whether to show the error message. | `boolean` | `true` |
| `inline-message` | Inline style validate message. | `boolean` | `false` |
Expand Down
14 changes: 7 additions & 7 deletions docs/en-US/component/icon.md
View file
Expand Up @@ -214,13 +214,13 @@ import { Edit, Share, Delete, Search, Loading } from '@element-plus/icons-vue'

## Icon Attributes

| Name | Description | Type | Acceptable Value | Default |
| ----- | -------------------------- | ------------------------------ | ---------------- | ---------------------- |
| color | SVG tag's fill attribute | Pick\<CSSProperties, 'color'\> | - | inherit from color |
| size | SVG icon size, size x size | number \| string | - | inherit from font size |
| Name | Description | Type | Default |
| ------- | -------------------------- | ------------------------------ | ---------------------- |
| `color` | SVG tag's fill attribute | `Pick<CSSProperties, 'color'>` | inherit from color |
| `size` | SVG icon size, size x size | `number \| string` | inherit from font size |

## Icon Slots

| Name | Description |
| ---- | ------------------------- |
| — | customize default content |
| Name | Description |
| --------- | ------------------------- |
| `default` | customize default content |

0 comments on commit b816d79

Please sign in to comment.