From 2e5d924a4f437e0c5caa7ed3c683de01923a6497 Mon Sep 17 00:00:00 2001
From: YunaiV <zhijiantianya@gmail.com>
Date: Sat, 5 Apr 2025 17:09:16 +0800
Subject: [PATCH] =?UTF-8?q?feat=EF=BC=9A=E5=A2=9E=E5=8A=A0=20DocAlert=20?=
 =?UTF-8?q?=E6=96=87=E6=A1=A3=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 apps/web-antd/.env                            |  3 ++
 .../src/components/doc-alert/index.ts         |  3 ++
 .../src/components/doc-alert/src/DocAlert.vue | 42 +++++++++++++++++++
 .../src/views/system/mail/account/index.vue   |  3 ++
 .../src/views/system/mail/log/index.vue       |  3 ++
 .../src/views/system/mail/template/index.vue  |  3 ++
 apps/web-antd/src/views/system/menu/index.vue |  4 ++
 .../src/views/system/notify/message/index.vue |  3 ++
 .../src/views/system/notify/my/index.vue      |  3 ++
 .../views/system/notify/template/index.vue    |  3 ++
 apps/web-antd/src/views/system/role/index.vue |  6 ++-
 .../src/views/system/sms/channel/index.vue    |  3 ++
 .../src/views/system/sms/log/index.vue        |  3 ++
 .../src/views/system/sms/template/index.vue   |  3 ++
 .../src/views/system/tenant/index.vue         |  4 +-
 .../src/views/system/tenantPackage/index.vue  |  3 ++
 apps/web-antd/src/views/system/user/index.vue |  5 +++
 17 files changed, 94 insertions(+), 3 deletions(-)
 create mode 100644 apps/web-antd/src/components/doc-alert/index.ts
 create mode 100644 apps/web-antd/src/components/doc-alert/src/DocAlert.vue

diff --git a/apps/web-antd/.env b/apps/web-antd/.env
index 712ae9ab..0dead042 100644
--- a/apps/web-antd/.env
+++ b/apps/web-antd/.env
@@ -11,3 +11,6 @@ VITE_APP_TENANT_ENABLE=true
 
 # 验证码的开关
 VITE_APP_CAPTCHA_ENABLE=false
+
+# 文档地址的开关
+VITE_APP_DOCALERT_ENABLE=true
\ No newline at end of file
diff --git a/apps/web-antd/src/components/doc-alert/index.ts b/apps/web-antd/src/components/doc-alert/index.ts
new file mode 100644
index 00000000..51bdd399
--- /dev/null
+++ b/apps/web-antd/src/components/doc-alert/index.ts
@@ -0,0 +1,3 @@
+import DocAlert from './src/DocAlert.vue'
+
+export { DocAlert }
diff --git a/apps/web-antd/src/components/doc-alert/src/DocAlert.vue b/apps/web-antd/src/components/doc-alert/src/DocAlert.vue
new file mode 100644
index 00000000..f0b3ef24
--- /dev/null
+++ b/apps/web-antd/src/components/doc-alert/src/DocAlert.vue
@@ -0,0 +1,42 @@
+<script lang="ts" setup>
+import { computed } from 'vue';
+import { Alert, Typography } from 'ant-design-vue';
+
+export interface DocAlertProps {
+  /**
+   * 文档标题
+   */
+  title: string;
+  /**
+   * 文档 URL 地址
+   */
+  url: string;
+}
+
+const props = defineProps<DocAlertProps>();
+
+/** 跳转 URL 链接 */
+const goToUrl = () => {
+  window.open(props.url);
+};
+
+/** 是否开启 */
+const isEnabled = computed(() => {
+  return import.meta.env.VITE_APP_DOCALERT_ENABLE !== 'false';
+});
+</script>
+
+<template>
+  <Alert
+    v-if="isEnabled"
+    type="info"
+    show-icon
+    class="mb-2 rounded"
+  >
+    <template #message>
+      <Typography.Link @click="goToUrl">
+        【{{ title }}】文档地址：{{ url }}
+      </Typography.Link>
+    </template>
+  </Alert>
+</template>
diff --git a/apps/web-antd/src/views/system/mail/account/index.vue b/apps/web-antd/src/views/system/mail/account/index.vue
index bf42f010..32ce2027 100644
--- a/apps/web-antd/src/views/system/mail/account/index.vue
+++ b/apps/web-antd/src/views/system/mail/account/index.vue
@@ -6,6 +6,7 @@ import { Page, useVbenModal } from '@vben/common-ui';
 import { Plus } from '@vben/icons';
 import { Button, message } from 'ant-design-vue';
 import Form from './modules/form.vue';
