311 lines
9.2 KiB
TypeScript
311 lines
9.2 KiB
TypeScript
import type { VxeTableGridOptions } from '@vben/plugins/vxe-table';
|
||
import type { Recordable } from '@vben/types';
|
||
|
||
import { h } from 'vue';
|
||
|
||
import { IconifyIcon } from '@vben/icons';
|
||
import { $te } from '@vben/locales';
|
||
import { setupVbenVxeTable, useVbenVxeGrid } from '@vben/plugins/vxe-table';
|
||
import { isFunction, isString } from '@vben/utils';
|
||
|
||
import { NButton, NImage, NPopconfirm, NSwitch } from 'naive-ui';
|
||
|
||
import { DictTag } from '#/components/dict-tag';
|
||
import { $t } from '#/locales';
|
||
|
||
import { useVbenForm } from './form';
|
||
|
||
setupVbenVxeTable({
|
||
configVxeTable: (vxeUI) => {
|
||
vxeUI.setConfig({
|
||
grid: {
|
||
align: 'center',
|
||
border: false,
|
||
columnConfig: {
|
||
resizable: true,
|
||
},
|
||
minHeight: 180,
|
||
formConfig: {
|
||
// 全局禁用vxe-table的表单配置，使用formOptions
|
||
enabled: false,
|
||
},
|
||
toolbarConfig: {
|
||
import: false, // 是否导入
|
||
export: false, // 是否导出
|
||
refresh: true, // 是否刷新
|
||
print: false, // 是否打印
|
||
zoom: true, // 是否缩放
|
||
custom: true, // 是否自定义配置
|
||
},
|
||
customConfig: {
|
||
mode: 'modal',
|
||
},
|
||
proxyConfig: {
|
||
autoLoad: true,
|
||
response: {
|
||
result: 'list',
|
||
total: 'total',
|
||
},
|
||
showActiveMsg: true,
|
||
showResponseMsg: false,
|
||
},
|
||
pagerConfig: {
|
||
enabled: true,
|
||
},
|
||
sortConfig: {
|
||
multiple: true,
|
||
},
|
||
round: true,
|
||
showOverflow: true,
|
||
size: 'small',
|
||
} as VxeTableGridOptions,
|
||
});
|
||
|
||
// 表格配置项可以用 cellRender: { name: 'CellImage' },
|
||
vxeUI.renderer.add('CellImage', {
|
||
renderTableDefault(_renderOpts, params) {
|
||
const { column, row } = params;
|
||
return h(NImage, { src: row[column.field] });
|
||
},
|
||
});
|
||
|
||
// 表格配置项可以用 cellRender: { name: 'CellLink' },
|
||
vxeUI.renderer.add('CellLink', {
|
||
renderTableDefault(renderOpts) {
|
||
const { props } = renderOpts;
|
||
return h(
|
||
NButton,
|
||
{ size: 'small', type: 'primary', quaternary: true },
|
||
{ default: () => props?.text },
|
||
);
|
||
},
|
||
});
|
||
|
||
// 表格配置项可以用 cellRender: { name: 'CellDict', props:{dictType: ''} },
|
||
vxeUI.renderer.add('CellDict', {
|
||
renderTableDefault(renderOpts, params) {
|
||
const { props } = renderOpts;
|
||
const { column, row } = params;
|
||
if (!props) {
|
||
return '';
|
||
}
|
||
// 使用 DictTag 组件替代原来的实现
|
||
return h(DictTag, {
|
||
type: props.type,
|
||
value: row[column.field]?.toString(),
|
||
});
|
||
},
|
||
});
|
||
|
||
// 表格配置项可以用 cellRender: { name: 'CellSwitch', props: { beforeChange: () => {} } },
|
||
// add by 芋艿：from https://github.com/vbenjs/vue-vben-admin/blob/main/playground/src/adapter/vxe-table.ts#L97-L123
|
||
vxeUI.renderer.add('CellSwitch', {
|
||
renderTableDefault({ attrs, props }, { column, row }) {
|
||
const loadingKey = `__loading_${column.field}`;
|
||
const finallyProps = {
|
||
checkedChildren: $t('common.enabled'),
|
||
checkedValue: 1,
|
||
unCheckedChildren: $t('common.disabled'),
|
||
unCheckedValue: 0,
|
||
...props,
|
||
checked: row[column.field],
|
||
loading: row[loadingKey] ?? false,
|
||
'onUpdate:checked': onChange,
|
||
};
|
||
async function onChange(newVal: any) {
|
||
row[loadingKey] = true;
|
||
try {
|
||
const result = await attrs?.beforeChange?.(newVal, row);
|
||
if (result !== false) {
|
||
row[column.field] = newVal;
|
||
}
|
||
} finally {
|
||
row[loadingKey] = false;
|
||
}
|
||
}
|
||
return h(NSwitch, finallyProps);
|
||
},
|
||
});
|
||
|
||
// 注册表格的操作按钮渲染器 cellRender: { name: 'CellOperation', options: ['edit', 'delete'] }
|
||
// add by 芋艿：from https://github.com/vbenjs/vue-vben-admin/blob/main/playground/src/adapter/vxe-table.ts#L125-L255
|
||
vxeUI.renderer.add('CellOperation', {
|
||
renderTableDefault({ attrs, options, props }, { column, row }) {
|
||
const defaultProps = {
|
||
text: true,
|
||
type: 'primary',
|
||
...props,
|
||
};
|
||
let align = 'end';
|
||
switch (column.align) {
|
||
case 'center': {
|
||
align = 'center';
|
||
break;
|
||
}
|
||
case 'left': {
|
||
align = 'start';
|
||
break;
|
||
}
|
||
default: {
|
||
align = 'end';
|
||
break;
|
||
}
|
||
}
|
||
const presets: Recordable<Recordable<any>> = {
|
||
delete: {
|
||
type: 'error',
|
||
concent: $t('common.delete'),
|
||
},
|
||
edit: {
|
||
concent: $t('common.edit'),
|
||
},
|
||
};
|
||
const operations: Array<Recordable<any>> = (
|
||
options || ['edit', 'delete']
|
||
)
|
||
.map((opt) => {
|
||
if (isString(opt)) {
|
||
return presets[opt]
|
||
? { code: opt, ...presets[opt], ...defaultProps }
|
||
: {
|
||
code: opt,
|
||
concent: $te(`common.${opt}`) ? $t(`common.${opt}`) : opt,
|
||
...defaultProps,
|
||
};
|
||
} else {
|
||
return { ...defaultProps, ...presets[opt.code], ...opt };
|
||
}
|
||
})
|
||
.map((opt) => {
|
||
const optBtn: Recordable<any> = {};
|
||
Object.keys(opt).forEach((key) => {
|
||
optBtn[key] = isFunction(opt[key]) ? opt[key](row) : opt[key];
|
||
});
|
||
return optBtn;
|
||
})
|
||
.filter((opt) => opt.show !== false);
|
||
|
||
function renderBtn(opt: Recordable<any>, listen = true) {
|
||
return h(
|
||
NButton,
|
||
{
|
||
...props,
|
||
...opt,
|
||
icon: undefined,
|
||
onClick: listen
|
||
? () =>
|
||
attrs?.onClick?.({
|
||
code: opt.code,
|
||
row,
|
||
})
|
||
: undefined,
|
||
},
|
||
{
|
||
default: () => {
|
||
const content = [];
|
||
if (opt.icon) {
|
||
content.push(
|
||
h(IconifyIcon, { class: 'size-5', icon: opt.icon }),
|
||
);
|
||
}
|
||
content.push(opt.concent);
|
||
return content;
|
||
},
|
||
},
|
||
);
|
||
}
|
||
|
||
function renderConfirm(opt: Recordable<any>) {
|
||
return h(
|
||
NPopconfirm,
|
||
{
|
||
...props,
|
||
...opt,
|
||
icon: undefined,
|
||
onPositiveClick: () => {
|
||
attrs?.onClick?.({
|
||
code: opt.code,
|
||
row,
|
||
});
|
||
},
|
||
},
|
||
{
|
||
trigger: () => {
|
||
return h(
|
||
NButton,
|
||
{
|
||
...props,
|
||
...opt,
|
||
icon: undefined,
|
||
},
|
||
{
|
||
default: () => {
|
||
const content = [];
|
||
if (opt.icon) {
|
||
content.push(
|
||
h(IconifyIcon, { class: 'size-5', icon: opt.icon }),
|
||
);
|
||
}
|
||
content.push(opt.concent);
|
||
return content;
|
||
},
|
||
},
|
||
);
|
||
},
|
||
default: () => {
|
||
return $t('ui.actionMessage.deleteConfirm', [
|
||
row[attrs?.nameField || 'name'],
|
||
]);
|
||
},
|
||
},
|
||
);
|
||
}
|
||
|
||
const btns = operations.map((opt) =>
|
||
opt.code === 'delete' ? renderConfirm(opt) : renderBtn(opt),
|
||
);
|
||
return h(
|
||
'div',
|
||
{
|
||
class: 'flex table-operations ml-2',
|
||
style: { justifyContent: align },
|
||
},
|
||
btns,
|
||
);
|
||
},
|
||
});
|
||
|
||
// 这里可以自行扩展 vxe-table 的全局配置，比如自定义格式化
|
||
// vxeUI.formats.add
|
||
// add by 星语：数量格式化，例如说：金额
|
||
// TODO @xingyu：建议金额，和数量分开哈；原因是，有些团队希望金额，单独控制；
|
||
vxeUI.formats.add('formatNumber', {
|
||
cellFormatMethod({ cellValue }, digits = 2) {
|
||
if (cellValue === null || cellValue === undefined) {
|
||
return '';
|
||
}
|
||
if (isString(cellValue)) {
|
||
cellValue = Number.parseFloat(cellValue);
|
||
}
|
||
// 如果非 number，则直接返回空串
|
||
if (Number.isNaN(cellValue)) {
|
||
return '';
|
||
}
|
||
return cellValue.toFixed(digits);
|
||
},
|
||
});
|
||
},
|
||
useVbenForm,
|
||
});
|
||
|
||
export { useVbenVxeGrid };
|
||
// add by 芋艿：from https://github.com/vbenjs/vue-vben-admin/blob/main/playground/src/adapter/vxe-table.ts#L264-L270
|
||
export type OnActionClickParams<T = Recordable<any>> = {
|
||
code: string;
|
||
row: T;
|
||
};
|
||
export type OnActionClickFn<T = Recordable<any>> = (
|
||
params: OnActionClickParams<T>,
|
||
) => void;
|
||
export type * from '@vben/plugins/vxe-table';
|