@hairy/vue-lib 1.47.0 → 1.49.0

package/dist/index.d.cts

@@ -0,0 +1,184 @@
+import * as vue from "vue";
+import { ComputedRef, Ref, UnwrapRef, WatchOptions } from "vue";
+import { Component, DefineComponent, FunctionalComponent, PropType, VNode } from "vue-demi";
+import { MaybeElementRef, MaybeRef, UseOffsetPaginationOptions, UseOffsetPaginationReturn } from "@vueuse/core";
+import { Noop } from "@hairy/utils";
+import { DebouncedFunc } from "lodash";
+
+//#region src/components/c-field.d.ts
+declare const Field: vue.DefineComponent<vue.ExtractPropTypes<{
+  is: {
+    type: PropType<string | number | VNode | Component>;
+    default: string;
+  };
+}>, () => string | number | VNode<vue.RendererNode, vue.RendererElement, {
+  [key: string]: any;
+}> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+  is: {
+    type: PropType<string | number | VNode | Component>;
+    default: string;
+  };
+}>> & Readonly<{}>, {
+  is: string | number | VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+  }> | Component;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+//#endregion
+//#region src/components/collapse-transition.d.ts
+declare const CollapseTransition: DefineComponent;
+//#endregion
+//#region src/hooks/syncElementScroll/index.d.ts
+interface SyncElementSyncScrollOptions {
+  left?: boolean;
+  top?: boolean;
+  wait?: number;
+  immediate?: boolean;
+}
+/**
+ * Synchronize scrolling between two DOM with the same scrollbar
+ * @param fromTarget DOM-A
+ * @param toTarget DOM-B
+ * @param options
+ * @todo optimizes the reuse of useEventListener
+ * @todo may have bugs when using wait
+ */
+declare function syncElementSyncScroll(fromTarget: MaybeRef<EventTarget | null | undefined>, toTarget: MaybeRef<EventTarget | null | undefined>, options?: SyncElementSyncScrollOptions): {
+  stop: () => void;
+  start: () => void;
+  syncFromTo: () => void;
+  syncToFrom: () => void;
+};
+//#endregion
+//#region src/hooks/syncElementSize/index.d.ts
+interface SyncElementSizeOptions extends WatchOptions {
+  /** Is the width enabled @default true */
+  width?: boolean;
+  /** Is the height enabled @default true */
+  height?: boolean;
+}
+interface SyncElementSizeReturn {
+  start?: Noop;
+  stop?: Noop;
+}
+/**
+ * Synchronize the width or height of from DOM to the specified to DOM
+ * @param fromTarget width and height source element
+ * @param toTarget width and height setting elements
+ * @param options
+ */
+declare function syncElementSize(fromTarget: MaybeElementRef, toTarget: MaybeElementRef, options?: SyncElementSizeOptions): SyncElementSizeReturn;
+//#endregion
+//#region src/hooks/useChecked/index.d.ts
+type CheckedState = string | boolean | number | symbol;
+/**
+ * Get the status of checked and customize the value of checked | unchecked
+ * @param target
+ * @param checked
+ * @param unchecked
+ */
+declare function useChecked(target: Ref<any>, checked?: MaybeRef<CheckedState>, unchecked?: MaybeRef<CheckedState>): vue.WritableComputedRef<boolean, boolean>;
+//#endregion
+//#region src/hooks/usePaginationServer/index.d.ts
+type UseServerPaginationResolve = UnwrapRef<Pick<UseOffsetPaginationReturn, 'currentPage' | 'currentPageSize'> & {
+  total: number;
+}>;
+type UseServerPagination = UnwrapRef<Omit<UseOffsetPaginationReturn, 'next' | 'prev'> & {
+  total: Ref<number>;
+}>;
+interface UseServerPaginationOptions<T> extends UseOffsetPaginationOptions, WatchOptions {
+  resolve: (pagination: UseServerPaginationResolve) => T | Promise<T>;
+  /** Monitor the source, trigger reset when the source data changes, default to monitoring page generation */
+  sources?: any[];
+}
+interface UseServerPaginationReturn<T> {
+  state: Ref<T>;
+  loading: Ref<boolean>;
+  error: Ref<any>;
+  pagination: UseServerPagination;
+  next: () => void;
+  prev: () => void;
+  execute: DebouncedFunc<() => Promise<void>>;
+}
+declare function useServerPagination<T extends any[]>(options: UseServerPaginationOptions<T>): UseServerPaginationReturn<T>;
+//#endregion
+//#region src/hooks/useSelectedMultiple/index.d.ts
+type SelectedMultipleArray = MaybeRef<{
+  [key: string]: any;
+}[]>;
+interface SelectedMultipleOptions<T extends SelectedMultipleArray> {
+  /**
+   * Select Field
+   *
+   * @default 'select'
+   */
+  fieldName?: string;
+  /**
+   * Processing disabled, takes effect when isSelectAll is changed
+   */
+  disabled?: (item: UnwrapRef<T>[number], index: number) => boolean | void;
+}
+interface SelectedMultipleResult<T extends SelectedMultipleArray> {
+  /**
+   * All currently selected items
+   */
+  selected: ComputedRef<UnwrapRef<T>>;
+  /**
+   * Is it currently all selected, Changing it will affect the selection of the list
+   */
+  isSelectedAll: Ref<boolean>;
+  /**
+   * Whether to choose
+   */
+  isSelected: ComputedRef<boolean>;
+  /**
+   * Selected, but not fully selected (usually used for checkbox components)
+   */
+  isIndeterminate: ComputedRef<boolean>;
+}
+declare function useSelectedMultiple<T extends SelectedMultipleArray>(array: T, options?: SelectedMultipleOptions<T>): SelectedMultipleResult<T>;
+//#endregion
+//#region src/hooks/useSelectedSingle/index.d.ts
+type SelectedSingleArray = MaybeRef<{
+  [key: string]: any;
+}[]>;
+interface SelectedSingleOptions {
+  /**
+   * Select Field
+   *
+   * @default 'select'
+   */
+  fieldName?: string;
+  /**
+   * Is it mandatory, What is the mandatory option
+   * @default false
+   *
+   */
+  required?: true | number;
+}
+interface SelectedSingleResult<T extends SelectedSingleArray> {
+  /**
+   * 当前选中项
+   */
+  selected: ComputedRef<UnwrapRef<T>[number] | undefined>;
+  /**
+   * 是否已经选择
+   */
+  isSelected: ComputedRef<boolean>;
+}
+declare function useSelectedSingle<T extends SelectedSingleArray>(array: T, options?: SelectedSingleOptions): SelectedSingleResult<T>;
+//#endregion
+//#region src/utils/index.d.ts
+/**
+ * Directly render the incoming function components
+ * @param component
+ * @param tag Rendering container (default div)
+ */
+declare function ehr<K extends keyof HTMLElementTagNameMap = 'div'>(component: FunctionalComponent, tag?: K): HTMLElementTagNameMap[K];
+/**
+ * Convert the properties of an object to ref
+ * @param data
+ * @param prop
+ */
+declare function propertyToRef<T>(data: T, prop: keyof T): vue.WritableComputedRef<T[keyof T], T[keyof T]>;
+//#endregion
+export { CheckedState, CollapseTransition, Field, SelectedMultipleArray, SelectedMultipleOptions, SelectedMultipleResult, SelectedSingleArray, SelectedSingleOptions, SelectedSingleResult, SyncElementSizeOptions, SyncElementSizeReturn, UseServerPagination, UseServerPaginationOptions, UseServerPaginationResolve, UseServerPaginationReturn, ehr, propertyToRef, syncElementSize, syncElementSyncScroll, useChecked, useSelectedMultiple, useSelectedSingle, useServerPagination };

