98dea92225
* feat(@vben-core/form-ui): add typed form value codecs * test(@vben-core/form-ui): cover codec value boundaries * refactor(project): propagate form codec generics * feat(@vben/plugins): propagate form codecs through vxe grids * refactor(@vben/playground): migrate form codec examples * refactor(@vben/playground): migrate query forms to codecs * docs(@vben/docs): document form value codecs
524 lines
13 KiB
Vue
524 lines
13 KiB
Vue
<script lang="ts" setup>
|
|
import type { Recordable } from '@vben/types';
|
|
|
|
import type { VbenFormSchema } from '#/adapter/form';
|
|
|
|
import { computed, h, ref } from 'vue';
|
|
|
|
import { useVbenDrawer } from '@vben/common-ui';
|
|
import { IconifyIcon } from '@vben/icons';
|
|
import { $te } from '@vben/locales';
|
|
import { getPopupContainer } from '@vben/utils';
|
|
|
|
import { breakpointsTailwind, useBreakpoints } from '@vueuse/core';
|
|
|
|
import { useVbenForm, z } from '#/adapter/form';
|
|
import {
|
|
createMenu,
|
|
getMenuList,
|
|
isMenuNameExists,
|
|
isMenuPathExists,
|
|
SystemMenuApi,
|
|
updateMenu,
|
|
} from '#/api/system/menu';
|
|
import { $t } from '#/locales';
|
|
import { componentKeys } from '#/router/routes';
|
|
|
|
import { getMenuTypeOptions } from '../data';
|
|
|
|
const emit = defineEmits<{
|
|
success: [];
|
|
}>();
|
|
const formData = ref<SystemMenuApi.SystemMenu>();
|
|
const titleSuffix = ref<string>();
|
|
|
|
type MenuSubmitValues = Omit<SystemMenuApi.SystemMenu, 'children' | 'id'>;
|
|
type MenuFormValues = MenuSubmitValues & { linkSrc?: string };
|
|
|
|
function encodeMenuFormValues(
|
|
values: Readonly<MenuFormValues>,
|
|
): MenuSubmitValues {
|
|
const { linkSrc, ...formValues } = values;
|
|
if (values.type === 'link') {
|
|
return {
|
|
...formValues,
|
|
meta: { ...values.meta, link: linkSrc },
|
|
};
|
|
}
|
|
if (values.type === 'embedded') {
|
|
return {
|
|
...formValues,
|
|
meta: { ...values.meta, iframeSrc: linkSrc },
|
|
};
|
|
}
|
|
return formValues;
|
|
}
|
|
|
|
function decodeMenuFormValues(
|
|
values: Readonly<MenuSubmitValues>,
|
|
): MenuFormValues {
|
|
let linkSrc: string | undefined;
|
|
if (values.type === 'link') {
|
|
linkSrc = values.meta?.link;
|
|
} else if (values.type === 'embedded') {
|
|
linkSrc = values.meta?.iframeSrc;
|
|
}
|
|
return { ...values, linkSrc };
|
|
}
|
|
|
|
const schema: VbenFormSchema<MenuFormValues>[] = [
|
|
{
|
|
component: 'RadioGroup',
|
|
componentProps: {
|
|
buttonStyle: 'solid',
|
|
options: getMenuTypeOptions(),
|
|
optionType: 'button',
|
|
},
|
|
defaultValue: 'menu',
|
|
fieldName: 'type',
|
|
formItemClass: 'col-span-2 md:col-span-2',
|
|
label: $t('system.menu.type'),
|
|
},
|
|
{
|
|
component: 'Input',
|
|
fieldName: 'name',
|
|
label: $t('system.menu.menuName'),
|
|
rules: z
|
|
.string()
|
|
.min(2, $t('ui.formRules.minLength', [$t('system.menu.menuName'), 2]))
|
|
.max(30, $t('ui.formRules.maxLength', [$t('system.menu.menuName'), 30]))
|
|
.refine(
|
|
async (value: string) => {
|
|
return !(await isMenuNameExists(value, formData.value?.id));
|
|
},
|
|
{
|
|
error: (issue) =>
|
|
$t('ui.formRules.alreadyExists', [
|
|
$t('system.menu.menuName'),
|
|
issue.input,
|
|
]),
|
|
},
|
|
),
|
|
},
|
|
{
|
|
component: 'ApiTreeSelect',
|
|
componentProps: {
|
|
api: getMenuList,
|
|
class: 'w-full',
|
|
filterTreeNode(input: string, node: Recordable<any>) {
|
|
if (!input || input.length === 0) {
|
|
return true;
|
|
}
|
|
const title: string = node.meta?.title ?? '';
|
|
if (!title) return false;
|
|
return title.includes(input) || $t(title).includes(input);
|
|
},
|
|
getPopupContainer,
|
|
labelField: 'meta.title',
|
|
showSearch: true,
|
|
treeDefaultExpandAll: true,
|
|
valueField: 'id',
|
|
childrenField: 'children',
|
|
},
|
|
fieldName: 'pid',
|
|
label: $t('system.menu.parent'),
|
|
renderComponentContent() {
|
|
return {
|
|
treeTitleRender({
|
|
label,
|
|
meta,
|
|
}: {
|
|
label: string;
|
|
meta: Recordable<any>;
|
|
}) {
|
|
const coms = [];
|
|
if (!label) return '';
|
|
if (meta?.icon) {
|
|
coms.push(h(IconifyIcon, { class: 'size-4', icon: meta.icon }));
|
|
}
|
|
coms.push(h('span', { class: '' }, $t(label || '')));
|
|
return h('div', { class: 'flex items-center gap-1' }, coms);
|
|
},
|
|
};
|
|
},
|
|
},
|
|
{
|
|
component: 'Input',
|
|
componentProps() {
|
|
// 不需要处理多语言时就无需这么做
|
|
return {
|
|
...(titleSuffix.value && { addonAfter: titleSuffix.value }),
|
|
onChange({ target: { value } }: { target: { value: string } }) {
|
|
titleSuffix.value = value && $te(value) ? $t(value) : undefined;
|
|
},
|
|
};
|
|
},
|
|
fieldName: 'meta.title',
|
|
label: $t('system.menu.menuTitle'),
|
|
rules: 'required',
|
|
},
|
|
{
|
|
component: 'Input',
|
|
dependencies: {
|
|
show: (values) => {
|
|
return ['catalog', 'embedded', 'menu'].includes(values.type);
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'path',
|
|
label: $t('system.menu.path'),
|
|
rules: z
|
|
.string()
|
|
.min(2, $t('ui.formRules.minLength', [$t('system.menu.path'), 2]))
|
|
.max(100, $t('ui.formRules.maxLength', [$t('system.menu.path'), 100]))
|
|
.refine(
|
|
async (value: string) => {
|
|
return !(await isMenuPathExists(value, formData.value?.id));
|
|
},
|
|
{
|
|
error: (issue) =>
|
|
$t('ui.formRules.alreadyExists', [
|
|
$t('system.menu.path'),
|
|
issue.input,
|
|
]),
|
|
},
|
|
),
|
|
},
|
|
{
|
|
component: 'Input',
|
|
dependencies: {
|
|
show: (values) => {
|
|
return ['embedded', 'menu'].includes(values.type);
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'activePath',
|
|
help: $t('system.menu.activePathHelp'),
|
|
label: $t('system.menu.activePath'),
|
|
rules: z
|
|
.string()
|
|
.min(2, $t('ui.formRules.minLength', [$t('system.menu.path'), 2]))
|
|
.max(100, $t('ui.formRules.maxLength', [$t('system.menu.path'), 100]))
|
|
.refine(async (value: string) => {
|
|
return await isMenuPathExists(value, formData.value?.id);
|
|
}, $t('system.menu.activePathMustExist'))
|
|
.optional(),
|
|
},
|
|
{
|
|
component: 'IconPicker',
|
|
componentProps: {
|
|
prefix: 'carbon',
|
|
},
|
|
dependencies: {
|
|
show: (values) => {
|
|
return ['catalog', 'embedded', 'link', 'menu'].includes(values.type);
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'meta.icon',
|
|
label: $t('system.menu.icon'),
|
|
},
|
|
{
|
|
component: 'IconPicker',
|
|
componentProps: {
|
|
prefix: 'carbon',
|
|
},
|
|
dependencies: {
|
|
show: (values) => {
|
|
return ['catalog', 'embedded', 'menu'].includes(values.type);
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'meta.activeIcon',
|
|
label: $t('system.menu.activeIcon'),
|
|
},
|
|
{
|
|
component: 'AutoComplete',
|
|
componentProps: {
|
|
allowClear: true,
|
|
class: 'w-full',
|
|
filterOption(input: string, option: { value: string }) {
|
|
return option.value.toLowerCase().includes(input.toLowerCase());
|
|
},
|
|
options: componentKeys.map((v) => ({ value: v })),
|
|
},
|
|
dependencies: {
|
|
rules: (values) => {
|
|
return values.type === 'menu' ? 'required' : null;
|
|
},
|
|
show: (values) => {
|
|
return values.type === 'menu';
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'component',
|
|
label: $t('system.menu.component'),
|
|
},
|
|
{
|
|
component: 'Input',
|
|
dependencies: {
|
|
show: (values) => {
|
|
return ['embedded', 'link'].includes(values.type);
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'linkSrc',
|
|
label: $t('system.menu.linkSrc'),
|
|
rules: z.url($t('ui.formRules.invalidURL')),
|
|
},
|
|
{
|
|
component: 'Input',
|
|
dependencies: {
|
|
rules: (values) => {
|
|
return values.type === 'button' ? 'required' : null;
|
|
},
|
|
show: (values) => {
|
|
return ['button', 'catalog', 'embedded', 'menu'].includes(values.type);
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'authCode',
|
|
label: $t('system.menu.authCode'),
|
|
},
|
|
{
|
|
component: 'RadioGroup',
|
|
componentProps: {
|
|
buttonStyle: 'solid',
|
|
options: [
|
|
{ label: $t('common.enabled'), value: 1 },
|
|
{ label: $t('common.disabled'), value: 0 },
|
|
],
|
|
optionType: 'button',
|
|
},
|
|
defaultValue: 1,
|
|
fieldName: 'status',
|
|
label: $t('system.menu.status'),
|
|
},
|
|
{
|
|
component: 'Select',
|
|
componentProps: {
|
|
allowClear: true,
|
|
class: 'w-full',
|
|
options: [
|
|
{ label: $t('system.menu.badgeType.dot'), value: 'dot' },
|
|
{ label: $t('system.menu.badgeType.normal'), value: 'normal' },
|
|
],
|
|
},
|
|
dependencies: {
|
|
show: (values) => {
|
|
return values.type !== 'button';
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'meta.badgeType',
|
|
label: $t('system.menu.badgeType.title'),
|
|
},
|
|
{
|
|
component: 'Input',
|
|
dependencies: {
|
|
resolve: ({ values }) => {
|
|
return {
|
|
componentProps: {
|
|
allowClear: true,
|
|
class: 'w-full',
|
|
disabled: values.meta?.badgeType !== 'normal',
|
|
},
|
|
show: values.type !== 'button',
|
|
};
|
|
},
|
|
triggerFields: ['meta.badgeType', 'type'],
|
|
},
|
|
fieldName: 'meta.badge',
|
|
label: $t('system.menu.badge'),
|
|
},
|
|
{
|
|
component: 'Select',
|
|
componentProps: {
|
|
allowClear: true,
|
|
class: 'w-full',
|
|
options: SystemMenuApi.BadgeVariants.map((v) => ({
|
|
label: v,
|
|
value: v,
|
|
})),
|
|
},
|
|
dependencies: {
|
|
show: (values) => {
|
|
return values.type !== 'button';
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'meta.badgeVariants',
|
|
label: $t('system.menu.badgeVariants'),
|
|
},
|
|
{
|
|
component: 'Divider',
|
|
dependencies: {
|
|
show: (values) => {
|
|
return !['button', 'link'].includes(values.type);
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'divider1',
|
|
formItemClass: 'col-span-2 md:col-span-2 pb-0',
|
|
hideLabel: true,
|
|
renderComponentContent() {
|
|
return {
|
|
default: () => $t('system.menu.advancedSettings'),
|
|
};
|
|
},
|
|
},
|
|
{
|
|
component: 'Checkbox',
|
|
dependencies: {
|
|
show: (values) => {
|
|
return ['menu'].includes(values.type);
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'meta.keepAlive',
|
|
renderComponentContent() {
|
|
return {
|
|
default: () => $t('system.menu.keepAlive'),
|
|
};
|
|
},
|
|
},
|
|
{
|
|
component: 'Checkbox',
|
|
dependencies: {
|
|
show: (values) => {
|
|
return ['embedded', 'menu'].includes(values.type);
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'meta.affixTab',
|
|
renderComponentContent() {
|
|
return {
|
|
default: () => $t('system.menu.affixTab'),
|
|
};
|
|
},
|
|
},
|
|
{
|
|
component: 'Checkbox',
|
|
dependencies: {
|
|
show: (values) => {
|
|
return !['button'].includes(values.type);
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'meta.hideInMenu',
|
|
renderComponentContent() {
|
|
return {
|
|
default: () => $t('system.menu.hideInMenu'),
|
|
};
|
|
},
|
|
},
|
|
{
|
|
component: 'Checkbox',
|
|
dependencies: {
|
|
show: (values) => {
|
|
return ['catalog', 'menu'].includes(values.type);
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'meta.hideChildrenInMenu',
|
|
renderComponentContent() {
|
|
return {
|
|
default: () => $t('system.menu.hideChildrenInMenu'),
|
|
};
|
|
},
|
|
},
|
|
{
|
|
component: 'Checkbox',
|
|
dependencies: {
|
|
show: (values) => {
|
|
return !['button', 'link'].includes(values.type);
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'meta.hideInBreadcrumb',
|
|
renderComponentContent() {
|
|
return {
|
|
default: () => $t('system.menu.hideInBreadcrumb'),
|
|
};
|
|
},
|
|
},
|
|
{
|
|
component: 'Checkbox',
|
|
dependencies: {
|
|
show: (values) => {
|
|
return !['button', 'link'].includes(values.type);
|
|
},
|
|
triggerFields: ['type'],
|
|
},
|
|
fieldName: 'meta.hideInTab',
|
|
renderComponentContent() {
|
|
return {
|
|
default: () => $t('system.menu.hideInTab'),
|
|
};
|
|
},
|
|
},
|
|
];
|
|
|
|
const breakpoints = useBreakpoints(breakpointsTailwind);
|
|
const isHorizontal = computed(() => breakpoints.greaterOrEqual('md').value);
|
|
|
|
const [Form, formApi] = useVbenForm({
|
|
codec: {
|
|
decode: decodeMenuFormValues,
|
|
encode: encodeMenuFormValues,
|
|
},
|
|
commonConfig: {
|
|
colon: true,
|
|
formItemClass: 'col-span-2 md:col-span-1',
|
|
},
|
|
schema,
|
|
showDefaultActions: false,
|
|
wrapperClass: 'grid-cols-2 gap-x-4',
|
|
});
|
|
const [Drawer, drawerApi] = useVbenDrawer({
|
|
onConfirm: onSubmit,
|
|
async onOpenChange(isOpen) {
|
|
if (isOpen) {
|
|
const data = drawerApi.getData<SystemMenuApi.SystemMenu>();
|
|
if (data) {
|
|
formData.value = data;
|
|
await formApi.setSubmitValues(data);
|
|
titleSuffix.value = formData.value.meta?.title
|
|
? $t(formData.value.meta.title)
|
|
: '';
|
|
} else {
|
|
formApi.reset();
|
|
titleSuffix.value = '';
|
|
}
|
|
}
|
|
},
|
|
});
|
|
|
|
async function onSubmit() {
|
|
const { valid } = await formApi.validate();
|
|
if (valid) {
|
|
drawerApi.lock();
|
|
const data = await formApi.getValues();
|
|
try {
|
|
await (formData.value?.id
|
|
? updateMenu(formData.value.id, data)
|
|
: createMenu(data));
|
|
drawerApi.close();
|
|
emit('success');
|
|
} finally {
|
|
drawerApi.unlock();
|
|
}
|
|
}
|
|
}
|
|
const getDrawerTitle = computed(() =>
|
|
formData.value?.id
|
|
? $t('ui.actionTitle.edit', [$t('system.menu.name')])
|
|
: $t('ui.actionTitle.create', [$t('system.menu.name')]),
|
|
);
|
|
</script>
|
|
<template>
|
|
<Drawer class="w-full max-w-200" :title="getDrawerTitle">
|
|
<Form class="mx-4" :layout="isHorizontal ? 'horizontal' : 'vertical'" />
|
|
</Drawer>
|
|
</template>
|