docs(avatar): rename component Avatar to FAvatar, add document for avatar

This commit is contained in:
Sagi 2022-10-07 22:54:29 +08:00
parent 99e980780e
commit e0101850d1
4 changed files with 43 additions and 4 deletions
packages/ui-vue
components/avatar/src
docs
.vitepress/theme
components/avatar
src/components

View File

@ -5,7 +5,7 @@ import { useImage } from './composition/use-image';
import './avatar.scss';
export default defineComponent({
name: 'Avatar',
name: 'FAvatar',
props: avatarProps,
emits: ['change', 'update:modelValue'],
setup(props: AvatarProps, context: SetupContext) {

View File

@ -1,5 +1,6 @@
// import farris from '../../../components/index';
import Accordion from '../../../components/accordion';
import Avatar from '../../../components/avatar';
import Button from '../../../components/button';
import ButtonEdit from '../../../components/button-edit';
import ComboList from '../../../components/combo-list';
@ -19,7 +20,16 @@ export default {
// ...DefaultTheme,
...FarrisTheme,
enhanceApp({ app }) {
app.use(Accordion).use(Button).use(ButtonEdit).use(ComboList).use(RadioGroup).use(Section).use(Switch).use(Tabs).use(Text);
app.use(Accordion)
.use(Avatar)
.use(Button)
.use(ButtonEdit)
.use(ComboList)
.use(RadioGroup)
.use(Section)
.use(Switch)
.use(Tabs)
.use(Text);
registerComponents(app);
}
};

View File

@ -1 +1,30 @@
# Avatar
# Avatar 头像
Avatar 组件用来展示人员头像。
## 基本用法
:::demo
```vue
<script setup lang="ts">
import { ref } from 'vue';
</script>
<template>
<f-avatar></f-avatar>
</template>
```
:::
## 属性
| 属性名 | 类型 | 默认值 | 说明 |
| :----- | :------- | :----- | :------- |
| id | `string` | -- | 组件标识 |
## 插槽
::: tip
暂无内容
:::

View File

@ -3,5 +3,5 @@ import Avatar from '../../components/avatar/src/avatar.component';
</script>
<template>
<avatar></avatar>
<Avatar></Avatar>
</template>