package/dist/index.d.mts

@@ -0,0 +1,184 @@
+import { Component, DefineComponent, FunctionalComponent, PropType, VNode } from "vue-demi";
+import { MaybeElementRef, MaybeRef, UseOffsetPaginationOptions, UseOffsetPaginationReturn } from "@vueuse/core";
+import * as vue from "vue";
+import { ComputedRef, Ref, UnwrapRef, WatchOptions } from "vue";
+import { Noop } from "@hairy/utils";
+import { DebouncedFunc } from "lodash";
+
+//#region src/components/c-field.d.ts
+declare const Field: vue.DefineComponent<vue.ExtractPropTypes<{
+  is: {
+    type: PropType<string | number | VNode | Component>;
+    default: string;
+  };
+}>, () => string | number | VNode<vue.RendererNode, vue.RendererElement, {
+  [key: string]: any;
+}> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+  is: {
+    type: PropType<string | number | VNode | Component>;
+    default: string;
+  };
+}>> & Readonly<{}>, {
+  is: string | number | VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+  }> | Component;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+//#endregion
+//#region src/components/collapse-transition.d.ts
+declare const CollapseTransition: DefineComponent;
+//#endregion
+//#region src/hooks/syncElementScroll/index.d.ts
+interface SyncElementSyncScrollOptions {
+  left?: boolean;
+  top?: boolean;
+  wait?: number;
+  immediate?: boolean;
+}
+/**
+ * Synchronize scrolling between two DOM with the same scrollbar
+ * @param fromTarget DOM-A
+ * @param toTarget DOM-B
+ * @param options
+ * @todo optimizes the reuse of useEventListener
+ * @todo may have bugs when using wait
+ */
+declare function syncElementSyncScroll(fromTarget: MaybeRef<EventTarget | null | undefined>, toTarget: MaybeRef<EventTarget | null | undefined>, options?: SyncElementSyncScrollOptions): {
+  stop: () => void;
+  start: () => void;
+  syncFromTo: () => void;
+  syncToFrom: () => void;
+};
+//#endregion
+//#region src/hooks/syncElementSize/index.d.ts
+interface SyncElementSizeOptions extends WatchOptions {
+  /** Is the width enabled @default true */
+  width?: boolean;
+  /** Is the height enabled @default true */
+  height?: boolean;
+}
+interface SyncElementSizeReturn {
+  start?: Noop;
+  stop?: Noop;
+}
+/**
+ * Synchronize the width or height of from DOM to the specified to DOM
+ * @param fromTarget width and height source element
+ * @param toTarget width and height setting elements
+ * @param options
+ */
+declare function syncElementSize(fromTarget: MaybeElementRef, toTarget: MaybeElementRef, options?: SyncElementSizeOptions): SyncElementSizeReturn;
+//#endregion
+//#region src/hooks/useChecked/index.d.ts
+type CheckedState = string | boolean | number | symbol;
+/**
+ * Get the status of checked and customize the value of checked | unchecked
+ * @param target
+ * @param checked
+ * @param unchecked
+ */
+declare function useChecked(target: Ref<any>, checked?: MaybeRef<CheckedState>, unchecked?: MaybeRef<CheckedState>): vue.WritableComputedRef<boolean, boolean>;
+//#endregion
+//#region src/hooks/usePaginationServer/index.d.ts
+type UseServerPaginationResolve = UnwrapRef<Pick<UseOffsetPaginationReturn, 'currentPage' | 'currentPageSize'> & {
+  total: number;
+}>;
+type UseServerPagination = UnwrapRef<Omit<UseOffsetPaginationReturn, 'next' | 'prev'> & {
+  total: Ref<number>;
+}>;
+interface UseServerPaginationOptions<T> extends UseOffsetPaginationOptions, WatchOptions {
+  resolve: (pagination: UseServerPaginationResolve) => T | Promise<T>;
+  /** Monitor the source, trigger reset when the source data changes, default to monitoring page generation */
+  sources?: any[];
+}
+interface UseServerPaginationReturn<T> {
+  state: Ref<T>;
+  loading: Ref<boolean>;
+  error: Ref<any>;
+  pagination: UseServerPagination;
+  next: () => void;
+  prev: () => void;
+  execute: DebouncedFunc<() => Promise<void>>;
+}
+declare function useServerPagination<T extends any[]>(options: UseServerPaginationOptions<T>): UseServerPaginationReturn<T>;
+//#endregion
+//#region src/hooks/useSelectedMultiple/index.d.ts
+type SelectedMultipleArray = MaybeRef<{
+  [key: string]: any;
+}[]>;
+interface SelectedMultipleOptions<T extends SelectedMultipleArray> {
+  /**
+   * Select Field
+   *
+   * @default 'select'
+   */
+  fieldName?: string;
+  /**
+   * Processing disabled, takes effect when isSelectAll is changed
+   */
+  disabled?: (item: UnwrapRef<T>[number], index: number) => boolean | void;
+}
+interface SelectedMultipleResult<T extends SelectedMultipleArray> {
+  /**
+   * All currently selected items
+   */
+  selected: ComputedRef<UnwrapRef<T>>;
+  /**
+   * Is it currently all selected, Changing it will affect the selection of the list
+   */
+  isSelectedAll: Ref<boolean>;
+  /**
+   * Whether to choose
+   */
+  isSelected: ComputedRef<boolean>;
+  /**
+   * Selected, but not fully selected (usually used for checkbox components)
+   */
+  isIndeterminate: ComputedRef<boolean>;
+}
+declare function useSelectedMultiple<T extends SelectedMultipleArray>(array: T, options?: SelectedMultipleOptions<T>): SelectedMultipleResult<T>;
+//#endregion
+//#region src/hooks/useSelectedSingle/index.d.ts
+type SelectedSingleArray = MaybeRef<{
+  [key: string]: any;
+}[]>;
+interface SelectedSingleOptions {
+  /**
+   * Select Field
+   *
+   * @default 'select'
+   */
+  fieldName?: string;
+  /**
+   * Is it mandatory, What is the mandatory option
+   * @default false
+   *
+   */
+  required?: true | number;
+}
+interface SelectedSingleResult<T extends SelectedSingleArray> {
+  /**
+   * 当前选中项
+   */
+  selected: ComputedRef<UnwrapRef<T>[number] | undefined>;
+  /**
+   * 是否已经选择
+   */
+  isSelected: ComputedRef<boolean>;
+}
+declare function useSelectedSingle<T extends SelectedSingleArray>(array: T, options?: SelectedSingleOptions): SelectedSingleResult<T>;
+//#endregion
+//#region src/utils/index.d.ts
+/**
+ * Directly render the incoming function components
+ * @param component
+ * @param tag Rendering container (default div)
+ */
+declare function ehr<K extends keyof HTMLElementTagNameMap = 'div'>(component: FunctionalComponent, tag?: K): HTMLElementTagNameMap[K];
+/**
+ * Convert the properties of an object to ref
+ * @param data
+ * @param prop
+ */
+declare function propertyToRef<T>(data: T, prop: keyof T): vue.WritableComputedRef<T[keyof T], T[keyof T]>;
+//#endregion
+export { CheckedState, CollapseTransition, Field, SelectedMultipleArray, SelectedMultipleOptions, SelectedMultipleResult, SelectedSingleArray, SelectedSingleOptions, SelectedSingleResult, SyncElementSizeOptions, SyncElementSizeReturn, UseServerPagination, UseServerPaginationOptions, UseServerPaginationResolve, UseServerPaginationReturn, ehr, propertyToRef, syncElementSize, syncElementSyncScroll, useChecked, useSelectedMultiple, useSelectedSingle, useServerPagination };