docs(components): [page-header] use new display tag (element-plus#12665)

* docs(components): [page-header] use new display tag * docs(components): [page-header] update title property doc
consultation-applio · Nov 10, 2023 · 5c2ef5a · 5c2ef5a
1 parent b9924ba
commit 5c2ef5a
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 24 deletions.
diff --git a/docs/en-US/component/page-header.md b/docs/en-US/component/page-header.md
@@ -98,27 +98,29 @@ The component is consisted of these parts
 </template>
 ```
 
-## Attributes
-
-| Name    | Description    | Type                  | Accepted Values | Default |
-| ------- | -------------- | --------------------- | --------------- | ------- |
-| icon    | icon component | `string \| Component` | —               | Back    |
-| title   | main title     | string                | —               | Back    |
-| content | content        | string                | —               | —       |
-
-## Events
-
-| Name | Description                         | Parameters |
-| ---- | ----------------------------------- | ---------- |
-| back | triggers when right side is clicked | —          |
-
-## Slots
-
-| Name       | Description        |
-| ---------- | ------------------ |
-| icon       | custom icon        |
-| title      | title content      |
-| content    | content            |
-| extra      | extra              |
-| breadcrumb | breadcrumb content |
-| default    | main content       |
+## API
+
+### Attributes
+
+| Name    | Description                                                   | Type                     | Default |
+| ------- | ------------------------------------------------------------- | ------------------------ | ------- |
+| icon    | icon component of page header                                 | ^[string] / ^[Component] | Back    |
+| title   | main title of page header, default is Back that built-in a11y | ^[string]                | ''      |
+| content | content of page header                                        | ^[string]                | ''      |
+
+### Events
+
+| Name | Description                         | Type                    |
+| ---- | ----------------------------------- | ----------------------- |
+| back | triggers when right side is clicked | ^[Function]`() => void` |
+
+### Slots
+
+| Name       | Description           |
+| ---------- | --------------------- |
+| icon       | content as icon       |
+| title      | content as title      |
+| content    | content               |
+| extra      | extra                 |
+| breadcrumb | content as breadcrumb |
+| default    | main content          |
diff --git a/packages/components/page-header/src/page-header.ts b/packages/components/page-header/src/page-header.ts
@@ -4,11 +4,20 @@ import type { ExtractPropTypes } from 'vue'
 import type PageHeader from './page-header.vue'
 
 export const pageHeaderProps = buildProps({
+  /**
+   * @description icon component of page header
+   */
   icon: {
     type: iconPropType,
     default: () => Back,
   },
+  /**
+   * @description main title of page header
+   */
   title: String,
+  /**
+   * @description content of page header
+   */
   content: {
     type: String,
     default: '',