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.

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

docs(components): [collapse] #14066

Merged
merged 1 commit into from
Aug 28, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 28 additions & 24 deletions docs/en-US/component/collapse.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,36 +37,40 @@ collapse/customization

:::

## Collapse Attributes
## Collapse API

| Name | Description | Type | Accepted Values | Default |
| --------------------- | ---------------------------------- | ---------------------------------------------------- | --------------- | ------- |
| model-value / v-model | currently active panel | string (accordion mode) / array (non-accordion mode) | — | — |
| accordion | whether to activate accordion mode | boolean | — | false |
### Collapse Attributes

## Collapse Events
| Name | Description | Type | Default |
| --------------------- | ---------------------------------- | ---------------------------------------------------------- | ------- |
| model-value / v-model | currently active panel | ^[string] (accordion mode) / ^[array] (non-accordion mode) | — |
| accordion | whether to activate accordion mode | ^[boolean] | false |

| Name | Description | Parameters |
| ------ | ---------------------------------- | ------------------------------------------------------------------- |
| change | triggers when active panels change | (activeNames: array (non-accordion mode) / string (accordion mode)) |
### Collapse Events

## Collapse Slots
| Name | Description | Parameters |
| ------ | ---------------------------------- | --------------------------------------------------------------------- |
| change | triggers when active panels change | `(activeNames: array (non-accordion mode) / string (accordion mode))` |

| Name | Description | Subtags |
| ---- | ------------------------- | ------------- |
| - | customize default content | Collapse Item |
### Collapse Slots

## Collapse Item Attributes
| Name | Description | Subtags |
| ------- | ------------------------- | ------------- |
| default | customize default content | Collapse Item |

| Name | Description | Type | Accepted Values | Default |
| -------- | ---------------------------------- | ------------- | --------------- | ------- |
| name | unique identification of the panel | string/number | — | — |
| title | title of the panel | string | — | — |
| disabled | disable the collapse item | boolean | — | — |
## Collapse Item API

## Collapse Item Slot
### Collapse Item Attributes

| Name | Description |
| ----- | ------------------------------ |
| — | content of Collapse Item |
| title | content of Collapse Item title |
| Name | Description | Type | Default |
| -------- | ---------------------------------- | ------------------- | ------- |
| name | unique identification of the panel | ^[string]/^[number] | — |
| title | title of the panel | ^[string] | — |
| disabled | disable the collapse item | ^[boolean] | — |

### Collapse Item Slot

| Name | Description |
| ------- | ------------------------------ |
| default | content of Collapse Item |
| title | content of Collapse Item title |
Loading