@oiij/naive-ui 0.0.73 → 0.0.75

package/dist/composables/use-loading.js

@@ -2,6 +2,14 @@ import { loadingProviderInjectionKey } from "../components/loading-provider/inde
 import { inject } from "vue";
 
 //#region src/composables/use-loading.ts
+/**
+* 用于获取 Naive UI 加载状态提供者的组合式 API
+* 提供对加载状态的全局访问
+*/
+/**
+* 用于获取 Naive UI 加载状态提供者的组合式 API
+* @returns 加载状态提供者实例
+*/
 function useLoading() {
 	return inject(loadingProviderInjectionKey);
 }

package/dist/composables/use-naive-form.d.ts

@@ -1,40 +1,63 @@
 import { DataObject } from "./use-data-request.js";
-import * as _vueuse_core3 from "@vueuse/core";
-import * as vue5 from "vue";
+import * as vue1 from "vue";
 import { MaybeRefOrGetter, Ref, TemplateRef } from "vue";
+import * as _vueuse_core0 from "@vueuse/core";
 import { FormInst, FormItemRule, FormRules } from "naive-ui";
 import { ValidateError } from "async-validator";
 
 //#region src/composables/use-naive-form.d.ts
+/**
+ * 表单清空规则配置
+ * 用于指定不同类型值的清空后的默认值
+ */
 type UseNaiveFormClearRules = {
-  string?: string | null;
-  number?: number | null;
+  /** 字符串类型的默认值 */string?: string | null; /** 数字类型的默认值 */
+  number?: number | null; /** 布尔类型的默认值 */
   boolean?: boolean | null;
 };
+/**
+ * 表单规则类型
+ * @template T 表单值类型
+ */
 type UseNaiveFormRules<T extends DataObject> = Partial<Record<keyof T, FormRules | FormItemRule | FormItemRule[]>>;
+/**
+ * 表单配置选项
+ * @template T 表单值类型
+ */
 type UseNaiveFormOptions<T extends DataObject> = {
-  value?: MaybeRefOrGetter<T>;
-  rules?: MaybeRefOrGetter<UseNaiveFormRules<T>>;
+  /** 表单初始值，支持响应式引用或普通值 */value?: MaybeRefOrGetter<T>; /** 表单验证规则，支持响应式引用或普通值 */
+  rules?: MaybeRefOrGetter<UseNaiveFormRules<T>>; /** 表单清空规则 */
   clearRules?: UseNaiveFormClearRules;
 };
+/**
+ * 用于处理 Naive UI 表单的组合式 API
+ * @template T 表单值类型
+ * @param formInstRef 表单实例引用
+ * @param options 配置选项
+ * @returns 表单操作对象
+ */
 declare function useNaiveForm<T extends DataObject = DataObject>(formInstRef: TemplateRef<FormInst>, options?: UseNaiveFormOptions<T>): {
-  formInstRef: Readonly<vue5.ShallowRef<FormInst | null>>;
-  formValueRef: Ref<T, T>;
-  formRulesRef: Ref<Partial<Record<keyof T, FormRules | FormItemRule | FormItemRule[]>>, Partial<Record<keyof T, FormRules | FormItemRule | FormItemRule[]>>>;
+  /** 表单实例引用 */formInst: Readonly<vue1.ShallowRef<FormInst | null>>; /** 表单值引用 */
+  formValue: Ref<T, T>; /** 表单规则引用 */
+  formRules: Ref<Partial<Record<keyof T, FormRules | FormItemRule | FormItemRule[]>>, Partial<Record<keyof T, FormRules | FormItemRule | FormItemRule[]>>>; /** 表单属性，用于绑定到表单组件 */
   formProps: {
-    model: vue5.Reactive<T>;
-    rules: vue5.Reactive<Partial<Record<keyof T, FormRules | FormItemRule | FormItemRule[]>>>;
-  };
-  setValue: (_value: Partial<T>) => void;
+    model: vue1.Reactive<T>;
+    rules: vue1.Reactive<Partial<Record<keyof T, FormRules | FormItemRule | FormItemRule[]>>>;
+  }; /** 设置表单值 */
+  setValue: (_value: Partial<T>) => void; /** 验证表单 */
   validate: () => Promise<{
     warnings?: ValidateError[][];
-  }>;
-  resetValidation: () => void;
-  resetForm: () => void;
-  reset: () => void;
-  clear: () => void;
-  onValidated: _vueuse_core3.EventHookOn<[T]>;
+  }>; /** 重置表单验证状态 */
+  resetValidation: () => void; /** 重置表单值到初始状态 */
+  resetForm: () => void; /** 重置表单验证状态和值 */
+  reset: () => void; /** 清空表单值 */
+  clear: () => void; /** 验证成功事件 */
+  onValidated: _vueuse_core0.EventHookOn<[T]>;
 };