+import { DocAlert } from '#/components/doc-alert';
 
 import { $t } from '#/locales';
 import { useVbenVxeGrid } from '#/adapter/vxe-table';
@@ -100,6 +101,8 @@ const [Grid, gridApi] = useVbenVxeGrid({
 </script>
 <template>
   <Page auto-content-height>
+    <DocAlert title="邮件配置" url="https://doc.iocoder.cn/mail" />
+
     <FormModal @success="onRefresh" />
     <Grid table-title="邮箱账号列表">
       <template #toolbar-tools>
diff --git a/apps/web-antd/src/views/system/mail/log/index.vue b/apps/web-antd/src/views/system/mail/log/index.vue
index 01882cb5..8db7caa2 100644
--- a/apps/web-antd/src/views/system/mail/log/index.vue
+++ b/apps/web-antd/src/views/system/mail/log/index.vue
@@ -4,6 +4,7 @@ import type { SystemMailLogApi } from '#/api/system/mail/log';
 
 import { Page, useVbenModal } from '@vben/common-ui';
 import Detail from './modules/detail.vue';
+import { DocAlert } from '#/components/doc-alert';
 
 import { useVbenVxeGrid } from '#/adapter/vxe-table';
 import { getMailLogPage } from '#/api/system/mail/log';
@@ -68,6 +69,8 @@ const [Grid, gridApi] = useVbenVxeGrid({
 });
 </script>
 <template>
+  <DocAlert title="邮件配置" url="https://doc.iocoder.cn/mail" />
+
   <Page auto-content-height>
     <DetailModal @success="onRefresh" />
     <Grid table-title="邮件日志列表">
diff --git a/apps/web-antd/src/views/system/mail/template/index.vue b/apps/web-antd/src/views/system/mail/template/index.vue
index 45f681fc..665feac4 100644
--- a/apps/web-antd/src/views/system/mail/template/index.vue
+++ b/apps/web-antd/src/views/system/mail/template/index.vue
@@ -7,6 +7,7 @@ import { Plus } from '@vben/icons';
 import { Button, message } from 'ant-design-vue';
 import Form from './modules/form.vue';
 import SendForm from './modules/send-form.vue';
+import { DocAlert } from '#/components/doc-alert';
 
 import { $t } from '#/locales';
 import { useVbenVxeGrid } from '#/adapter/vxe-table';
@@ -115,6 +116,8 @@ const [Grid, gridApi] = useVbenVxeGrid({
 </script>
 <template>
   <Page auto-content-height>
+    <DocAlert title="邮件配置" url="https://doc.iocoder.cn/mail" />
+
     <FormModal @success="onRefresh" />
     <SendModal />
     <Grid table-title="邮件模板列表">
diff --git a/apps/web-antd/src/views/system/menu/index.vue b/apps/web-antd/src/views/system/menu/index.vue
index b71cadc5..bbe63b4e 100644
--- a/apps/web-antd/src/views/system/menu/index.vue
+++ b/apps/web-antd/src/views/system/menu/index.vue
@@ -6,6 +6,7 @@ import { Page, useVbenModal } from '@vben/common-ui';
 import { Button, message } from 'ant-design-vue';
 import { IconifyIcon, Plus } from '@vben/icons';
 import Form from './modules/form.vue';
+import { DocAlert } from '#/components/doc-alert';
 
 import { ref } from 'vue';
 import { $t } from '#/locales';
@@ -120,6 +121,9 @@ const [Grid, gridApi] = useVbenVxeGrid({
 
 <template>
   <Page auto-content-height>
+    <DocAlert title="功能权限" url="https://doc.iocoder.cn/resource-permission" />
+    <DocAlert title="菜单路由" url="https://doc.iocoder.cn/vue3/route/" />
+
     <FormModal @success="onRefresh" />
     <Grid>
       <template #toolbar-tools>
diff --git a/apps/web-antd/src/views/system/notify/message/index.vue b/apps/web-antd/src/views/system/notify/message/index.vue
index 0bb60f89..ea60a191 100644
--- a/apps/web-antd/src/views/system/notify/message/index.vue
+++ b/apps/web-antd/src/views/system/notify/message/index.vue
@@ -3,6 +3,7 @@ import type { OnActionClickParams, VxeTableGridOptions } from '#/adapter/vxe-tab
 import type { SystemNotifyMessageApi } from '#/api/system/notify/message';
 
 import { Page, useVbenModal } from '@vben/common-ui';
+import { DocAlert } from '#/components/doc-alert';
 
 import { useVbenVxeGrid } from '#/adapter/vxe-table';
 import { getNotifyMessagePage } from '#/api/system/notify/message';
@@ -70,6 +71,8 @@ const [Grid, gridApi] = useVbenVxeGrid({
 
 <template>
   <Page auto-content-height>
+    <DocAlert title="短信配置" url="https://doc.iocoder.cn/sms/" />
+
     <DetailModal @success="onRefresh" />
     <Grid table-title="站内信列表" />
   </Page>
diff --git a/apps/web-antd/src/views/system/notify/my/index.vue b/apps/web-antd/src/views/system/notify/my/index.vue
index 5b9524a7..8b1f1c9e 100644
--- a/apps/web-antd/src/views/system/notify/my/index.vue
+++ b/apps/web-antd/src/views/system/notify/my/index.vue
@@ -10,6 +10,7 @@ import { Page, useVbenModal } from '@vben/common-ui';
 import { MdiCheckboxMarkedCircleOutline } from '@vben/icons';
 import { Button, message } from 'ant-design-vue';
 import Detail from './modules/detail.vue';
+import { DocAlert } from '#/components/doc-alert';
 
 import { useVbenVxeGrid } from '#/adapter/vxe-table';
 import {
@@ -147,6 +148,8 @@ const [Grid, gridApi] = useVbenVxeGrid({
 </script>
 <template>
   <Page auto-content-height>
+    <DocAlert title="短信配置" url="https://doc.iocoder.cn/sms/" />
+
     <DetailModal @success="onRefresh" />
     <Grid table-title="我的站内信">
       <template #toolbar-tools>
diff --git a/apps/web-antd/src/views/system/notify/template/index.vue b/apps/web-antd/src/views/system/notify/template/index.vue
index 15f06e80..03347cd4 100644
--- a/apps/web-antd/src/views/system/notify/template/index.vue
+++ b/apps/web-antd/src/views/system/notify/template/index.vue
@@ -7,6 +7,7 @@ import { Download, Plus } from '@vben/icons';
 import { Button, message } from 'ant-design-vue';
 import Form from './modules/form.vue';
 import SendForm from './modules/send-form.vue';
+import { DocAlert } from '#/components/doc-alert';
 
 import { $t } from '#/locales';
 import { useVbenVxeGrid } from '#/adapter/vxe-table';
@@ -123,6 +124,8 @@ const [Grid, gridApi] = useVbenVxeGrid({
 
 <template>
   <Page auto-content-height>
+    <DocAlert title="短信配置" url="https://doc.iocoder.cn/sms/" />
+
     <FormModal @success="onRefresh" />
     <SendModal />
     <Grid table-title="站内信模板列表">
diff --git a/apps/web-antd/src/views/system/role/index.vue b/apps/web-antd/src/views/system/role/index.vue
index 61a045d0..5776d63b 100644
--- a/apps/web-antd/src/views/system/role/index.vue
+++ b/apps/web-antd/src/views/system/role/index.vue
@@ -6,6 +6,7 @@ import { Page, useVbenModal } from '@vben/common-ui';
 import { Button, message } from 'ant-design-vue';
 import { Plus, Download } from '@vben/icons';
 import Form from './modules/form.vue';
+import { DocAlert } from '#/components/doc-alert';
 
 import { $t } from '#/locales';
 import { useVbenVxeGrid } from '#/adapter/vxe-table';
@@ -108,8 +109,6 @@ function onActionClick({
 
 const [Grid, gridApi] = useVbenVxeGrid({
   formOptions: {
-    // TODO @芋艿：时间范围的检索
-    fieldMappingTime: [['createTime', ['startTime', 'endTime']]],
     schema: useGridFormSchema(),
   },
   gridOptions: {
@@ -140,6 +139,9 @@ const [Grid, gridApi] = useVbenVxeGrid({
 
 <template>
   <Page auto-content-height>
+    <DocAlert title="功能权限" url="https://doc.iocoder.cn/resource-permission" />
+    <DocAlert title="数据权限" url="https://doc.iocoder.cn/data-permission" />
+
     <FormModal @success="onRefresh" />
     <AssignDataPermissionFormModel @success="onRefresh" />
     <AssignMenuFormModel @success="onRefresh" />
diff --git a/apps/web-antd/src/views/system/sms/channel/index.vue b/apps/web-antd/src/views/system/sms/channel/index.vue
index d07c0a11..c18ccf5a 100644
--- a/apps/web-antd/src/views/system/sms/channel/index.vue
+++ b/apps/web-antd/src/views/system/sms/channel/index.vue
@@ -6,6 +6,7 @@ import { Page, useVbenModal } from '@vben/common-ui';
 import { Button, message } from 'ant-design-vue';
 import { Download, Plus } from '@vben/icons';
 import Form from './modules/form.vue';
+import { DocAlert } from '#/components/doc-alert';
 
 import { $t } from '#/locales';
 import { useVbenVxeGrid } from '#/adapter/vxe-table';
@@ -108,6 +109,8 @@ const [Grid, gridApi] = useVbenVxeGrid({
 
 <template>
   <Page auto-content-height>
+    <DocAlert title="短信配置" url="https://doc.iocoder.cn/sms/" />
+
     <FormModal @success="onRefresh" />
     <Grid table-title="短信渠道列表">
       <template #toolbar-tools>
diff --git a/apps/web-antd/src/views/system/sms/log/index.vue b/apps/web-antd/src/views/system/sms/log/index.vue
index d9d508d4..3380fe56 100644
--- a/apps/web-antd/src/views/system/sms/log/index.vue
+++ b/apps/web-antd/src/views/system/sms/log/index.vue
@@ -5,6 +5,7 @@ import type { SystemSmsLogApi } from '#/api/system/sms/log';
 import { Page, useVbenModal } from '@vben/common-ui';
 import { Download } from '@vben/icons';
 import { Button } from 'ant-design-vue';
+import { DocAlert } from '#/components/doc-alert';
 
 import { useVbenVxeGrid } from '#/adapter/vxe-table';
 import { exportSmsLog, getSmsLogPage } from '#/api/system/sms/log';
@@ -80,6 +81,8 @@ const [Grid, gridApi] = useVbenVxeGrid({
 
 <template>
   <Page auto-content-height>
+    <DocAlert title="短信配置" url="https://doc.iocoder.cn/sms/" />
+
     <DetailModal @success="onRefresh" />
     <Grid table-title="短信日志列表">
       <template #toolbar-tools>
diff --git a/apps/web-antd/src/views/system/sms/template/index.vue b/apps/web-antd/src/views/system/sms/template/index.vue
index daf57e11..c27c104f 100644
--- a/apps/web-antd/src/views/system/sms/template/index.vue
+++ b/apps/web-antd/src/views/system/sms/template/index.vue
@@ -7,6 +7,7 @@ import { Download, Plus } from '@vben/icons';
 import { Button, message } from 'ant-design-vue';
 import Form from './modules/form.vue';
 import SendForm from './modules/send-form.vue';
+import { DocAlert } from '#/components/doc-alert';
 
 import { $t } from '#/locales';
 import { useVbenVxeGrid } from '#/adapter/vxe-table';
@@ -123,6 +124,8 @@ const [Grid, gridApi] = useVbenVxeGrid({
 
 <template>
   <Page auto-content-height>
+    <DocAlert title="短信配置" url="https://doc.iocoder.cn/sms/" />
+
     <FormModal @success="onRefresh" />
     <SendModal />
     <Grid table-title="短信模板列表">
diff --git a/apps/web-antd/src/views/system/tenant/index.vue b/apps/web-antd/src/views/system/tenant/index.vue
index 7fcbbe8d..913fb5ff 100644
--- a/apps/web-antd/src/views/system/tenant/index.vue
+++ b/apps/web-antd/src/views/system/tenant/index.vue
@@ -6,6 +6,7 @@ import { Page, useVbenModal } from '@vben/common-ui';
 import { Button, message } from 'ant-design-vue';
 import { Plus, Download } from '@vben/icons';
 import Form from './modules/form.vue';
+import { DocAlert } from '#/components/doc-alert';
 
 import { $t } from '#/locales';
 import { useVbenVxeGrid } from '#/adapter/vxe-table';
@@ -79,7 +80,6 @@ function onActionClick({
 const [Grid, gridApi] = useVbenVxeGrid({
   formOptions: {
     schema: useGridFormSchema(),
-    // TODO @芋艿：时间筛选，后续处理；
   },
   gridOptions: {
     columns: useGridColumns(onActionClick),
@@ -108,6 +108,8 @@ const [Grid, gridApi] = useVbenVxeGrid({
 </script>
 <template>
   <Page auto-content-height>
+    <DocAlert title="SaaS 多租户" url="https://doc.iocoder.cn/saas-tenant/" />
+
     <FormModal @success="onRefresh" />
     <Grid table-title="租户列表">
       <template #toolbar-tools>
diff --git a/apps/web-antd/src/views/system/tenantPackage/index.vue b/apps/web-antd/src/views/system/tenantPackage/index.vue
index 5c1261fc..06aca220 100644
--- a/apps/web-antd/src/views/system/tenantPackage/index.vue
+++ b/apps/web-antd/src/views/system/tenantPackage/index.vue
@@ -5,6 +5,7 @@ import type { SystemTenantPackageApi } from '#/api/system/tenant-package';
 import { Page, useVbenModal } from '@vben/common-ui';
 import { Button, message } from 'ant-design-vue';
 import Form from './modules/form.vue';
+import { DocAlert } from '#/components/doc-alert';
 
 import { $t } from '#/locales';
 import { useVbenVxeGrid } from '#/adapter/vxe-table';
@@ -98,6 +99,8 @@ const [Grid, gridApi] = useVbenVxeGrid({
 
 <template>
   <Page auto-content-height>
+    <DocAlert title="SaaS 多租户" url="https://doc.iocoder.cn/saas-tenant/" />
+
     <FormModal @success="onRefresh" />
     <Grid table-title="租户套餐列表">
       <template #toolbar-tools>
diff --git a/apps/web-antd/src/views/system/user/index.vue b/apps/web-antd/src/views/system/user/index.vue
index f4818e4b..404dc242 100644
--- a/apps/web-antd/src/views/system/user/index.vue
+++ b/apps/web-antd/src/views/system/user/index.vue
@@ -11,6 +11,7 @@ import ResetPasswordForm from './modules/reset-password-form.vue';
 import AssignRoleForm from './modules/assign-role-form.vue';
 import ImportForm from './modules/import-form.vue';
 import DeptTree from './modules/dept-tree.vue';
+import { DocAlert } from '#/components/doc-alert';
 
 import { $t } from '#/locales';
 import { ref } from 'vue';
@@ -188,6 +189,10 @@ const [Grid, gridApi] = useVbenVxeGrid({
 
 <template>
   <Page auto-content-height>
+    <DocAlert title="用户体系" url="https://doc.iocoder.cn/user-center/" />
+    <DocAlert title="三方登陆" url="https://doc.iocoder.cn/social-user/" />
+    <DocAlert title="Excel 导入导出" url="https://doc.iocoder.cn/excel-import-and-export/" />
+
     <FormModal @success="onRefresh" />
     <ResetPasswordModal @success="onRefresh" />
     <AssignRoleModal @success="onRefresh" />