release: update 5.1.0

types/global-components.d.ts

@@ -3,10 +3,10 @@ declare module "vue" {
    * 自定义全局组件获得 Volar 提示（自定义的全局组件需要在这里声明下才能获得 Volar 类型提示哦）
    */
   export interface GlobalComponents {
-    IconifyIconOffline: typeof import("../src/components/ReIcon")["IconifyIconOffline"];
-    IconifyIconOnline: typeof import("../src/components/ReIcon")["IconifyIconOnline"];
-    FontIcon: typeof import("../src/components/ReIcon")["FontIcon"];
-    Auth: typeof import("../src/components/ReAuth")["Auth"];
+    IconifyIconOffline: (typeof import("../src/components/ReIcon"))["IconifyIconOffline"];
+    IconifyIconOnline: (typeof import("../src/components/ReIcon"))["IconifyIconOnline"];
+    FontIcon: (typeof import("../src/components/ReIcon"))["FontIcon"];
+    Auth: (typeof import("../src/components/ReAuth"))["Auth"];
   }
 }
 
@@ -16,108 +16,114 @@ declare module "vue" {
  */
 declare module "vue" {
   export interface GlobalComponents {
-    ElAffix: typeof import("element-plus")["ElAffix"];
-    ElAlert: typeof import("element-plus")["ElAlert"];
-    ElAside: typeof import("element-plus")["ElAside"];
-    ElAutocomplete: typeof import("element-plus")["ElAutocomplete"];
-    ElAvatar: typeof import("element-plus")["ElAvatar"];
-    ElBacktop: typeof import("element-plus")["ElBacktop"];
-    ElBadge: typeof import("element-plus")["ElBadge"];
-    ElBreadcrumb: typeof import("element-plus")["ElBreadcrumb"];
-    ElBreadcrumbItem: typeof import("element-plus")["ElBreadcrumbItem"];
-    ElButton: typeof import("element-plus")["ElButton"];
-    ElButtonGroup: typeof import("element-plus")["ElButtonGroup"];
-    ElCalendar: typeof import("element-plus")["ElCalendar"];
-    ElCard: typeof import("element-plus")["ElCard"];
-    ElCarousel: typeof import("element-plus")["ElCarousel"];
-    ElCarouselItem: typeof import("element-plus")["ElCarouselItem"];
-    ElCascader: typeof import("element-plus")["ElCascader"];
-    ElCascaderPanel: typeof import("element-plus")["ElCascaderPanel"];
-    ElCheckbox: typeof import("element-plus")["ElCheckbox"];
-    ElCheckboxButton: typeof import("element-plus")["ElCheckboxButton"];
-    ElCheckboxGroup: typeof import("element-plus")["ElCheckboxGroup"];
-    ElCol: typeof import("element-plus")["ElCol"];
-    ElCollapse: typeof import("element-plus")["ElCollapse"];
-    ElCollapseItem: typeof import("element-plus")["ElCollapseItem"];
-    ElCollapseTransition: typeof import("element-plus")["ElCollapseTransition"];
-    ElColorPicker: typeof import("element-plus")["ElColorPicker"];
-    ElContainer: typeof import("element-plus")["ElContainer"];
-    ElConfigProvider: typeof import("element-plus")["ElConfigProvider"];
-    ElDatePicker: typeof import("element-plus")["ElDatePicker"];
-    ElDialog: typeof import("element-plus")["ElDialog"];
-    ElDivider: typeof import("element-plus")["ElDivider"];
-    ElDrawer: typeof import("element-plus")["ElDrawer"];
-    ElDropdown: typeof import("element-plus")["ElDropdown"];
-    ElDropdownItem: typeof import("element-plus")["ElDropdownItem"];
-    ElDropdownMenu: typeof import("element-plus")["ElDropdownMenu"];
-    ElEmpty: typeof import("element-plus")["ElEmpty"];
-    ElFooter: typeof import("element-plus")["ElFooter"];
-    ElForm: typeof import("element-plus")["ElForm"];
-    ElFormItem: typeof import("element-plus")["ElFormItem"];
-    ElHeader: typeof import("element-plus")["ElHeader"];
-    ElIcon: typeof import("element-plus")["ElIcon"];
-    ElImage: typeof import("element-plus")["ElImage"];
-    ElImageViewer: typeof import("element-plus")["ElImageViewer"];
-    ElInput: typeof import("element-plus")["ElInput"];
-    ElInputNumber: typeof import("element-plus")["ElInputNumber"];
-    ElLink: typeof import("element-plus")["ElLink"];
-    ElMain: typeof import("element-plus")["ElMain"];
-    ElMenu: typeof import("element-plus")["ElMenu"];
-    ElMenuItem: typeof import("element-plus")["ElMenuItem"];
-    ElMenuItemGroup: typeof import("element-plus")["ElMenuItemGroup"];
-    ElOption: typeof import("element-plus")["ElOption"];
-    ElOptionGroup: typeof import("element-plus")["ElOptionGroup"];
-    ElPageHeader: typeof import("element-plus")["ElPageHeader"];
-    ElPagination: typeof import("element-plus")["ElPagination"];
-    ElPopconfirm: typeof import("element-plus")["ElPopconfirm"];
-    ElPopper: typeof import("element-plus")["ElPopper"];
-    ElPopover: typeof import("element-plus")["ElPopover"];
-    ElProgress: typeof import("element-plus")["ElProgress"];
-    ElRadio: typeof import("element-plus")["ElRadio"];
-    ElRadioButton: typeof import("element-plus")["ElRadioButton"];
-    ElRadioGroup: typeof import("element-plus")["ElRadioGroup"];
-    ElRate: typeof import("element-plus")["ElRate"];
-    ElRow: typeof import("element-plus")["ElRow"];
-    ElScrollbar: typeof import("element-plus")["ElScrollbar"];
-    ElSelect: typeof import("element-plus")["ElSelect"];
-    ElSlider: typeof import("element-plus")["ElSlider"];
-    ElStep: typeof import("element-plus")["ElStep"];
-    ElSteps: typeof import("element-plus")["ElSteps"];
-    ElSubMenu: typeof import("element-plus")["ElSubMenu"];
-    ElSwitch: typeof import("element-plus")["ElSwitch"];
-    ElTabPane: typeof import("element-plus")["ElTabPane"];
-    ElTable: typeof import("element-plus")["ElTable"];
-    ElTableColumn: typeof import("element-plus")["ElTableColumn"];
-    ElTabs: typeof import("element-plus")["ElTabs"];
-    ElTag: typeof import("element-plus")["ElTag"];
-    ElTimePicker: typeof import("element-plus")["ElTimePicker"];
-    ElTimeSelect: typeof import("element-plus")["ElTimeSelect"];
-    ElTimeline: typeof import("element-plus")["ElTimeline"];
-    ElTimelineItem: typeof import("element-plus")["ElTimelineItem"];
-    ElTooltip: typeof import("element-plus")["ElTooltip"];
-    ElTransfer: typeof import("element-plus")["ElTransfer"];
-    ElTree: typeof import("element-plus")["ElTree"];
-    ElTreeV2: typeof import("element-plus")["ElTreeV2"];
-    ElUpload: typeof import("element-plus")["ElUpload"];
-    ElSpace: typeof import("element-plus")["ElSpace"];
-    ElSkeleton: typeof import("element-plus")["ElSkeleton"];
-    ElSkeletonItem: typeof import("element-plus")["ElSkeletonItem"];
-    ElCheckTag: typeof import("element-plus")["ElCheckTag"];
-    ElDescriptions: typeof import("element-plus")["ElDescriptions"];
-    ElDescriptionsItem: typeof import("element-plus")["ElDescriptionsItem"];
-    ElResult: typeof import("element-plus")["ElResult"];
-    ElSelectV2: typeof import("element-plus")["ElSelectV2"];
+    ElAffix: (typeof import("element-plus"))["ElAffix"];
+    ElAlert: (typeof import("element-plus"))["ElAlert"];
+    ElAside: (typeof import("element-plus"))["ElAside"];
+    ElAutocomplete: (typeof import("element-plus"))["ElAutocomplete"];
+    ElAvatar: (typeof import("element-plus"))["ElAvatar"];
+    ElBacktop: (typeof import("element-plus"))["ElBacktop"];
+    ElBadge: (typeof import("element-plus"))["ElBadge"];
+    ElBreadcrumb: (typeof import("element-plus"))["ElBreadcrumb"];
+    ElBreadcrumbItem: (typeof import("element-plus"))["ElBreadcrumbItem"];
+    ElButton: (typeof import("element-plus"))["ElButton"];
+    ElButtonGroup: (typeof import("element-plus"))["ElButtonGroup"];
+    ElCalendar: (typeof import("element-plus"))["ElCalendar"];
+    ElCard: (typeof import("element-plus"))["ElCard"];
+    ElCarousel: (typeof import("element-plus"))["ElCarousel"];
+    ElCarouselItem: (typeof import("element-plus"))["ElCarouselItem"];
+    ElCascader: (typeof import("element-plus"))["ElCascader"];
+    ElCascaderPanel: (typeof import("element-plus"))["ElCascaderPanel"];
+    ElCheckbox: (typeof import("element-plus"))["ElCheckbox"];
+    ElCheckboxButton: (typeof import("element-plus"))["ElCheckboxButton"];
+    ElCheckboxGroup: (typeof import("element-plus"))["ElCheckboxGroup"];
+    ElCol: (typeof import("element-plus"))["ElCol"];
+    ElCollapse: (typeof import("element-plus"))["ElCollapse"];
+    ElCollapseItem: (typeof import("element-plus"))["ElCollapseItem"];
+    ElCollapseTransition: (typeof import("element-plus"))["ElCollapseTransition"];
+    ElColorPicker: (typeof import("element-plus"))["ElColorPicker"];
+    ElContainer: (typeof import("element-plus"))["ElContainer"];
+    ElConfigProvider: (typeof import("element-plus"))["ElConfigProvider"];
+    ElDatePicker: (typeof import("element-plus"))["ElDatePicker"];
+    ElDialog: (typeof import("element-plus"))["ElDialog"];
+    ElDivider: (typeof import("element-plus"))["ElDivider"];
+    ElDrawer: (typeof import("element-plus"))["ElDrawer"];
+    ElDropdown: (typeof import("element-plus"))["ElDropdown"];
+    ElDropdownItem: (typeof import("element-plus"))["ElDropdownItem"];
+    ElDropdownMenu: (typeof import("element-plus"))["ElDropdownMenu"];
+    ElEmpty: (typeof import("element-plus"))["ElEmpty"];
+    ElFooter: (typeof import("element-plus"))["ElFooter"];
+    ElForm: (typeof import("element-plus"))["ElForm"];
+    ElFormItem: (typeof import("element-plus"))["ElFormItem"];
+    ElHeader: (typeof import("element-plus"))["ElHeader"];
+    ElIcon: (typeof import("element-plus"))["ElIcon"];
+    ElImage: (typeof import("element-plus"))["ElImage"];
+    ElImageViewer: (typeof import("element-plus"))["ElImageViewer"];
+    ElInput: (typeof import("element-plus"))["ElInput"];
+    ElInputNumber: (typeof import("element-plus"))["ElInputNumber"];
+    ElLink: (typeof import("element-plus"))["ElLink"];
+    ElMain: (typeof import("element-plus"))["ElMain"];
+    ElMenu: (typeof import("element-plus"))["ElMenu"];
+    ElMenuItem: (typeof import("element-plus"))["ElMenuItem"];
+    ElMenuItemGroup: (typeof import("element-plus"))["ElMenuItemGroup"];
+    ElOption: (typeof import("element-plus"))["ElOption"];
+    ElOptionGroup: (typeof import("element-plus"))["ElOptionGroup"];
+    ElPageHeader: (typeof import("element-plus"))["ElPageHeader"];
+    ElPagination: (typeof import("element-plus"))["ElPagination"];
+    ElPopconfirm: (typeof import("element-plus"))["ElPopconfirm"];
+    ElPopper: (typeof import("element-plus"))["ElPopper"];
+    ElPopover: (typeof import("element-plus"))["ElPopover"];
+    ElProgress: (typeof import("element-plus"))["ElProgress"];
+    ElRadio: (typeof import("element-plus"))["ElRadio"];
+    ElRadioButton: (typeof import("element-plus"))["ElRadioButton"];
+    ElRadioGroup: (typeof import("element-plus"))["ElRadioGroup"];
+    ElRate: (typeof import("element-plus"))["ElRate"];
+    ElRow: (typeof import("element-plus"))["ElRow"];
+    ElScrollbar: (typeof import("element-plus"))["ElScrollbar"];
+    ElSelect: (typeof import("element-plus"))["ElSelect"];
+    ElSlider: (typeof import("element-plus"))["ElSlider"];
+    ElStep: (typeof import("element-plus"))["ElStep"];
+    ElSteps: (typeof import("element-plus"))["ElSteps"];
+    ElSubMenu: (typeof import("element-plus"))["ElSubMenu"];
+    ElSwitch: (typeof import("element-plus"))["ElSwitch"];
+    ElTabPane: (typeof import("element-plus"))["ElTabPane"];
+    ElTable: (typeof import("element-plus"))["ElTable"];
+    ElTableColumn: (typeof import("element-plus"))["ElTableColumn"];
+    ElTabs: (typeof import("element-plus"))["ElTabs"];
+    ElTag: (typeof import("element-plus"))["ElTag"];
+    ElText: (typeof import("element-plus"))["ElText"];
+    ElTimePicker: (typeof import("element-plus"))["ElTimePicker"];
+    ElTimeSelect: (typeof import("element-plus"))["ElTimeSelect"];
+    ElTimeline: (typeof import("element-plus"))["ElTimeline"];
+    ElTimelineItem: (typeof import("element-plus"))["ElTimelineItem"];
+    ElTooltip: (typeof import("element-plus"))["ElTooltip"];
+    ElTransfer: (typeof import("element-plus"))["ElTransfer"];
+    ElTree: (typeof import("element-plus"))["ElTree"];
+    ElTreeV2: (typeof import("element-plus"))["ElTreeV2"];
+    ElTreeSelect: (typeof import("element-plus"))["ElTreeSelect"];
+    ElUpload: (typeof import("element-plus"))["ElUpload"];
+    ElSpace: (typeof import("element-plus"))["ElSpace"];
+    ElSkeleton: (typeof import("element-plus"))["ElSkeleton"];
+    ElSkeletonItem: (typeof import("element-plus"))["ElSkeletonItem"];
+    ElStatistic: (typeof import("element-plus"))["ElStatistic"];
+    ElCheckTag: (typeof import("element-plus"))["ElCheckTag"];
+    ElDescriptions: (typeof import("element-plus"))["ElDescriptions"];
+    ElDescriptionsItem: (typeof import("element-plus"))["ElDescriptionsItem"];
+    ElResult: (typeof import("element-plus"))["ElResult"];
+    ElSelectV2: (typeof import("element-plus"))["ElSelectV2"];
+    ElWatermark: (typeof import("element-plus"))["ElWatermark"];
+    ElTour: (typeof import("element-plus"))["ElTour"];
+    ElTourStep: (typeof import("element-plus"))["ElTourStep"];
   }
 
   interface ComponentCustomProperties {
-    $message: typeof import("element-plus")["ElMessage"];
-    $notify: typeof import("element-plus")["ElNotification"];
-    $msgbox: typeof import("element-plus")["ElMessageBox"];
-    $messageBox: typeof import("element-plus")["ElMessageBox"];
-    $alert: typeof import("element-plus")["ElMessageBox"]["alert"];
-    $confirm: typeof import("element-plus")["ElMessageBox"]["confirm"];
-    $prompt: typeof import("element-plus")["ElMessageBox"]["prompt"];
-    $loading: typeof import("element-plus")["ElLoadingService"];
+    $message: (typeof import("element-plus"))["ElMessage"];
+    $notify: (typeof import("element-plus"))["ElNotification"];
+    $msgbox: (typeof import("element-plus"))["ElMessageBox"];
+    $messageBox: (typeof import("element-plus"))["ElMessageBox"];
+    $alert: (typeof import("element-plus"))["ElMessageBox"]["alert"];
+    $confirm: (typeof import("element-plus"))["ElMessageBox"]["confirm"];
+    $prompt: (typeof import("element-plus"))["ElMessageBox"]["prompt"];
+    $loading: (typeof import("element-plus"))["ElLoadingService"];
   }
 }
 

types/global.d.ts

@@ -1,11 +1,4 @@
-import type {
-  VNode,
-  FunctionalComponent,
-  PropType as VuePropType,
-  ComponentPublicInstance
-} from "vue";
 import type { ECharts } from "echarts";
-import type { IconifyIcon } from "@iconify/vue";
 import type { TableColumns } from "@pureadmin/table";
 
 /**
@@ -13,12 +6,16 @@ import type { TableColumns } from "@pureadmin/table";
  */
 declare global {
   /**
-   * 平台的名称、版本、依赖、最后构建时间的类型提示
+   * 平台的名称、版本、运行所需的`node`和`pnpm`版本、依赖、最后构建时间的类型提示
    */
   const __APP_INFO__: {
     pkg: {
       name: string;
       version: string;
+      engines: {
+        node: string;
+        pnpm: string;
+      };
       dependencies: Recordable<string>;
       devDependencies: Recordable<string>;
     };
@@ -72,10 +69,10 @@ declare global {
   interface TableColumnList extends Array<TableColumns> {}
 
   /**
-   * 对应 `public/serverConfig.json` 文件的类型声明
-   * @see {@link https://yiming_chang.gitee.io/pure-admin-doc/pages/config/#serverconfig-json}
+   * 对应 `public/platform-config.json` 文件的类型声明
+   * @see {@link https://yiming_chang.gitee.io/pure-admin-doc/pages/config/#platform-config-json}
    */
-  interface ServerConfigs {
+  interface PlatformConfigs {
     Version?: string;
     Title?: string;
     FixedHeader?: boolean;
@@ -86,9 +83,11 @@ declare global {
     Layout?: string;
     Theme?: string;
     DarkMode?: boolean;
+    OverallStyle?: string;
     Grey?: boolean;
     Weak?: boolean;
     HideTabs?: boolean;
+    HideFooter?: boolean;
     SidebarStatus?: boolean;
     EpThemeColor?: string;
     ShowLogo?: boolean;
@@ -97,11 +96,12 @@ declare global {
     CachingAsyncRoutes?: boolean;
     TooltipEffect?: Effect;
     ResponsiveStorageNameSpace?: string;
+    MenuSearchHistory?: number;
   }
 
   /**
-   * 与 `ServerConfigs` 类型不同，这里是缓存到浏览器本地存储的类型声明
-   * @see {@link https://yiming_chang.gitee.io/pure-admin-doc/pages/config/#serverconfig-json}
+   * 与 `PlatformConfigs` 类型不同，这里是缓存到浏览器本地存储的类型声明
+   * @see {@link https://yiming_chang.gitee.io/pure-admin-doc/pages/config/#platform-config-json}
    */
   interface StorageConfigs {
     version?: string;
@@ -117,10 +117,14 @@ declare global {
     grey?: boolean;
     weak?: boolean;
     hideTabs?: boolean;
+    hideFooter?: boolean;
     sidebarStatus?: boolean;
     epThemeColor?: string;
+    themeColor?: string;
+    overallStyle?: string;
     showLogo?: boolean;
     showModel?: string;
+    menuSearchHistory?: number;
     username?: string;
   }
 
@@ -137,11 +141,14 @@ declare global {
       darkMode?: boolean;
       sidebarStatus?: boolean;
       epThemeColor?: string;
+      themeColor?: string;
+      overallStyle?: string;
     };
     configure: {
       grey?: boolean;
       weak?: boolean;
       hideTabs?: boolean;
+      hideFooter?: boolean;
       showLogo?: boolean;
       showModel?: string;
       multiTagsCache?: boolean;
@@ -155,6 +162,20 @@ declare global {
   interface GlobalPropertiesApi {
     $echarts: ECharts;
     $storage: ResponsiveStorage;
-    $config: ServerConfigs;
+    $config: PlatformConfigs;
+  }
+
+  /**
+   * 扩展 `Element`
+   */
+  interface Element {
+    // v-ripple 作用于 src/directives/ripple/index.ts 文件
+    _ripple?: {
+      enabled?: boolean;
+      centered?: boolean;
+      class?: string;
+      circle?: boolean;
+      touched?: boolean;
+    };
   }
 }

types/router.d.ts

@@ -1,6 +1,7 @@
 // 全局路由类型声明
 
-import { type RouteComponent, type RouteLocationNormalized } from "vue-router";
+import type { RouteComponent, RouteLocationNormalized } from "vue-router";
+import type { FunctionalComponent } from "vue";
 
 declare global {
   interface ToRouteType extends RouteLocationNormalized {
@@ -31,7 +32,7 @@ declare global {
     frameSrc?: string;
     /** `iframe`页是否开启首次加载动画（默认`true`）`可选` */
     frameLoading?: boolean;
-    /** 页面加载动画（有两种形式，一种直接采用vue内置的`transitions`动画，另一种是使用`animate.css`写进、离场动画）`可选` */
+    /** 页面加载动画（两种模式，第二种权重更高，第一种直接采用`vue`内置的`transitions`动画，第二种是使用`animate.css`编写进、离场动画，平台更推荐使用第二种模式，已经内置了`animate.css`，直接写对应的动画名即可）`可选` */
     transition?: {
       /**
        * @description 当前路由动画效果

types/shims-vue.d.ts

@@ -1,5 +1,5 @@
 declare module "*.vue" {
-  import { DefineComponent } from "vue";
+  import type { DefineComponent } from "vue";
   const component: DefineComponent<{}, {}, any>;
   export default component;
 }
@@ -8,3 +8,5 @@ declare module "*.scss" {
   const scss: Record<string, string>;
   export default scss;
 }
+
+declare module "element-plus/dist/locale/zh-cn.mjs";