feat: 新增 ele 公告管理模块

apps/web-ele/src/views/system/notice/data.ts

@@ -0,0 +1,163 @@
+import type { VbenFormSchema } from '#/adapter/form';
+import type { OnActionClickFn, VxeTableGridOptions } from '#/adapter/vxe-table';
+import type { SystemNoticeApi } from '#/api/system/notice';
+
+import { useAccess } from '@vben/access';
+
+import { z } from '#/adapter/form';
+import { CommonStatusEnum, DICT_TYPE, getDictOptions } from '#/utils';
+
+const { hasAccessByCodes } = useAccess();
+
+/** 新增/修改的表单 */
+export function useFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      fieldName: 'id',
+      component: 'Input',
+      dependencies: {
+        triggerFields: [''],
+        show: () => false,
+      },
+    },
+    {
+      fieldName: 'title',
+      label: '公告标题',
+      component: 'Input',
+      rules: 'required',
+    },
+    {
+      fieldName: 'type',
+      label: '公告类型',
+      component: 'RadioGroup',
+      componentProps: {
+        options: getDictOptions(DICT_TYPE.SYSTEM_NOTICE_TYPE, 'number'),
+        buttonStyle: 'solid',
+        optionType: 'button',
+      },
+      rules: 'required',
+    },
+    {
+      fieldName: 'content',
+      label: '公告内容',
+      component: 'RichTextarea',
+      rules: 'required',
+    },
+    {
+      fieldName: 'status',
+      label: '公告状态',
+      component: 'RadioGroup',
+      componentProps: {
+        options: getDictOptions(DICT_TYPE.COMMON_STATUS, 'number'),
+        buttonStyle: 'solid',
+        optionType: 'button',
+      },
+      rules: z.number().default(CommonStatusEnum.ENABLE),
+    },
+    {
+      fieldName: 'remark',
+      label: '备注',
+      component: 'Textarea',
+      componentProps: {
+        placeholder: '请输入备注',
+      },
+    },
+  ];
+}
+
+/** 列表的搜索表单 */
+export function useGridFormSchema(): VbenFormSchema[] {
+  return [
+    {
+      fieldName: 'title',
+      label: '公告标题',
+      component: 'Input',
+      componentProps: {
+        placeholder: '请输入公告标题',
+        allowClear: true,
+      },
+    },
+    {
+      fieldName: 'status',
+      label: '公告状态',
+      component: 'Select',
+      componentProps: {
+        options: getDictOptions(DICT_TYPE.COMMON_STATUS, 'number'),
+        placeholder: '请选择公告状态',
+        allowClear: true,
+      },
+    },
+  ];
+}
+
+/** 列表的字段 */
+export function useGridColumns<T = SystemNoticeApi.Notice>(
+  onActionClick: OnActionClickFn<T>,
+): VxeTableGridOptions['columns'] {
+  return [
+    {
+      field: 'id',
+      title: '公告编号',
+      minWidth: 100,
+    },
+    {
+      field: 'title',
+      title: '公告标题',
+      minWidth: 200,
+    },
+    {
+      field: 'type',
+      title: '公告类型',
+      minWidth: 100,
+      cellRender: {
+        name: 'CellDict',
+        props: { type: DICT_TYPE.SYSTEM_NOTICE_TYPE },
+      },
+    },
+    {
+      field: 'status',
+      title: '公告状态',
+      minWidth: 100,
+      cellRender: {
+        name: 'CellDict',
+        props: { type: DICT_TYPE.COMMON_STATUS },
+      },
+    },
+    {
+      field: 'createTime',
+      title: '创建时间',
+      minWidth: 180,
+      formatter: 'formatDateTime',
+    },
+    {
+      field: 'operation',
+      title: '操作',
+      minWidth: 180,
+      align: 'center',
+      fixed: 'right',
+      cellRender: {
+        attrs: {
+          nameField: 'title',
+          nameTitle: '公告',
+          onClick: onActionClick,
+        },
+        name: 'CellOperation',
+        options: [
+          {
+            code: 'edit',
+            show: hasAccessByCodes(['system:notice:update']),
+          },
+          {
+            code: 'push',
+            text: '推送',
+            show: hasAccessByCodes(['system:notice:update']),
+          },
+          {
+            code: 'delete',
+            show: hasAccessByCodes(['system:notice:delete']),
+          },
+        ],
+      },
+    },
+  ];
+}

apps/web-ele/src/views/system/notice/index.vue

