docs(components): [collapse] use new display tag (#14955)

docs(components): [collapse] use new display tag
element-plus · Dec 26, 2023 · 3fdab26 · 3fdab26
1 parent 34effd4
commit 3fdab26
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 12 deletions.
diff --git a/docs/en-US/component/collapse.md b/docs/en-US/component/collapse.md
@@ -41,16 +41,16 @@ collapse/customization
 
 ### Collapse Attributes
 
-| 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                                                                             | Type                 | Default |
+| --------------------- | --------------------------------------------------------------------------------------- | -------------------- | ------- |
+| model-value / v-model | currently active panel, the type is `string` in accordion mode, otherwise it is `array` | ^[string] / ^[array] | []      |
+| accordion             | whether to activate accordion mode                                                      | ^[boolean]           | false   |
 
 ### Collapse Events
 
-| Name   | Description                        | Parameters                                                            |
-| ------ | ---------------------------------- | --------------------------------------------------------------------- |
-| change | triggers when active panels change | `(activeNames: array (non-accordion mode) / string (accordion mode))` |
+| Name   | Description                                                                                                   | Type                                                |
+| ------ | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
+| change | triggers when active panels change, the parameter type is `string` in accordion mode, otherwise it is `array` | ^[Function]`(activeNames: array \| string) => void` |
 
 ### Collapse Slots
 
@@ -62,11 +62,11 @@ collapse/customization
 
 ### Collapse Item Attributes
 
-| Name     | Description                        | Type                | Default |
-| -------- | ---------------------------------- | ------------------- | ------- |
-| name     | unique identification of the panel | ^[string]/^[number] | —       |
-| title    | title of the panel                 | ^[string]           | —       |
-| disabled | disable the collapse item          | ^[boolean]          | —       |
+| Name     | Description                        | Type                  | Default |
+| -------- | ---------------------------------- | --------------------- | ------- |
+| name     | unique identification of the panel | ^[string] / ^[number] | —       |
+| title    | title of the panel                 | ^[string]             | ''      |
+| disabled | disable the collapse item          | ^[boolean]            | false   |
 
 ### Collapse Item Slot
 

diff --git a/packages/components/collapse/src/collapse-item.ts b/packages/components/collapse/src/collapse-item.ts
@@ -3,14 +3,23 @@ import type { ExtractPropTypes } from 'vue'
 import type { CollapseActiveName } from './collapse'
 
 export const collapseItemProps = buildProps({
+  /**
+   * @description title of the panel
+   */
   title: {
     type: String,
     default: '',
   },
+  /**
+   * @description unique identification of the panel
+   */
   name: {
     type: definePropType<CollapseActiveName>([String, Number]),
     default: () => generateId(),
   },
+  /**
+   * @description disable the collapse item
+   */
   disabled: Boolean,
 } as const)
 export type CollapseItemProps = ExtractPropTypes<typeof collapseItemProps>
diff --git a/packages/components/collapse/src/collapse.ts b/packages/components/collapse/src/collapse.ts
@@ -17,7 +17,13 @@ export const emitChangeFn = (value: CollapseModelValue) =>
   isNumber(value) || isString(value) || isArray(value)
 
 export const collapseProps = buildProps({
+  /**
+   * @description whether to activate accordion mode
+   */
   accordion: Boolean,
+  /**
+   * @description currently active panel, the type is `string` in accordion mode, otherwise it is `array`
+   */
   modelValue: {
     type: definePropType<CollapseModelValue>([Array, String, Number]),
     default: () => mutable([] as const),