+/**
+ * useNaiveForm 返回类型
+ * @template T 表单值类型
+ */
 type UseNaiveFormReturns<T extends DataObject = DataObject> = ReturnType<typeof useNaiveForm<T>>;
 //#endregion
 export { UseNaiveFormClearRules, UseNaiveFormOptions, UseNaiveFormReturns, UseNaiveFormRules, useNaiveForm };

package/dist/composables/use-naive-form.js

@@ -1,18 +1,29 @@
-import { createEventHook } from "@vueuse/core";
 import { reactive, ref, toRaw, toValue, watchEffect } from "vue";
+import { createEventHook } from "@vueuse/core";
 import { cloneDeep } from "es-toolkit/object";
 
 //#region src/composables/use-naive-form.ts
+/**
+* 检查值是否为对象类型
+* @param value 要检查的值
+* @returns 是否为对象类型
+*/
 function isObject(value) {
 	return typeof value === "object" && value !== null && !Array.isArray(value);
 }
+/**
+* 清空对象值
+* @param obj 要清空的对象
+* @param rules 清空规则
+* @returns 清空后的对象
+*/
 function clearObjectValues(obj, rules) {
 	const { string: _string = "", number: _number = null, boolean: _boolean = false } = rules ?? {};
 	if (Array.isArray(obj)) {
 		obj.length = 0;
 		return obj;
 	}
-	if (typeof obj === "object" && obj !== null) {
+	if (typeof obj === "object" && obj !== null && !Array.isArray(obj)) {
 		for (const key in obj) if (Object.prototype.hasOwnProperty.call(obj, key)) obj[key] = clearObjectValues(obj[key], rules);
 		return obj;
 	}
@@ -21,6 +32,12 @@ function clearObjectValues(obj, rules) {
 	if (typeof obj === "boolean") return _boolean;
 	return obj;
 }
+/**
+* 深度合并对象
+* @param target 目标对象
+* @param source 源对象
+* @returns 合并后的对象
+*/
 function deepMerge(target = {}, source = {}) {
 	for (const key in source) if (Object.prototype.hasOwnProperty.call(source, key)) {
 		const sourceValue = source[key];
@@ -30,6 +47,13 @@ function deepMerge(target = {}, source = {}) {
 	}
 	return target;
 }
+/**
+* 用于处理 Naive UI 表单的组合式 API
+* @template T 表单值类型
+* @param formInstRef 表单实例引用
+* @param options 配置选项
+* @returns 表单操作对象
+*/
 function useNaiveForm(formInstRef, options) {
 	const { value, rules, clearRules } = options ?? {};
 	const cacheValue = cloneDeep(toValue(value) ?? {});
@@ -44,9 +68,17 @@ function useNaiveForm(formInstRef, options) {
 		rules: reactive(formRulesRef.value)
 	};
 	const onValidatedEvent = createEventHook();
+	/**
+	* 设置表单值
+	* @param _value 要设置的值
+	*/
 	function setValue(_value) {
 		Object.assign(formValueRef.value, _value);
 	}
+	/**
+	* 验证表单
+	* @returns 验证结果Promise
+	*/
 	function validate() {
 		return new Promise((resolve, reject) => {
 			if (!formInstRef.value) return reject(/* @__PURE__ */ new Error("useNaiveForm: formInstRef is not found."));
@@ -56,25 +88,37 @@ function useNaiveForm(formInstRef, options) {
 			}).catch(reject);
 		});
 	}
+	/**
+	* 重置表单验证状态
+	*/
 	function resetValidation() {
 		formInstRef.value?.restoreValidation();
 	}
+	/**
+	* 清空表单值
+	*/
 	function clear() {
 		clearObjectValues(formValueRef.value, clearRules);
 	}
+	/**
+	* 重置表单值到初始状态
+	*/
 	function resetForm() {
 		clear();
 		const _cacheValue = cloneDeep(cacheValue);
 		deepMerge(formValueRef.value, _cacheValue);
 	}
+	/**
+	* 重置表单验证状态和值
+	*/
 	function reset() {
 		resetValidation();
 		resetForm();
 	}
 	return {
-		formInstRef,
-		formValueRef,
-		formRulesRef,
+		formInst: formInstRef,
+		formValue: formValueRef,
+		formRules: formRulesRef,
 		formProps,
 		setValue,
 		validate,

package/dist/composables/use-naive-theme.d.ts

@@ -4,24 +4,38 @@ import { GlobalThemeOverrides, NDateLocale, zhCN } from "naive-ui";
 import * as naive_ui_es_themes_interface0 from "naive-ui/es/themes/interface";
 
 //#region src/composables/use-naive-theme.d.ts
+/**
+ * 语言包类型
+ * @template T 语言代码类型
+ */
 type Locales<T extends string = string> = Record<T, {
-  name: string;
-  dateLocale: NDateLocale;
+  /** 语言名称 */name: string; /** 日期本地化配置 */
+  dateLocale: NDateLocale; /** 语言包配置 */
   locale: typeof zhCN;
 }>;
+/**
+ * 主题配置选项
+ * @template T 语言代码类型
+ */
 type UseNaiveThemeOptions<T extends string> = {
-  language?: MaybeRefOrGetter<T>;
-  darkMode?: MaybeRefOrGetter<boolean>;
-  colors?: Colors;
-  globalThemeOverrides?: GlobalThemeOverrides;
-  locales?: Partial<Locales<T>>;
+  /** 语言代码，支持响应式引用或普通值 */language?: MaybeRefOrGetter<T>; /** 暗黑模式开关，支持响应式引用或普通值 */
+  darkMode?: MaybeRefOrGetter<boolean>; /** 主题颜色配置 */
+  colors?: Colors; /** 全局主题覆盖 */
+  globalThemeOverrides?: GlobalThemeOverrides; /** 自定义语言包 */
+  locales?: Partial<Locales<T>>; /** 暗黑模式颜色配置，支持对象或函数 */
   darkColors?: Colors | ((colors: Colors) => Colors);
 };
+/**
+ * 用于处理 Naive UI 主题的组合式 API
+ * @template T 语言代码类型
+ * @param options 配置选项
+ * @returns 主题管理对象
+ */
 declare function useNaiveTheme<T extends string>(options?: UseNaiveThemeOptions<T>): {
-  languageRef: Ref<T | undefined, T | undefined>;
-  darkModeRef: Ref<boolean | undefined, boolean | undefined>;
-  theme: ComputedRef<naive_ui_es_themes_interface0.BuiltInGlobalTheme | undefined>;
-  colorsRef: Ref<{
+  /** 语言代码引用 */language: Ref<T | undefined, T | undefined>; /** 暗黑模式引用 */
+  darkMode: Ref<boolean | undefined, boolean | undefined>; /** 当前主题 */
+  theme: ComputedRef<naive_ui_es_themes_interface0.BuiltInGlobalTheme | undefined>; /** 颜色配置引用 */
+  colors: Ref<{
     primary?: string | undefined;
     info?: string | undefined;
     success?: string | undefined;
@@ -33,19 +47,22 @@ declare function useNaiveTheme<T extends string>(options?: UseNaiveThemeOptions<
     success?: string | undefined;
     warning?: string | undefined;
     error?: string | undefined;
-  }>;
+  }>; /** 计算后的主题颜色 */
   themeColors: ComputedRef<{
     primary?: string | undefined;
     info?: string | undefined;
     success?: string | undefined;
     warning?: string | undefined;
     error?: string | undefined;
-  }>;
-  themeOverrides: ComputedRef<GlobalThemeOverrides>;
-  locales: Locales<T>;
-  locale: ComputedRef<Locales<T>[T]>;
+  }>; /** 主题覆盖配置 */
+  themeOverrides: ComputedRef<GlobalThemeOverrides>; /** 合并后的语言包 */
+  locales: Locales<T>; /** 当前语言包 */
+  locale: ComputedRef<Locales<T>[T]>; /** 设置主题颜色 */
   setColor: (v: Partial<Colors>) => void;
 };
+/**
+ * useNaiveTheme 返回类型
+ */
 type UseNaiveThemeReturns = ReturnType<typeof useNaiveTheme>;
 //#endregion
 export { UseNaiveThemeOptions, UseNaiveThemeReturns, useNaiveTheme };

package/dist/composables/use-naive-theme.js

@@ -3,6 +3,9 @@ import { computed, ref, toValue, watchEffect } from "vue";
 import { darkTheme, dateEnUS, dateZhCN, enUS, zhCN } from "naive-ui";
 
 //#region src/composables/use-naive-theme.ts
+/**
+* 默认语言包映射
+*/
 const naiveLocaleMap = {
 	"zh-CN": {
 		name: "简体中文",
@@ -15,6 +18,12 @@ const naiveLocaleMap = {
 		locale: enUS
 	}
 };
+/**
+* 用于处理 Naive UI 主题的组合式 API
+* @template T 语言代码类型
+* @param options 配置选项
+* @returns 主题管理对象
+*/
 function useNaiveTheme(options) {
 	const { language, darkMode, colors, globalThemeOverrides, locales, darkColors } = options ?? {};
 	const languageRef = ref(toValue(language));
@@ -40,6 +49,10 @@ function useNaiveTheme(options) {
 		}
 		return colorsRef.value;
 	});
+	/**
+	* 设置主题颜色
+	* @param v 颜色配置
+	*/
 	function setColor(v) {
 		colorsRef.value = {
 			...colorsRef.value,
@@ -83,10 +96,10 @@ function useNaiveTheme(options) {
 		...locales
 	};
 	return {
-		languageRef,
-		darkModeRef,
+		language: languageRef,
+		darkMode: darkModeRef,
 		theme,
-		colorsRef,
+		colors: colorsRef,
 		themeColors,
 		themeOverrides,
 		locales: localesMerge,

package/dist/index.d.ts

@@ -1,6 +1,7 @@
+import { UseAutoMenuReturn, useAutoMenu } from "./composables/use-auto-menu.js";
 import { DataObject, DataRequestFields, UseDataRequestOptions, UseDataRequestPagination, UseDataRequestReturns, useDataRequest } from "./composables/use-data-request.js";
 import { useLoading } from "./composables/use-loading.js";
 import { UseNaiveFormClearRules, UseNaiveFormOptions, UseNaiveFormReturns, UseNaiveFormRules, useNaiveForm } from "./composables/use-naive-form.js";
 import { UseNaiveThemeOptions, UseNaiveThemeReturns, useNaiveTheme } from "./composables/use-naive-theme.js";
 import "./composables/index.js";
-export { DataObject, DataRequestFields, UseDataRequestOptions, UseDataRequestPagination, UseDataRequestReturns, UseNaiveFormClearRules, UseNaiveFormOptions, UseNaiveFormReturns, UseNaiveFormRules, UseNaiveThemeOptions, UseNaiveThemeReturns, useDataRequest, useLoading, useNaiveForm, useNaiveTheme };
+export { DataObject, DataRequestFields, UseAutoMenuReturn, UseDataRequestOptions, UseDataRequestPagination, UseDataRequestReturns, UseNaiveFormClearRules, UseNaiveFormOptions, UseNaiveFormReturns, UseNaiveFormRules, UseNaiveThemeOptions, UseNaiveThemeReturns, useAutoMenu, useDataRequest, useLoading, useNaiveForm, useNaiveTheme };

package/dist/index.js

@@ -1,6 +1,7 @@
+import { useAutoMenu } from "./composables/use-auto-menu.js";
 import { useDataRequest } from "./composables/use-data-request.js";
 import { useLoading } from "./composables/use-loading.js";
 import { useNaiveForm } from "./composables/use-naive-form.js";
 import { useNaiveTheme } from "./composables/use-naive-theme.js";
 
-export { useDataRequest, useLoading, useNaiveForm, useNaiveTheme };
+export { useAutoMenu, useDataRequest, useLoading, useNaiveForm, useNaiveTheme };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oiij/naive-ui",
   "type": "module",
-  "version": "0.0.73",
+  "version": "0.0.75",
   "description": "Some Composable Functions And Components for Vue 3",
   "author": "oiij",
   "license": "MIT",
@@ -45,9 +45,10 @@
     "vue": "^3.5.27",
     "vue-component-type-helpers": "^3.2.4",
     "vue-hooks-plus": "^2.4.1",
+    "vue-router": "^5.0.2",
+    "@oiij/markdown-it": "0.0.12",
     "@oiij/css-render": "0.0.10",
-    "@oiij/markdown-it": "0.0.11",
-    "@oiij/use": "0.0.42"
+    "@oiij/use": "0.0.44"
   },
   "devDependencies": {
     "@types/prismjs": "^1.26.5",
@@ -60,9 +61,10 @@
     "vue": "^3.5.27",
     "vue-component-type-helpers": "^3.2.4",
     "vue-hooks-plus": "^2.4.1",
+    "vue-router": "^5.0.2",
+    "@oiij/markdown-it": "0.0.12",
     "@oiij/css-render": "0.0.10",
-    "@oiij/markdown-it": "0.0.11",
-    "@oiij/use": "0.0.42"
+    "@oiij/use": "0.0.44"
   },
   "publishConfig": {
     "access": "public"