@@ -0,0 +1,140 @@
+<script lang="ts" setup>
+import type {
+  OnActionClickParams,
+  VxeTableGridOptions,
+} from '#/adapter/vxe-table';
+import type { SystemNoticeApi } from '#/api/system/notice';
+
+import { Page, useVbenModal } from '@vben/common-ui';
+import { Plus } from '@vben/icons';
+
+import { ElButton, ElMessage } from 'element-plus';
+
+import { useVbenVxeGrid } from '#/adapter/vxe-table';
+import { deleteNotice, getNoticePage, pushNotice } from '#/api/system/notice';
+import { $t } from '#/locales';
+
+import { useGridColumns, useGridFormSchema } from './data';
+import Form from './modules/form.vue';
+
+const [FormModal, formModalApi] = useVbenModal({
+  connectedComponent: Form,
+  destroyOnClose: true,
+});
+
+/** 刷新表格 */
+function onRefresh() {
+  gridApi.query();
+}
+
+/** 创建公告 */
+function onCreate() {
+  formModalApi.setData(null).open();
+}
+
+/** 编辑公告 */
+function onEdit(row: SystemNoticeApi.Notice) {
+  formModalApi.setData(row).open();
+}
+
+/** 删除公告 */
+async function onDelete(row: SystemNoticeApi.Notice) {
+  const loadingInstance = ElMessage({
+    message: $t('ui.actionMessage.deleting', [row.title]),
+    type: 'info',
+    duration: 0,
+  });
+  try {
+    await deleteNotice(row.id as number);
+    loadingInstance.close();
+    ElMessage.success($t('ui.actionMessage.deleteSuccess', [row.title]));
+    onRefresh();
+  } catch {
+    loadingInstance.close();
+  }
+}
+
+/** 推送公告 */
+async function onPush(row: SystemNoticeApi.Notice) {
+  const loadingInstance = ElMessage({
+    message: $t('ui.actionMessage.processing', ['推送']),
+    type: 'info',
+    duration: 0,
+  });
+  try {
+    await pushNotice(row.id as number);
+    loadingInstance.close();
+    ElMessage.success($t('ui.actionMessage.operationSuccess'));
+  } catch {
+    loadingInstance.close();
+  }
+}
+
+/** 表格操作按钮的回调函数 */
+function onActionClick({
+  code,
+  row,
+}: OnActionClickParams<SystemNoticeApi.Notice>) {
+  switch (code) {
+    case 'delete': {
+      onDelete(row);
+      break;
+    }
+    case 'edit': {
+      onEdit(row);
+      break;
+    }
+    case 'push': {
+      onPush(row);
+      break;
+    }
+  }
+}
+
+const [Grid, gridApi] = useVbenVxeGrid({
+  formOptions: {
+    schema: useGridFormSchema(),
+  },
+  gridOptions: {
+    columns: useGridColumns(onActionClick),
+    height: 'auto',
+    keepSource: true,
+    proxyConfig: {
+      ajax: {
+        query: async ({ page }, formValues) => {
+          return await getNoticePage({
+            pageNo: page.currentPage,
+            pageSize: page.pageSize,
+            ...formValues,
+          });
+        },
+      },
+    },
+    rowConfig: {
+      keyField: 'id',
+    },
+    toolbarConfig: {
+      refresh: { code: 'query' },
+      search: true,
+    },
+  } as VxeTableGridOptions<SystemNoticeApi.Notice>,
+});
+</script>
+
+<template>
+  <Page auto-content-height>
+    <FormModal @success="onRefresh" />
+    <Grid table-title="公告列表">
+      <template #toolbar-tools>
+        <ElButton
+          type="primary"
+          @click="onCreate"
+          v-access:code="['system:notice:create']"
+        >
+          <Plus class="size-5" />
+          {{ $t('ui.actionTitle.create', ['公告']) }}
+        </ElButton>
+      </template>
+    </Grid>
+  </Page>
+</template>

apps/web-ele/src/views/system/notice/modules/form.vue

@@ -0,0 +1,84 @@
+<script lang="ts" setup>
+import type { SystemNoticeApi } from '#/api/system/notice';
+
+import { computed, ref } from 'vue';
+
+import { useVbenModal } from '@vben/common-ui';
+
+import { ElMessage } from 'element-plus';
+
+import { useVbenForm } from '#/adapter/form';
+import { createNotice, getNotice, updateNotice } from '#/api/system/notice';
+import { $t } from '#/locales';
+
+import { useFormSchema } from '../data';
+
+const emit = defineEmits(['success']);
+const formData = ref<SystemNoticeApi.Notice>();
+const getTitle = computed(() => {
+  return formData.value?.id
+    ? $t('ui.actionTitle.edit', ['公告'])
+    : $t('ui.actionTitle.create', ['公告']);
+});
+
+const [Form, formApi] = useVbenForm({
+  commonConfig: {
+    componentProps: {
+      class: 'w-full',
+    },
+    formItemClass: 'col-span-2',
+    labelWidth: 80,
+  },
+  layout: 'horizontal',
+  schema: useFormSchema(),
+  showDefaultActions: false,
+});
+
+const [Modal, modalApi] = useVbenModal({
+  async onConfirm() {
+    const { valid } = await formApi.validate();
+    if (!valid) {
+      return;
+    }
+    modalApi.lock();
+    // 提交表单
+    const data = (await formApi.getValues()) as SystemNoticeApi.Notice;
+    try {
+      await (formData.value?.id ? updateNotice(data) : createNotice(data));
+      // 关闭并提示
+      await modalApi.close();
+      emit('success');
+      ElMessage.success($t('ui.actionMessage.operationSuccess'));
+    } finally {
+      modalApi.unlock();
+    }
+  },
+  async onOpenChange(isOpen: boolean) {
+    if (!isOpen) {
+      formData.value = undefined;
+      return;
+    }
+    // 加载数据
+    const data = modalApi.getData<SystemNoticeApi.Notice>();
+    if (!data || !data.id) {
+      return;
+    }
+    modalApi.lock();
+    try {
+      formData.value = await getNotice(data.id as number);
+      // 设置到 values
+      if (formData.value) {
+        await formApi.setValues(formData.value);
+      }
+    } finally {
+      modalApi.unlock();
+    }
+  },
+});
+</script>
+
+<template>
+  <Modal :title="getTitle" class="w-1/2">
+    <Form class="mx-4" />
+  </Modal>
+</template>