Skip to content

Commit

Permalink
docs: updata (#543)
Browse files Browse the repository at this point in the history
  • Loading branch information
@tolking
tolking authored Dec 11, 2024
1 parent 114ff6e commit 554a499
Show file tree
Hide file tree
Showing 32 changed files with 946 additions and 917 deletions.
10 changes: 5 additions & 5 deletions docs/en-US/components/AutocompleteTag.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ When using `pro-autocomplete-tag`, most attribute of `ElAutocomplete` are suppor

## Events

| Name | Description | Parameters |
| ---------- | ------------------------------------- | --------------- |
| input | triggers when the Input value change | (value: string) |
| tag-add | triggers when add a tag | (value: string) |
| tag-remove | triggers when close button is clicked | (value: string) |
| Name | Description | Type |
| ---------- | ------------------------------------- | ----------------------- |
| input | triggers when the Input value change | (value: string) => void |
| tag-add | triggers when add a tag | (value: string) => void |
| tag-remove | triggers when close button is clicked | (value: string) => void |
12 changes: 6 additions & 6 deletions docs/en-US/components/Checkbox.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ use `pro-checkbox-button` then checkbox with button styles

### Checkbox Events

| Name | Description | Parameters |
| ------ | --------------------------------------- | ----------------- |
| change | triggers when the binding value changes | the updated value |
| Name | Description | Type |
| ------ | --------------------------------------- | ------------------------------------- |
| change | triggers when the binding value changes | (value: string[] \| number[]) => void |

## CheckboxButton

Expand All @@ -85,6 +85,6 @@ use `pro-checkbox-button` then checkbox with button styles

### CheckboxButton Events

| Name | Description | Parameters |
| ------ | --------------------------------------- | ----------------- |
| change | triggers when the binding value changes | the updated value |
| Name | Description | Type |
| ------ | --------------------------------------- | ------------------------------------- |
| change | triggers when the binding value changes | (value: string[] \| number[]) => void |
6 changes: 3 additions & 3 deletions docs/en-US/components/ColumnSetting.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,6 @@ Supports operations on grouping table head, and columns can be dragged into or o

### Slots

| Name | Description |
| :------ | :--------------------------------------------- |
| default | custom the trigger button, parameters { size } |
| Name | Description | Type |
| :------ | :------------------------ | :------- |
| default | custom the trigger button | { size } |
340 changes: 171 additions & 169 deletions docs/en-US/components/Crud.md
View file

Large diffs are not rendered by default.

41 changes: 22 additions & 19 deletions docs/en-US/components/Descriptions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,18 +63,19 @@ The function `defineDescriptionsColumns` supports passing in a Generics type to

### Props

| Name | Description | Type | Options | Default |
| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------ | :------ | :--------------------- | :--------- |
| columns | to generate descriptions list, reference `columns` | array | - | - |
| detail | detail data of display | object | - | - |
| border | with or without border | boolean | - | false |
| column | numbers of `Descriptions Item` in one line | number | - | 3 |
| direction | direction of list | string | vertical / horizontal | horizontal |
| size | size of list | string | large / default /small | - |
| title | title text, display on the top left | string | - | - |
| extra | extra text, display on the top right | string | - | - |
| align | column content alignment (If no `border`, effective for both label and content) | string | left / center / right | left |
| label-align | column label alignment, if omitted, the value of the above `align` attribute will be applied (If no `border`, please use `align` attribute) | string | left / center / right | - |
| Name | Description | Type | Options | Default |
| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------ | :-------------- | :--------------------- | :--------- |
| columns | to generate descriptions list, reference `columns` | array | - | - |
| detail | detail data of display | object | - | - |
| border | with or without border | boolean | - | false |
| column | numbers of `Descriptions Item` in one line | number | - | 3 |
| direction | direction of list | string | vertical / horizontal | horizontal |
| size | size of list | string | large / default /small | - |
| title | title text, display on the top left | string | - | - |
| extra | extra text, display on the top right | string | - | - |
| align | column content alignment (If no `border`, effective for both label and content) | string | left / center / right | left |
| label-width | label width of every column | string / number | - | - |
| label-align | column label alignment, if omitted, the value of the above `align` attribute will be applied (If no `border`, please use `align` attribute) | string | left / center / right | - |

### columns

Expand All @@ -83,9 +84,11 @@ The function `defineDescriptionsColumns` supports passing in a Generics type to
| prop | the key of detail | string | - | - |
| label | label text | string | - | - |
| span | colspan of column | number | - | 1 |
| rowspan | the number of rows a cell should span | number | - | 1 |
| width | column width, the width of the same column in different rows is set by the max value (If no `border`, width contains label and content) | string | - | - |
| minWidth | column minimum width, columns with `width` has a fixed width, while columns with `min-width` has a width that is distributed in proportion (If no`border`, width contains label and content) | string | - | - |
| align | column content alignment (If no `border`, effective for both label and content) | string | left / center / right | left |
| labelWidth | column label width, if not set, it will be the same as the width of the column. Higher priority than the `label-width` of `Descriptions` | string / number | - | - |
| labelAlign | column label alignment, if omitted, the value of the above `align` attribute will be applied (If no `border`, please use `align` attribute) | string | left / center / right | - |
| className | column content custom class name | string | - | - |
| labelClassName | column label custom class name | string | - | - |
Expand All @@ -94,13 +97,13 @@ The function `defineDescriptionsColumns` supports passing in a Generics type to

## Slots

| Name | Description |
| ------------------- | ------------------------------------------------------------------- |
| - | insert more descriptions information at the end |
| title | custom title, display on the top left, parameters { size } |
| extra | custom extra area, display on the top right, parameters { size } |
| detail-[prop] | control the `Item` display content, parameters { size, item } |
| detail-[prop]-label | control the `Item` label display content, parameters { size, item } |
| Name | Description | Type |
| ------------------- | ----------------------------------------------- | :------------- |
| - | insert more descriptions information at the end | - |
| title | custom title, display on the top left | { size } |
| extra | custom extra area, display on the top right | { size } |
| detail-[prop] | control the `Item` display content | { size, item } |
| detail-[prop]-label | control the `Item` label display content | { size, item } |

::: tip Tip
[prop] the prop of columns
Expand Down
15 changes: 8 additions & 7 deletions docs/en-US/components/FilterRoutes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,14 @@ You can customize HTML templates for options

### Events

| Name | Description | Parameters |
| -------------- | ------------------------------------------------------------- | ----------------------------------------- |
| change | triggers when the selected value changes | current selected value |
| visible-change | triggers when the dropdown appears/disappears | true when it appears, and false otherwise |
| clear | triggers when the clear icon is clicked in a clearable Select | — |
| blur | triggers when Input blurs | (event: Event) |
| focus | triggers when Input focuses | (event: Event) |
| Name | Description | Type |
| -------------- | ------------------------------------------------------------- | --------------------------- |
| change | triggers when the selected value changes | (value: any) => void |
| visible-change | triggers when the dropdown appears/disappears | (visible: boolean) => void |
| remove-tag | triggers when a tag is removed in multiple mode | (tagValue: any) => void |
| clear | triggers when the clear icon is clicked in a clearable Select | () => void |
| blur | triggers when Input blurs | (event: FocusEvent) => void |
| focus | triggers when Input focuses | (event: FocusEvent) => void |

### Slots

Expand Down
Loading

0 comments on commit 554a499

Please sign in to comment.