Skip to content

Commit

Permalink
docs: page component documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mynetfan committed Dec 4, 2024
1 parent b69e7d5 commit 42b22bb
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/.vitepress/config/zh.mts
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,16 @@ function sidebarComponents(): DefaultTheme.SidebarItem[] {
},
],
},
{
collapsed: false,
text: '布局组件',
items: [
{
link: 'layout-ui/page',
text: 'Page 页面',
},
],
},
{
collapsed: false,
text: '通用组件',
Expand Down
4 changes: 4 additions & 0 deletions docs/src/components/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@

:::

## 布局组件

布局组件一般在页面内容区域用作顶层容器组件,提供一些统一的布局样式和基本功能。

## 通用组件

通用组件是一些常用的组件,比如弹窗、抽屉、表单等。大部分基于 `Tailwind CSS` 实现,可适用于不同 UI 组件库的应用。
43 changes: 43 additions & 0 deletions docs/src/components/layout-ui/page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
outline: deep
---

# Page 常规页面组件

提供一个常规页面布局的组件,包括头部、内容区域、底部三个部分。

::: info 写在前面

本组件是一个基本布局组件。如果有更多的通用页面布局需求(比如双列布局等),可以根据实际需求自行封装。

:::

## 基础用法

`Page`作为你的业务页面的根组件即可。

### Props

| 属性名 | 描述 | 类型 | 默认值 |
| ----------------- | ------------------------ | --------- | ------- |
| title | 页面标题 | `string` | - |
| description | 页面描述(标题下的内容) | `string` | - |
| contentClass | 内容区域的class | `string` | - |
| autoContentHeight | 自动调整内容区域的高度 | `boolean` | `false` |
| fixedHeader | 固定头部 | `boolean` | `false` |

::: tip 注意

如果`title``description``extra`三者均未提供有效内容(通过`props`或者`slots`均可),则页面头部区域不会渲染。

:::

### Slots

| 插槽名称 | 描述 |
| ----------- | ------------ |
| default | 页面内容 |
| title | 页面标题 |
| description | 页面描述 |
| extra | 页面头部右侧 |
| footer | 页面底部 |

0 comments on commit 42b22bb

Please sign in to comment.