review:【全局】Description 组件

pull/85/head
YunaiV 2025-04-26 09:39:52 +08:00
parent 7a9df83d71
commit 059687e1f5
4 changed files with 26 additions and 4 deletions

View File

@ -1,12 +1,14 @@
<script lang="tsx">
import type { DescriptionItemSchema, DescriptionsOptions } from './typing';
import type { DescriptionsProps } from 'ant-design-vue';
import type { PropType } from 'vue';
import { Descriptions, DescriptionsItem } from 'ant-design-vue';
import type { DescriptionItemSchema, DescriptionsOptions } from './typing';
import { defineComponent } from 'vue';
import { Descriptions, DescriptionsItem } from 'ant-design-vue';
/** 对 Descriptions 进行二次封装 */
const Description = defineComponent({
name: 'Descriptions',
@ -27,15 +29,21 @@ const Description = defineComponent({
},
setup(props: DescriptionsOptions) {
// TODO @puhui999 field slot
// TODO @puhui999from 5.0extra: () => getSlot(slots, 'extra')
/** 过滤掉不需要展示的 */
const shouldShowItem = (item: DescriptionItemSchema) => {
if (item.hidden === undefined) return true;
return typeof item.hidden === 'function' ? !item.hidden(props.data) : !item.hidden;
return typeof item.hidden === 'function'
? !item.hidden(props.data)
: !item.hidden;
};
/** 渲染内容 */
const renderContent = (item: DescriptionItemSchema) => {
if (item.content) {
return typeof item.content === 'function' ? item.content(props.data) : item.content;
return typeof item.content === 'function'
? item.content(props.data)
: item.content;
}
return item.field ? props.data?.[item.field] : null;
};
@ -67,5 +75,6 @@ const Description = defineComponent({
},
});
// TODO @puhui999from 5.0emits: ['register']
export default Description;
</script>

View File

@ -1,6 +1,10 @@
import type { DescriptionsProps } from 'ant-design-vue';
import type { CSSProperties, VNode } from 'vue';
// TODO @puhui999【content】这个纠结下1vben2.0 是 renderhttps://doc.vvbin.cn/components/desc.html#usage 2
// TODO @puhui999vben2.0 还有 sapn【done】、labelMinWidth、contentMinWidth
// TODO @puhui999【hidden】这个纠结下1vben2.0 是 show
export interface DescriptionItemSchema {
label: string | VNode; // 内容的描述
field?: string; // 对应 data 中的字段名
@ -11,6 +15,11 @@ export interface DescriptionItemSchema {
hidden?: ((data: any) => boolean) | boolean; // 是否显示
}
// TODO @puhui999vben2.0 还有 title【done】、bordered【done】d、useCollapse、collapseOptions
// TODO @puhui999from 5.0bordered 默认为 true
// TODO @puhui999from 5.0column 默认为 lg: 3, md: 3, sm: 2, xl: 3, xs: 1, xxl: 4
// TODO @puhui999from 5.0size 默认为 small有 'default', 'middle', 'small', undefined
// TODO @puhui999from 5.0useCollapse 默认为 true
export interface DescriptionsOptions {
data?: Record<string, any>; // 数据
schema?: DescriptionItemSchema[]; // 描述项配置

View File

@ -16,6 +16,7 @@ class DescriptionApi {
return this.state as DescriptionsOptions;
}
// TODO @puhui999【setState】纠结下1vben2.0 是 data https://doc.vvbin.cn/components/desc.html#usage
setState(newState: Partial<DescriptionsOptions>) {
this.state = { ...this.state, ...newState };
}

View File

@ -10,8 +10,10 @@ import { useDescription } from '#/components/description';
import { DictTag } from '#/components/dict-tag';
import { DICT_TYPE } from '#/utils/dict';
// TODO @puhui999formData
const formData = ref<SystemNotifyMessageApi.NotifyMessage>();
// TODO @puhui999descriptionApi
const [Description, descApi] = useDescription({
componentProps: {
bordered: true,
@ -19,6 +21,7 @@ const [Description, descApi] = useDescription({
size: 'middle',
class: 'mx-4',
},
// TODO @puhui999 data
schema: [
{
field: 'templateNickname',