@oiij/naive-ui 0.0.76 → 0.0.78

package/dist/components/remote-request/index.d.ts

@@ -4,22 +4,44 @@ import { ComponentExposed } from "vue-component-type-helpers";
 import { UseRequestOptions, UseRequestPlugin } from "vue-hooks-plus/es/useRequest/types";
 
 //#region src/components/remote-request/index.d.ts
+/**
+ * 远程请求字段配置
+ */
 type RemoteRequestFields = DataRequestFields & {};
+/**
+ * 远程请求暴露的方法
+ * @template P 请求参数类型
+ * @template D 响应数据类型
+ * @template R 列表项类型
+ */
 type RemoteRequestExpose<P extends DataObject = DataObject, D extends DataObject = DataObject, R extends DataObject = DataObject> = UseDataRequestReturns<P, D, R>;
+/**
+ * 远程请求属性
+ * @template P 请求参数类型
+ * @template D 响应数据类型
+ */
 type RemoteRequestProps<P extends DataObject = DataObject, D extends DataObject = DataObject> = {
-  api: (...args: P[]) => Promise<D>;
-  defaultParams?: Partial<P>;
-  manual?: boolean;
-  fields?: RemoteRequestFields;
-  requestOptions?: UseRequestOptions<D, P[]>;
+  /** API 函数 */api: (...args: P[]) => Promise<D>; /** 默认请求参数 */
+  defaultParams?: Partial<P>; /** 是否手动触发 */
+  manual?: boolean; /** 字段配置 */
+  fields?: RemoteRequestFields; /** 请求选项 */
+  requestOptions?: UseRequestOptions<D, P[]>; /** 请求插件 */
   requestPlugins?: UseRequestPlugin<D, P[]>[];
 };
+/**
+ * 远程请求事件
+ * @template P 请求参数类型
+ * @template D 响应数据类型
+ */
 type RemoteRequestEmits<P extends DataObject = DataObject, D extends DataObject = DataObject> = {
-  (e: 'before', params: P[]): void;
-  (e: 'success', data: D, params: P[]): void;
-  (e: 'error', err: Error, params: P[]): void;
+  /** 请求前事件 */(e: 'before', params: P[]): void; /** 请求成功事件 */
+  (e: 'success', data: D, params: P[]): void; /** 请求错误事件 */
+  (e: 'error', err: Error, params: P[]): void; /** 请求完成事件 */
   (e: 'finally', params: P[], data?: D, err?: Error): void;
 };
+/**
+ * 远程请求实例类型
+ */
 type RemoteRequestInst = ComponentExposed<typeof _default>;
 //#endregion
 export { RemoteRequestEmits, RemoteRequestExpose, RemoteRequestFields, RemoteRequestInst, RemoteRequestProps };

package/dist/components/search-input/SearchInput.vue.d.ts

@@ -1,5 +1,5 @@
 import { SearchInputProps } from "./index.js";
