diff --git a/packages/ui-vue/docs/.vitepress/theme/index.ts b/packages/ui-vue/docs/.vitepress/theme/index.ts index feac3b4..8514730 100644 --- a/packages/ui-vue/docs/.vitepress/theme/index.ts +++ b/packages/ui-vue/docs/.vitepress/theme/index.ts @@ -2,6 +2,7 @@ import Accordion from '../../../components/accordion'; import Button from '../../../components/button'; import ButtonEdit from '../../../components/button-edit'; +import RadioGroup from '../../../components/radio-group'; import Section from '../../../components/section'; import Switch from '../../../components/switch'; import Tabs from '../../../components/tabs'; @@ -16,7 +17,7 @@ export default { // ...DefaultTheme, ...FarrisTheme, enhanceApp({ app }) { - app.use(Accordion).use(Button).use(ButtonEdit).use(Section).use(Switch).use(Tabs); + app.use(Accordion).use(Button).use(ButtonEdit).use(RadioGroup).use(Section).use(Switch).use(Tabs); registerComponents(app); } }; diff --git a/packages/ui-vue/docs/components/radio-group/index.md b/packages/ui-vue/docs/components/radio-group/index.md index 7782aff..2ca2e1b 100644 --- a/packages/ui-vue/docs/components/radio-group/index.md +++ b/packages/ui-vue/docs/components/radio-group/index.md @@ -1 +1,135 @@ -# Radio Group \ No newline at end of file +# Radio Group 单选组 + +Radio Group 是一个单选一组枚举值的输入组件。 + +## 基本用法 + +:::demo + +```vue + + +``` + +::: + +## 禁用状态 + +:::demo + +```vue + + +``` + +::: + +## 排列方式 + +:::demo + +```vue + + +``` + +::: + +## 类型 + +```typescript +export interface Radio { + /** + * 枚举值 + */ + value: ComputedRef; + /** + * 枚举展示文本 + */ + name: ComputedRef; +} + +export interface ChangeRadio { + enumData: ComputedRef>; + + /** + * 获取枚举值 + */ + getValue(item: Radio): any; + /** + * 获取枚举文本 + */ + getText(item: Radio): any; + + /** + * 切换单选按钮事件 + */ + onClickRadio: (item: Radio, $event: Event) => void; +} +``` + +## 属性 + +| 属性名 | 类型 | 默认值 | 说明 | +| :--------- | :-------------------- | :------ | :----------------- | +| id | `string` | -- | 组件标识 | +| name | `string` | -- | 组件名称 | +| enumData | `object[] as Radio[]` | [] | 单选组数据源 | +| textField | `string` | 'name' | 显示文本字段 | +| valueField | `string` | 'value' | 值字段 | +| horizontal | `boolean` | false | 是否横向显示枚举项 | +| disabled | `boolean` | false | 是否禁用组件 | +| tabIndex | `number` | -- | Tab 键索引 | + +## 插槽 + +::: tip +暂无内容 +:::