提交新版本

packages/effects/hooks/src/index.ts

@@ -0,0 +1,10 @@
+export * from './use-app-config';
+export * from './use-content-maximize';
+export * from './use-design-tokens';
+export * from './use-dict';
+export * from './use-hover-toggle';
+export * from './use-pagination';
+export * from './use-refresh';
+export * from './use-tabs';
+export * from './use-watermark';
+export * from '@vben-core/composables';

packages/effects/hooks/src/use-app-config.ts

@@ -0,0 +1,48 @@
+import type {
+  ApplicationConfig,
+  VbenAdminProAppConfigRaw,
+} from '@vben/types/global';
+
+/**
+ * 由 vite-inject-app-config 注入的全局配置
+ */
+export function useAppConfig(
+  env: Record<string, any>,
+  isProduction: boolean,
+): ApplicationConfig {
+  // 生产环境下，直接使用 window._VBEN_ADMIN_PRO_APP_CONF_ 全局变量
+  const config = isProduction
+    ? window._VBEN_ADMIN_PRO_APP_CONF_
+    : (env as VbenAdminProAppConfigRaw);
+
+  const {
+    VITE_GLOB_API_URL,
+    VITE_GLOB_AUTH_DINGDING_CORP_ID,
+    VITE_GLOB_AUTH_DINGDING_CLIENT_ID,
+  } = config;
+
+  const applicationConfig: ApplicationConfig = {
+    apiURL: VITE_GLOB_API_URL,
+    auth: {},
+  };
+  if (VITE_GLOB_AUTH_DINGDING_CORP_ID && VITE_GLOB_AUTH_DINGDING_CLIENT_ID) {
+    applicationConfig.auth.dingding = {
+      clientId: VITE_GLOB_AUTH_DINGDING_CLIENT_ID,
+      corpId: VITE_GLOB_AUTH_DINGDING_CORP_ID,
+    };
+  }
+
+  return applicationConfig;
+}
+
+export function isTenantEnable(): boolean {
+  return import.meta.env.VITE_APP_TENANT_ENABLE === 'true';
+}
+
+export function isCaptchaEnable(): boolean {
+  return import.meta.env.VITE_APP_CAPTCHA_ENABLE === 'true';
+}
+
+export function isDocAlertEnable(): boolean {
+  return import.meta.env.VITE_APP_DOCALERT_ENABLE !== 'false';
+}

packages/effects/hooks/src/use-dict.ts

@@ -0,0 +1,87 @@
+import { useDictStore } from '@vben/stores';
+import { isObject } from '@vben/utils';
+
+type ColorType = 'error' | 'info' | 'success' | 'warning';
+
+export interface DictDataType {
+  dictType?: string;
+  label: string;
+  value: boolean | number | string;
+  colorType?: ColorType;
+  cssClass?: string;
+}
+
+export interface NumberDictDataType extends DictDataType {
+  value: number;
+}
+
+export interface StringDictDataType extends DictDataType {
+  value: string;
+}
+
+/**
+ * 获取字典标签
+ *
+ * @param dictType 字典类型
+ * @param value 字典值
+ * @returns 字典标签
+ */
+export function getDictLabel(dictType: string, value: any) {
+  const dictStore = useDictStore();
+  const dictObj = dictStore.getDictData(dictType, value);
+  return isObject(dictObj) ? dictObj.label : '';
+}
+
+/**
+ * 获取字典对象
+ *
+ * @param dictType 字典类型
+ * @param value 字典值
+ * @returns 字典对象
+ */
+export function getDictObj(dictType: string, value: any) {
+  const dictStore = useDictStore();
+  const dictObj = dictStore.getDictData(dictType, value);
+  return isObject(dictObj) ? dictObj : null;
+}
+
+/**
+ * 获取字典数组 用于select radio 等
+ *
+ * @param dictType 字典类型
+ * @param valueType 字典值类型，默认 string 类型
+ * @returns 字典数组
+ */
+export function getDictOptions(
+  dictType: string,
+  valueType: 'boolean' | 'number' | 'string' = 'string',
+): DictDataType[] {
+  const dictStore = useDictStore();
+  const dictOpts = dictStore.getDictOptions(dictType);
+  const dictOptions: DictDataType[] = [];
+  if (dictOpts.length > 0) {
+    let dictValue: boolean | number | string = '';
+    dictOpts.forEach((d) => {
+      switch (valueType) {
+        case 'boolean': {
+          dictValue = `${d.value}` === 'true';
+          break;
+        }
+        case 'number': {
+          dictValue = Number.parseInt(`${d.value}`);
+          break;
+        }
+        case 'string': {
+          dictValue = `${d.value}`;
+          break;
+        }
+        // No default
+      }
+      dictOptions.push({
+        value: dictValue,
+        label: d.label,
+      });
+    });
+  }
+  return dictOptions.length > 0 ? dictOptions : [];
+}

packages/effects/hooks/src/use-pagination.ts

@@ -0,0 +1,72 @@
+import type { Ref } from 'vue';
+
+import { computed, ref, unref, watch } from 'vue';
+
+/**
+ * Paginates an array of items
+ * @param list The array to paginate
+ * @param pageNo The current page number (1-based)
+ * @param pageSize Number of items per page
+ * @returns Paginated array slice
+ * @throws {Error} If pageNo or pageSize are invalid
+ */
+function pagination<T = any>(list: T[], pageNo: number, pageSize: number): T[] {
+  if (pageNo < 1) throw new Error('Page number must be positive');
+  if (pageSize < 1) throw new Error('Page size must be positive');
+
+  const offset = (pageNo - 1) * Number(pageSize);
+  const ret =
+    offset + pageSize >= list.length
+      ? list.slice(offset)
+      : list.slice(offset, offset + pageSize);
+  return ret;
+}
+
+export function usePagination<T = any>(
+  list: Ref<T[]>,
+  pageSize: number,
+  totalChangeToFirstPage = true,
+) {
+  const currentPage = ref(1);
+  const pageSizeRef = ref(pageSize);
+
+  const totalPages = computed(() =>
+    Math.ceil(unref(list).length / unref(pageSizeRef)),
+  );
+
+  const paginationList = computed(() => {
+    return pagination(unref(list), unref(currentPage), unref(pageSizeRef));
+  });
+
+  const total = computed(() => {
+    return unref(list).length;
+  });
+
+  if (totalChangeToFirstPage) {
+    watch(total, () => {
+      setCurrentPage(1);
+    });
+  }
+
+  function setCurrentPage(page: number) {
+    if (page === 1 && unref(totalPages) === 0) {
+      currentPage.value = 1;
+    } else {
+      if (page < 1 || page > unref(totalPages)) {
+        throw new Error('Invalid page number');
+      }
+      currentPage.value = page;
+    }
+  }
+
+  function setPageSize(pageSize: number) {
+    if (pageSize < 1) {
+      throw new Error('Page size must be positive');
+    }
+    pageSizeRef.value = pageSize;
+    // Reset to first page to prevent invalid state
+    currentPage.value = 1;
+  }
+
+  return { setCurrentPage, total, setPageSize, paginationList, currentPage };
+}