-import * as vue49 from "vue";
+import * as vue36 from "vue";
 
 //#region src/components/search-input/SearchInput.vue.d.ts
 declare var __VLS_19: {}, __VLS_21: {}, __VLS_28: {
@@ -15,11 +15,11 @@ type __VLS_Slots = {} & {
 } & {
   'button-icon'?: (props: typeof __VLS_39) => any;
 };
-declare const __VLS_base: vue49.DefineComponent<SearchInputProps, {}, {}, {}, {}, vue49.ComponentOptionsMixin, vue49.ComponentOptionsMixin, {} & {
+declare const __VLS_base: vue36.DefineComponent<SearchInputProps, {}, {}, {}, {}, vue36.ComponentOptionsMixin, vue36.ComponentOptionsMixin, {} & {
   "update:value": (v: string | null | undefined) => any;
-}, string, vue49.PublicProps, Readonly<SearchInputProps> & Readonly<{
+}, string, vue36.PublicProps, Readonly<SearchInputProps> & Readonly<{
   "onUpdate:value"?: ((v: string | null | undefined) => any) | undefined;
-}>, {}, {}, {}, {}, string, vue49.ComponentProvideOptions, false, {}, any>;
+}>, {}, {}, {}, {}, string, vue36.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;
 type __VLS_WithSlots<T, S> = T & {

package/dist/components/search-input/index.d.ts

@@ -3,14 +3,17 @@ import { ClassStyle } from "../data-table-plus/index.js";
 import { ButtonProps, InputProps } from "naive-ui";
 
 //#region src/components/search-input/index.d.ts
+/**
+ * 搜索输入框属性
+ */
 type SearchInputProps = {
-  value?: string | null;
-  type?: ButtonProps['type'];
-  placeholder?: string;
-  loading?: boolean;
-  autoTrigger?: boolean | number;
-  searchButton?: 'text' | 'icon' | boolean;
-  inputProps?: InputProps & ClassStyle;
+  /** 值 */value?: string | null; /** 按钮类型 */
+  type?: ButtonProps['type']; /** 占位符 */
+  placeholder?: string; /** 是否加载中 */
+  loading?: boolean; /** 是否自动触发 */
+  autoTrigger?: boolean | number; /** 搜索按钮类型 */
+  searchButton?: 'text' | 'icon' | boolean; /** 输入框属性 */
+  inputProps?: InputProps & ClassStyle; /** 按钮属性 */
   buttonProps?: ButtonProps & ClassStyle;
 };
 //#endregion

package/dist/components/toggle-input/ToggleInput.vue.d.ts

@@ -1,5 +1,5 @@
 import { ClassStyle } from "../data-table-plus/index.js";
-import * as vue15 from "vue";
+import * as vue10 from "vue";
 import { InputProps } from "naive-ui";
 
 //#region src/components/toggle-input/ToggleInput.vue.d.ts
@@ -27,14 +27,14 @@ type __VLS_Slots = {} & {
 } & {
   default?: (props: typeof __VLS_13) => any;
 };
-declare const __VLS_base: vue15.DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, vue15.ComponentOptionsMixin, vue15.ComponentOptionsMixin, {
+declare const __VLS_base: vue10.DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, vue10.ComponentOptionsMixin, vue10.ComponentOptionsMixin, {
   "update:value": (value: string | number | undefined) => any;
 } & {
   trigger: () => any;
-}, string, vue15.PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+}, string, vue10.PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
   "onUpdate:value"?: ((value: string | number | undefined) => any) | undefined;
   onTrigger?: (() => any) | undefined;
-}>, {}, {}, {}, {}, string, vue15.ComponentProvideOptions, false, {}, any>;
+}>, {}, {}, {}, {}, string, vue10.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;
 type __VLS_WithSlots<T, S> = T & {

package/dist/components/tooltip-button/TooltipButton.vue.d.ts

@@ -1,5 +1,5 @@
 import { TooltipButtonProps } from "./index.js";
-import * as vue10 from "vue";
+import * as vue25 from "vue";
 
 //#region src/components/tooltip-button/TooltipButton.vue.d.ts
 declare var __VLS_17: {}, __VLS_20: {}, __VLS_22: {};
@@ -10,11 +10,11 @@ type __VLS_Slots = {} & {
 } & {
   tooltip?: (props: typeof __VLS_22) => any;
 };
-declare const __VLS_base: vue10.DefineComponent<TooltipButtonProps, {}, {}, {}, {}, vue10.ComponentOptionsMixin, vue10.ComponentOptionsMixin, {} & {
+declare const __VLS_base: vue25.DefineComponent<TooltipButtonProps, {}, {}, {}, {}, vue25.ComponentOptionsMixin, vue25.ComponentOptionsMixin, {} & {
   click: (ev: MouseEvent) => any;
-}, string, vue10.PublicProps, Readonly<TooltipButtonProps> & Readonly<{
+}, string, vue25.PublicProps, Readonly<TooltipButtonProps> & Readonly<{
   onClick?: ((ev: MouseEvent) => any) | undefined;
-}>, {}, {}, {}, {}, string, vue10.ComponentProvideOptions, false, {}, any>;
+}>, {}, {}, {}, {}, string, vue25.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;
 type __VLS_WithSlots<T, S> = T & {

package/dist/components/tooltip-button/index.d.ts

@@ -3,9 +3,12 @@ import { _default } from "./TooltipButton.vue.js";
 import { ButtonProps, TooltipProps } from "naive-ui";
 
 //#region src/components/tooltip-button/index.d.ts
+/**
+ * 提示按钮属性
+ */
 type TooltipButtonProps = {
-  tooltip?: string;
-  tooltipProps?: TooltipProps & ClassStyle;
+  /** 提示文本 */tooltip?: string; /** 提示框属性 */
+  tooltipProps?: TooltipProps & ClassStyle; /** 按钮属性 */
   buttonProps?: ButtonProps & ClassStyle;
 };
 //#endregion

package/dist/components/transition/BaseTransition.vue.d.ts

@@ -1,12 +1,12 @@
 import { TransitionProps as TransitionProps$1 } from "./index.js";
-import * as vue30 from "vue";
+import * as vue20 from "vue";
 
 //#region src/components/transition/BaseTransition.vue.d.ts
 declare var __VLS_7: {};
 type __VLS_Slots = {} & {
   default?: (props: typeof __VLS_7) => any;
 };
-declare const __VLS_base: vue30.DefineComponent<TransitionProps$1, {}, {}, {}, {}, vue30.ComponentOptionsMixin, vue30.ComponentOptionsMixin, {}, string, vue30.PublicProps, Readonly<TransitionProps$1> & Readonly<{}>, {}, {}, {}, {}, string, vue30.ComponentProvideOptions, false, {}, any>;
+declare const __VLS_base: vue20.DefineComponent<TransitionProps$1, {}, {}, {}, {}, vue20.ComponentOptionsMixin, vue20.ComponentOptionsMixin, {}, string, vue20.PublicProps, Readonly<TransitionProps$1> & Readonly<{}>, {}, {}, {}, {}, string, vue20.ComponentProvideOptions, false, {}, any>;
 declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
 declare const _default: typeof __VLS_export;
 type __VLS_WithSlots<T, S> = T & {

package/dist/components/transition/index.d.ts

@@ -3,8 +3,11 @@ import { _default } from "./BaseTransition.vue.js";
 import { TransitionProps } from "vue";
 
 //#region src/components/transition/index.d.ts
+/**
+ * 过渡动画属性
+ */
 type TransitionProps$1 = {
-  name?: string;
+  /** 过渡名称 */name?: string; /** 过渡属性 */
   transitionProps?: TransitionProps & ClassStyle;
 };
 //#endregion

package/dist/components.d.ts

@@ -5,7 +5,7 @@ import { SearchInputProps } from "./components/search-input/index.js";
 import { _default as _default$2 } from "./components/data-table-plus/DataTablePlus.vue.js";
 import { ClassStyle, DataTablePlusEmits, DataTablePlusExpose, DataTablePlusFields, DataTablePlusInst, DataTablePlusProps } from "./components/data-table-plus/index.js";
 import { _default as _default$3 } from "./components/loading-provider/LoadingProvider.vue.js";
-import { LoadingProviderInst, LoadingProviderProps, loadingProviderInjectionKey } from "./components/loading-provider/index.js";
+import { LOADING_PROVIDER_INJECTION_KEY, LoadingProviderInst, LoadingProviderProps } from "./components/loading-provider/index.js";
 import { UseNaiveFormRules } from "./composables/use-naive-form.js";
 import { _default } from "./components/config-providers/ConfigProviders.vue.js";
 import { ConfigProvidersProps } from "./components/config-providers/index.js";
@@ -24,8 +24,6 @@ import { _default as _default$11 } from "./components/tooltip-button/TooltipButt
 import { TooltipButtonProps } from "./components/tooltip-button/index.js";
 import { _default as _default$12 } from "./components/transition/BaseTransition.vue.js";
 import { TransitionProps } from "./components/transition/index.js";
-import { _default as _default$13 } from "./components/type-writer/TypeWriter.vue.js";
-import { TypeWriterProps } from "./components/type-writer/index.js";
 import "./components/index.js";
 import { ComponentAttrs, ComponentEmit, ComponentExposed, ComponentProps, ComponentSlots } from "vue-component-type-helpers";
-export { ArrayAwareType, ClassStyle, ComponentAttrs, ComponentEmit, ComponentExposed, ComponentProps, ComponentSlots, ConfigProvidersProps, CopyButtonProps, DataTablePlusEmits, DataTablePlusExpose, DataTablePlusFields, DataTablePlusInst, DataTablePlusProps, LoadingProviderInst, LoadingProviderProps, _default as NConfigProviders, _default$1 as NCopyButton, _default$2 as NDataTablePlus, _default$3 as NLoadingProvider, _default$4 as NPresetForm, _default$5 as NPresetInput, _default$6 as NPresetPicker, _default$7 as NPresetSelect, _default$8 as NRemoteRequest, _default$9 as NSearchInput, _default$10 as NToggleInput, _default$11 as NTooltipButton, _default$12 as NTransition, _default$13 as NTypeWriter, OptionFormat, PresetFormExpose, PresetFormInst, PresetFormOptionItem, PresetFormOptions, PresetFormProps, PresetInputOptions, PresetInputProps, PresetInputType, PresetPickerEmits, PresetPickerExpose, PresetPickerInst, PresetPickerProps, PresetPickerValue, PresetSelectEmits, PresetSelectExpose, PresetSelectFields, PresetSelectInst, PresetSelectProps, PresetSelectValue, RemoteRequestEmits, RemoteRequestExpose, RemoteRequestFields, RemoteRequestInst, RemoteRequestProps, SearchInputProps, TooltipButtonProps, TransitionProps, TypeWriterProps, UseNaiveFormRules, loadingProviderInjectionKey };
+export { ArrayAwareType, ClassStyle, ComponentAttrs, ComponentEmit, ComponentExposed, ComponentProps, ComponentSlots, ConfigProvidersProps, CopyButtonProps, DataTablePlusEmits, DataTablePlusExpose, DataTablePlusFields, DataTablePlusInst, DataTablePlusProps, LOADING_PROVIDER_INJECTION_KEY, LoadingProviderInst, LoadingProviderProps, _default as NConfigProviders, _default$1 as NCopyButton, _default$2 as NDataTablePlus, _default$3 as NLoadingProvider, _default$4 as NPresetForm, _default$5 as NPresetInput, _default$6 as NPresetPicker, _default$7 as NPresetSelect, _default$8 as NRemoteRequest, _default$9 as NSearchInput, _default$10 as NToggleInput, _default$11 as NTooltipButton, _default$12 as NTransition, OptionFormat, PresetFormExpose, PresetFormInst, PresetFormOptionItem, PresetFormOptions, PresetFormProps, PresetInputOptions, PresetInputProps, PresetInputType, PresetPickerEmits, PresetPickerExpose, PresetPickerInst, PresetPickerProps, PresetPickerValue, PresetSelectEmits, PresetSelectExpose, PresetSelectFields, PresetSelectInst, PresetSelectProps, PresetSelectValue, RemoteRequestEmits, RemoteRequestExpose, RemoteRequestFields, RemoteRequestInst, RemoteRequestProps, SearchInputProps, TooltipButtonProps, TransitionProps, UseNaiveFormRules };

package/dist/components.js

@@ -1,6 +1,6 @@
 import BaseTransition_default from "./components/transition/BaseTransition.js";
 import LoadingProvider_default from "./components/loading-provider/LoadingProvider.js";
-import { loadingProviderInjectionKey } from "./components/loading-provider/index.js";
+import { LOADING_PROVIDER_INJECTION_KEY } from "./components/loading-provider/index.js";
 import ConfigProviders_default from "./components/config-providers/ConfigProviders.js";
 import CopyButton_default from "./components/copy-button/CopyButton.js";
 import SearchInput_default from "./components/search-input/SearchInput.js";
@@ -12,7 +12,6 @@ import PresetSelect_default from "./components/preset-select/PresetSelect.js";
 import RemoteRequest_default from "./components/remote-request/RemoteRequest.js";
 import ToggleInput_default from "./components/toggle-input/ToggleInput.js";
 import TooltipButton_default from "./components/tooltip-button/TooltipButton.js";
-import TypeWriter_default from "./components/type-writer/TypeWriter.js";
 import { ComponentAttrs, ComponentEmit, ComponentExposed, ComponentProps, ComponentSlots } from "vue-component-type-helpers";
 
-export { ComponentAttrs, ComponentEmit, ComponentExposed, ComponentProps, ComponentSlots, ConfigProviders_default as NConfigProviders, CopyButton_default as NCopyButton, DataTablePlus_default as NDataTablePlus, LoadingProvider_default as NLoadingProvider, PresetForm_default as NPresetForm, PresetInput_default as NPresetInput, PresetPicker_default as NPresetPicker, PresetSelect_default as NPresetSelect, RemoteRequest_default as NRemoteRequest, SearchInput_default as NSearchInput, ToggleInput_default as NToggleInput, TooltipButton_default as NTooltipButton, BaseTransition_default as NTransition, TypeWriter_default as NTypeWriter, loadingProviderInjectionKey };
+export { ComponentAttrs, ComponentEmit, ComponentExposed, ComponentProps, ComponentSlots, LOADING_PROVIDER_INJECTION_KEY, ConfigProviders_default as NConfigProviders, CopyButton_default as NCopyButton, DataTablePlus_default as NDataTablePlus, LoadingProvider_default as NLoadingProvider, PresetForm_default as NPresetForm, PresetInput_default as NPresetInput, PresetPicker_default as NPresetPicker, PresetSelect_default as NPresetSelect, RemoteRequest_default as NRemoteRequest, SearchInput_default as NSearchInput, ToggleInput_default as NToggleInput, TooltipButton_default as NTooltipButton, BaseTransition_default as NTransition };

package/dist/composables/_helper.d.ts

@@ -1,9 +1,12 @@
 //#region src/composables/_helper.d.ts
+/**
+ * 颜色配置类型，用于定义主题的基础颜色
+ */
 type Colors = {
-  primary?: string;
-  info?: string;
-  success?: string;
-  warning?: string;
+  /** 主色 */primary?: string; /** 信息色 */
+  info?: string; /** 成功色 */
+  success?: string; /** 警告色 */
+  warning?: string; /** 错误色 */
   error?: string;
 };
 //#endregion

package/dist/composables/_helper.js

@@ -1,12 +1,34 @@
 import { colord } from "colord";
 
 //#region src/composables/_helper.ts
+/**
+* 获取变亮的颜色
+* @param color - 原始颜色值
+* @returns 变亮后的颜色值，如果输入无效则返回 undefined
+* @example
+* ```ts
+* const darkColor = getDarkColor('#1890ff')
+* // 返回变亮后的颜色值
+* ```
+*/
 function getDarkColor(color) {
 	if (!color) return void 0;
 	const colorInst = colord(color);
 	if (!colorInst.isValid()) return void 0;
 	return colorInst.lighten(.1).toHex();
 }
+/**
+* 获取一组变亮的颜色
+* @param colors - 颜色配置对象
+* @returns 包含变亮后颜色的对象
+* @example
+* ```ts
+* const darkColors = getDarkColors({
+*   primary: '#1890ff',
+*   success: '#52c41a'
+* })
+* ```
+*/
 function getDarkColors(colors) {
 	return {
 		primary: getDarkColor(colors.primary),
@@ -16,6 +38,16 @@ function getDarkColors(colors) {
 		error: getDarkColor(colors.error)
 	};
 }
+/**
+* 获取状态颜色对象，包含基础颜色和交互状态颜色
+* @param color - 原始颜色值
+* @returns 状态颜色对象，如果输入无效则返回 undefined
+* @example
+* ```ts
+* const statusColor = getStatusColor('#1890ff')
+* // 返回 { color: '#1890ff', hover: '...', pressed: '...', suppl: '...' }
+* ```
+*/
 function getStatusColor(color) {
 	if (!color) return void 0;
 	const colorInst = colord(color);
@@ -27,6 +59,21 @@ function getStatusColor(color) {
 		suppl: colorInst.lighten(.1).toHex()
 	};
 }
+/**
+* 获取一组状态颜色
+* @param colors - 颜色配置对象
+* @returns 包含各状态颜色的对象
+* @example
+* ```ts
+* const colors = getColors({
+*   primary: '#1890ff',
+*   info: '#1890ff',
+*   success: '#52c41a',
+*   warning: '#faad14',
+*   error: '#f5222d'
+* })
+* ```
+*/
 function getColors(colors) {
 	const { primary, info, success, warning, error } = colors ?? {};
 	return {

package/dist/composables/index.d.ts

@@ -1,5 +1,5 @@
 import { DataObject, DataRequestFields, UseDataRequestOptions, UseDataRequestPagination, UseDataRequestReturns, useDataRequest } from "./use-data-request.js";
 import { useLoading } from "./use-loading.js";
 import { UseNaiveFormClearRules, UseNaiveFormOptions, UseNaiveFormReturns, UseNaiveFormRules, useNaiveForm } from "./use-naive-form.js";
-import { UseNaiveMenuOptions, UseNaiveMenuReturn, useNaiveMenu } from "./use-naive-menu.js";
+import { UseNaiveMenuOptions, UseNaiveMenuReturn, flattenDeep, useNaiveMenu } from "./use-naive-menu.js";
 import { UseNaiveThemeOptions, UseNaiveThemeReturns, useNaiveTheme } from "./use-naive-theme.js";

package/dist/composables/use-data-request.d.ts

@@ -46,13 +46,20 @@ type UseDataRequestPagination = {
  * @param api 请求 API 函数
  * @param options 配置选项
  * @returns 数据请求操作对象
+ * @example
+ * ```ts
+ * const { loading, data, list, pagination, run, refresh } = useDataRequest(api, {
+ *   defaultParams: { page: 1, pageSize: 10 },
+ *   fields: { page: 'page', pageSize: 'size', list: 'data', count: 'total' }
+ * })
+ * ```
  */
 declare function useDataRequest<P extends DataObject = DataObject, D extends DataObject = DataObject, R extends DataObject = DataObject>(api: (...args: P[]) => Promise<D>, options?: UseDataRequestOptions<P, D>): {
-  /** 加载状态 */loading: Readonly<vue0.Ref<boolean, boolean>>; /** 响应数据 */
-  data: Readonly<vue0.Ref<D | undefined, D | undefined>>; /** 错误信息 */
-  error: Readonly<vue0.Ref<Error | undefined, Error | undefined>>; /** 请求参数 */
-  params: Readonly<vue0.Ref<P[] | [], P[] | []>>; /** 列表数据 */
-  list: vue0.ComputedRef<R[]>; /** 分页信息 */
+  loading: Readonly<vue0.Ref<boolean, boolean>>;
+  data: Readonly<vue0.Ref<D | undefined, D | undefined>>;
+  error: Readonly<vue0.Ref<Error | undefined, Error | undefined>>;
+  params: Readonly<vue0.Ref<[] | P[], [] | P[]>>;
+  list: vue0.ComputedRef<R[]>;
   pagination: vue0.Ref<{
     page: number;
     pageSize: number;
@@ -61,19 +68,19 @@ declare function useDataRequest<P extends DataObject = DataObject, D extends Dat
     page: number;
     pageSize: number;
     itemCount: number;
-  }>; /** 运行请求 */
-  run: (...params: P[]) => void; /** 异步运行请求 */
-  runAsync: (...params: P[]) => Promise<D>; /** 刷新请求 */
-  refresh: () => void; /** 异步刷新请求 */
-  refreshAsync: () => Promise<D>; /** 取消请求 */
-  cancel: () => void; /** 修改响应数据 */
-  mutate: (data?: D | ((oldData?: D | undefined) => D | undefined) | undefined) => void; /** 设置请求参数 */
-  setParams: (_params: Partial<P>) => void; /** 设置参数并运行请求 */
-  runParams: (_params: Partial<P>) => void; /** 设置参数并异步运行请求 */
-  runParamsAsync: (_params: Partial<P>) => Promise<D>; /** 请求前事件 */
-  onBefore: _vueuse_core0.EventHookOn<[P[]]>; /** 请求成功事件 */
-  onSuccess: _vueuse_core0.EventHookOn<[D, P[]]>; /** 请求错误事件 */
-  onError: _vueuse_core0.EventHookOn<[Error, P[]]>; /** 请求完成事件 */
+  }>;
+  run: (...params: P[]) => void;
+  runAsync: (...params: P[]) => Promise<D>;
+  refresh: () => void;
+  refreshAsync: () => Promise<D>;
+  cancel: () => void;
+  mutate: (data?: D | ((oldData?: D | undefined) => D | undefined) | undefined) => void;
+  setParams: (_params: Partial<P>) => void;
+  runParams: (_params: Partial<P>) => void;
+  runParamsAsync: (_params: Partial<P>) => Promise<D>;
+  onBefore: _vueuse_core0.EventHookOn<[P[]]>;
+  onSuccess: _vueuse_core0.EventHookOn<[D, P[]]>;
+  onError: _vueuse_core0.EventHookOn<[Error, P[]]>;
   onFinally: _vueuse_core0.EventHookOn<[P[], D | undefined, Error | undefined]>;
 };
 /**

package/dist/composables/use-data-request.js

@@ -11,6 +11,13 @@ import useRequest from "vue-hooks-plus/es/useRequest";
 * @param api 请求 API 函数
 * @param options 配置选项
 * @returns 数据请求操作对象
+* @example
+* ```ts
+* const { loading, data, list, pagination, run, refresh } = useDataRequest(api, {
+*   defaultParams: { page: 1, pageSize: 10 },
+*   fields: { page: 'page', pageSize: 'size', list: 'data', count: 'total' }
+* })
+* ```
 */
 function useDataRequest(api, options) {
 	const { defaultParams, manual, fields, requestOptions, requestPlugins } = options ?? {};
@@ -70,15 +77,23 @@ function useDataRequest(api, options) {
 	const list = computed(() => data.value?.[_fields.list] ?? []);
 	/**
 	* 设置请求参数
-	* @param _params 要设置的参数
+	* @param _params - 要设置的参数
+	* @example
+	* ```ts
+	* setParams({ page: 2 })
+	* ```
 	*/
 	function setParams(_params) {
 		Object.assign(params.value?.[0], _params);
 	}
 	/**
 	* 设置参数并运行请求
-	* @param _params 要设置的参数
+	* @param _params - 要设置的参数
 	* @returns 请求结果
+	* @example
+	* ```ts
+	* runParams({ page: 2 })
+	* ```
 	*/
 	function runParams(_params) {
 		return run({
@@ -88,8 +103,12 @@ function useDataRequest(api, options) {
 	}
 	/**
 	* 设置参数并异步运行请求
-	* @param _params 要设置的参数
+	* @param _params - 要设置的参数
 	* @returns 请求结果 Promise
+	* @example
+	* ```ts
+	* await runParamsAsync({ page: 2 })
+	* ```
 	*/
 	function runParamsAsync(_params) {
 		return runAsync({

package/dist/composables/use-loading.d.ts

@@ -4,6 +4,12 @@ import { LoadingProviderInst } from "../components/loading-provider/index.js";
 /**
  * 用于获取 Naive UI 加载状态提供者的组合式 API
  * @returns 加载状态提供者实例
+ * @example
+ * ```ts
+ * const loading = useLoading()
+ * loading?.start()
+ * loading?.finish()
+ * ```
  */
 declare function useLoading(): LoadingProviderInst | undefined;
 //#endregion

package/dist/composables/use-loading.js

@@ -1,4 +1,4 @@
-import { loadingProviderInjectionKey } from "../components/loading-provider/index.js";
+import { LOADING_PROVIDER_INJECTION_KEY } from "../components/loading-provider/index.js";
 import { inject } from "vue";
 
 //#region src/composables/use-loading.ts
@@ -9,9 +9,15 @@ import { inject } from "vue";
 /**
 * 用于获取 Naive UI 加载状态提供者的组合式 API
 * @returns 加载状态提供者实例
+* @example
+* ```ts
+* const loading = useLoading()
+* loading?.start()
+* loading?.finish()
+* ```
 */
 function useLoading() {
-	return inject(loadingProviderInjectionKey);
+	return inject(LOADING_PROVIDER_INJECTION_KEY);
 }
 
 //#endregion

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

@@ -1,6 +1,6 @@
 import { DataObject } from "./use-data-request.js";
 import * as _vueuse_core3 from "@vueuse/core";
-import * as vue7 from "vue";
+import * as vue5 from "vue";
 import { MaybeRefOrGetter, Ref, TemplateRef } from "vue";
 import { FormInst, FormItemRule, FormRules } from "naive-ui";
 import { ValidateError } from "async-validator";
@@ -35,23 +35,31 @@ type UseNaiveFormOptions<T extends DataObject> = {
  * @param formInstRef 表单实例引用
  * @param options 配置选项
  * @returns 表单操作对象
+ * @example
+ * ```ts
+ * const formRef = ref<FormInst>()
+ * const { formValue, formRules, formProps, validate, reset, clear } = useNaiveForm(formRef, {
+ *   value: { name: '', age: 0 },
+ *   rules: { name: { required: true, message: '请输入姓名' } }
+ * })
+ * ```
  */
 declare function useNaiveForm<T extends DataObject = DataObject>(formInstRef: TemplateRef<FormInst>, options?: UseNaiveFormOptions<T>): {
-  /** 表单实例引用 */formInst: Readonly<vue7.ShallowRef<FormInst | null>>; /** 表单值引用 */
-  formValue: Ref<T, T>; /** 表单规则引用 */
-  formRules: Ref<Partial<Record<keyof T, FormRules | FormItemRule | FormItemRule[]>>, Partial<Record<keyof T, FormRules | FormItemRule | FormItemRule[]>>>; /** 表单属性，用于绑定到表单组件 */
+  formInst: Readonly<vue5.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: vue7.Reactive<T>;
-    rules: vue7.Reactive<Partial<Record<keyof T, FormRules | FormItemRule | FormItemRule[]>>>;
-  }; /** 设置表单值 */
-  setValue: (_value: Partial<T>) => void; /** 验证表单 */
+    model: vue5.Reactive<T>;
+    rules: vue5.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; /** 验证成功事件 */
+  }>;
+  resetValidation: () => void;
+  resetForm: () => void;
+  reset: () => void;
+  clear: () => void;
   onValidated: _vueuse_core3.EventHookOn<[T]>;
 };
 /**