diff --git a/packages/ui-vue/docs/.vitepress/config/index.ts b/packages/ui-vue/docs/.vitepress/config/index.ts index f7eb8e2b03d043e07335f3bde588e49f7f5f7774..d1ebec53297d20c5f22c890316d882a2ef8ad6da 100644 --- a/packages/ui-vue/docs/.vitepress/config/index.ts +++ b/packages/ui-vue/docs/.vitepress/config/index.ts @@ -12,7 +12,7 @@ const config = defineConfig({ themeConfig: { nav, sidebar, - logo: '../../assets/farris_design.jpg', + logo: '/assets/farris_design.jpg', footer: { message: '使用 Apache-2.0 开源许可协议', copyright: 'Copyright © 2022' diff --git a/packages/ui-vue/docs/.vitepress/theme/index.ts b/packages/ui-vue/docs/.vitepress/theme/index.ts index bb8deca4ea4f87f9bfceb4edaa965e0fdc20963a..2c13db8954f0cdfde9b8df0c553e8d4eb252aaa8 100644 --- a/packages/ui-vue/docs/.vitepress/theme/index.ts +++ b/packages/ui-vue/docs/.vitepress/theme/index.ts @@ -1,4 +1,6 @@ // import farris from '../../../components/index'; +import Accordion from '../../../components/accordion'; +import Button from '../../../components/button'; import ButtonEdit from '../../../components/button-edit'; import Switch from '../../../components/switch'; // import DefaultTheme from 'vitepress/theme'; @@ -12,7 +14,7 @@ export default { // ...DefaultTheme, ...FarrisTheme, enhanceApp({ app }) { - app.use(ButtonEdit).use(Switch); + app.use(Accordion).use(Button).use(ButtonEdit).use(Switch); registerComponents(app); } }; diff --git a/packages/ui-vue/docs/components/accordion/index.md b/packages/ui-vue/docs/components/accordion/index.md index 4b0b7ed14e9ad073b76be4d347e444f29fdf6c0b..38be22303b10f010fa88febde8cb849f9647d502 100644 --- a/packages/ui-vue/docs/components/accordion/index.md +++ b/packages/ui-vue/docs/components/accordion/index.md @@ -1 +1,37 @@ -# Accordion \ No newline at end of file +# Accordion 手风琴 + +Accordion 组件为开发者提供了一种可收折的导航面板。 + +## 基本用法 + +:::demo + +```vue + + +``` + +::: + +## 属性 + +| 属性名 | 类型 | 默认值 | 说明 | +| :---------- | :--------- | :----- | :--------------- | +| customClass | `string[]` | [] | 组件自定义样式 | +| enableFold | `boolean` | true | 是否允许收折 | +| expanded | `boolean` | false | 是否展开所有面板 | +| height | `number` | -- | 设置组件的高度 | +| width | `number` | -- | 设置组件的宽度 | + +## 插槽 + +::: tip +暂无内容 +::: diff --git a/packages/ui-vue/docs/components/button/index.md b/packages/ui-vue/docs/components/button/index.md index 4fa718b1c055a22d240e50e5a1a2e6025b3c8bb6..06bc654b9ac1876024e45bd1c5fafa93742c8f26 100644 --- a/packages/ui-vue/docs/components/button/index.md +++ b/packages/ui-vue/docs/components/button/index.md @@ -1 +1,62 @@ -# Button \ No newline at end of file +# Button 按钮 + +Button 组件为不同使用场景提供了多种展示样式。 + +## 基本用法 + +:::demo + +```vue + + +``` + +::: + +## 状态 + +:::demo + +```vue + + +``` + +::: + +## 类型 + +```typescript +type ButtonType = 'primary' | 'warning' | 'danger' | 'success' | 'link' | 'secondary'; +type SizeType = 'small' | 'large'; +``` + +## 属性 + +| 属性名 | 类型 | 默认值 | 说明 | +| :--------- | :--------------------- | :-------- | :------------------- | +| id | `string` | -- | 标记组件的唯一标识 | +| buttonType | `string as ButtonType` | 'primary' | 按钮显示样式 | +| disable | `boolean` | false | 将按钮设置为禁用状态 | +| size | `string as SizeType` | 'small' | 按钮尺寸 | + +## 事件 + +| 事件名 | 类型 | 说明 | +| :----- | :------------------ | :----------- | +| click | `EventEmitter` | 点击按钮事件 | + +## 插槽 + +::: tip +暂无内容 +:::