@vef-framework/hooks 1.0.135 → 2.0.1

package/types/use-fallback-options.d.ts

@@ -1,34 +0,0 @@
-import type { Api, DataOption, EmptyObject, IdValue, Mapper, MaybePromise, ObjectType, PureDataOption, QueryParamsWithValues } from "@vef-framework/shared";
-/**
- * The config of the use fallback options hook.
- */
-export interface UseFallbackOptionsConfig<T extends DataOption<T> = PureDataOption, P extends ObjectType = EmptyObject, K extends string = "ids"> {
-    /**
-     * The API of fallback options.
-     */
-    fallbackOptionsApi?: Api<QueryParamsWithValues<P, K>, T[]>;
-    /**
-     * The API params of fallback options.
-     */
-    fallbackOptionsApiParams?: P;
-    /**
-     * The parameter name of values.
-     */
-    valuesKey?: K;
-    /**
-     * The function to resolve fallback options.
-     */
-    resolveFallbackOptions?: Mapper<IdValue[], MaybePromise<T[]>>;
-}
-/**
- * The hook to resolve fallback options.
- *
- * @param missingOptionValues - The missing option values.
- * @param config - The config of the hook.
- * @param config.fallbackOptionsApi - The API of fallback options.
- * @param config.fallbackOptionsApiParams - The API params of fallback options.
- * @param config.valuesKey - The parameter key of values.
- * @param config.resolveFallbackOptions - The function to resolve fallback options.
- * @returns The API query result.
- */
-export declare function useFallbackOptions<T extends DataOption<T> = PureDataOption, P extends ObjectType = EmptyObject, K extends string = "ids">(missingOptionValues: IdValue[], { fallbackOptionsApi, fallbackOptionsApiParams, valuesKey, resolveFallbackOptions, }: UseFallbackOptionsConfig<T, P, K>): import("@vef-framework/shared").QueryResult<T[]>;

package/types/use-gap-size-normalizer.d.ts

@@ -1,8 +0,0 @@
-import type { GapSize } from "@vef-framework/shared";
-import type { CSSProperties } from "react";
-/**
- * The hook to normalize the gap size.
- *
- * @returns The function to normalize the gap size.
- */
-export declare function useGapSizeNormalizer<T extends CSSProperties["gap"]>(): (gap: GapSize<T>) => number | (T & Record<never, never>);

package/types/use-normalized-gap-size.d.ts

@@ -1,9 +0,0 @@
-import type { GapSize } from "@vef-framework/shared";
-import type { CSSProperties } from "react";
-/**
- * The hook to normalize the gap size.
- *
- * @param gap - The gap size.
- * @returns The normalized gap size.
- */
-export declare function useNormalizedGapSize<T extends CSSProperties["gap"]>(gap: GapSize<T>): number | (T & Record<never, never>);

package/types/use-normalized-menu-items.d.ts

@@ -1,16 +0,0 @@
-import type { MenuItem } from "@vef-framework/shared";
-import type { ItemType } from "antd/es/menu/interface";
-/**
- * Normalize the menu item to the type of antd.
- *
- * @param item - The menu item.
- * @returns The normalized menu item.
- */
-export declare function normalizeMenuItem(item: MenuItem): ItemType;
-/**
- * Normalize the menu items to the type of antd.
- *
- * @param items - The menu items.
- * @returns The normalized menu items.
- */
-export declare function useNormalizedMenuItems<T extends readonly MenuItem[] = readonly MenuItem[]>(items: T): ItemType[];

package/types/use-normalized-options.d.ts

@@ -1,33 +0,0 @@
-import type { DataOption, DataOptionConfig, Except, IdValue, NormalizedDataOption, PureDataOption, StringKey } from "@vef-framework/shared";
-/**
- * The config of the useNormalizedDataOptions hook.
- */
-export interface UseNormalizedDataOptionsConfig {
-    /**
-     * Whether the options is a tree.
-     */
-    isTree?: boolean;
-    /**
-     * Whether the options are grouped.
-     */
-    isGrouped?: boolean;
-    /**
-     * Whether to parse the pinyin of the options's label and description.
-     */
-    parsePinyin?: boolean;
-    /**
-     * The values of the selected options used to find the missing options.
-     */
-    selectedOptionValues?: IdValue[];
-}
-/**
- * The return type of the useNormalizedDataOptions hook.
- */
-type UseNormalizedDataOptionsReturn<T extends DataOption<T>, F extends boolean> = F extends true ? [Array<NormalizedDataOption<T>>, IdValue[], NormalizedDataOption<T> | undefined] : [Array<NormalizedDataOption<T>>, IdValue[]];
-/**
- * The hook to normalize the data options.
- */
-export declare function useNormalizedDataOptions<T extends DataOption<T> = PureDataOption, F extends boolean = false>(options: T[], { labelKey, valueKey, childrenKey, descriptionKey, disabledKey, defaultToFirst, }: Except<DataOptionConfig<StringKey<T>>, "defaultToFirst"> & {
-    defaultToFirst?: F;
-}, { isTree, isGrouped, parsePinyin, selectedOptionValues, }?: UseNormalizedDataOptionsConfig): UseNormalizedDataOptionsReturn<T, F>;
-export {};

package/types/use-option-filter.d.ts

@@ -1,8 +0,0 @@
-import type { DataOption, NormalizedDataOption, PureDataOption } from "@vef-framework/shared";
-/**
- * The hook to filter the options.
- *
- * @param filterable - Whether to allow filtering.
- * @param filterFromRemote - Whether to filter from remote.
- */
-export declare function useOptionFilter<T extends DataOption<T> = PureDataOption>(filterable: boolean, filterFromRemote: boolean): false | ((filterValue: string, option: NormalizedDataOption<T>) => boolean) | undefined;

package/types/use-remote-filter.d.ts

@@ -1,9 +0,0 @@
-import type { EmptyObject, ObjectType, QueryParamsWithKeyword } from "@vef-framework/shared";
-/**
- * The hook to handle the remote filter.
- *
- * @param enabled - Whether to enable the remote filter.
- * @param apiParams - The API params.
- * @param keywordKey - The key of the keyword parameter.
- */
-export declare function useRemoteFilter<P extends ObjectType = EmptyObject, K extends string = "keyword">(enabled: boolean, apiParams?: QueryParamsWithKeyword<P, K>, keywordKey?: K): readonly [QueryParamsWithKeyword<P, K> | undefined, import("radashi").DebounceFunction<[keyword: string]> | undefined];

package/types/use-shallow-callback.d.ts

@@ -1,10 +0,0 @@
-import type { AnyFunction } from "@vef-framework/shared";
-import type { DependencyList } from "react";
-/**
- * The hook to memoize a callback based on shallow comparison of dependencies.
- *
- * @param callback - The callback to be memoized.
- * @param dependencies - The dependencies array.
- * @returns The memoized callback.
- */
-export declare function useShallowCallback<T extends AnyFunction>(callback: T, dependencies: DependencyList): T;

package/types/use-shallow-memo.d.ts

@@ -1,10 +0,0 @@
-import type { Provider } from "@vef-framework/shared";
-import type { DependencyList } from "react";
-/**
- * The hook to memoize a value based on shallow comparison of dependencies.
- *
- * @param factory - The factory function to create the value.
- * @param dependencies - The dependencies array.
- * @returns The memoized value.
- */
-export declare function useShallowMemo<T>(factory: Provider<T>, dependencies: DependencyList): T;

package/types/use-shallow-selector.d.ts

@@ -1,8 +0,0 @@
-import type { Mapper } from "@vef-framework/shared";
-/**
- * A hook that memoizes a selector based on shallow comparison of the state.
- *
- * @param selector - The selector to be memoized.
- * @returns The memoized selector.
- */
-export declare function useShallowSelector<S, T>(selector: Mapper<S, T>): Mapper<S, T>;

package/types/use-singleton.d.ts

@@ -1,7 +0,0 @@
-/**
- * The hook to create a singleton.
- *
- * @param factory - The factory function to create the singleton.
- * @returns The singleton.
- */
-export declare function useSingleton<T>(factory: () => NonNullable<T>): NonNullable<T>;

package/types/use-theme-tokens.d.ts

@@ -1,6 +0,0 @@
-/**
- * Get theme token
- *
- * @returns Theme token
- */
-export declare function useThemeTokens(): import("antd").GlobalToken;

package/types/use-transient-store.d.ts

@@ -1,34 +0,0 @@
-import type { BiConsumer, BiMapper, Mapper, UnboundStoreApi } from "@vef-framework/shared";
-import type { MutableRefObject } from "react";
-type Subscribable<T> = Pick<UnboundStoreApi<T>, "subscribe" | "getState">;
-/**
- * The options for the useTransientStore hook
- */
-export interface UseTransientStoreOptions<T, U> {
-    /**
-     * The selector to use for the transient store
-     */
-    selector?: Mapper<T, U>;
-    /**
-     * The equality function to use for the transient store
-     */
-    equalityFn?: BiMapper<U, U, boolean>;
-    /**
-     * The listener to use for the transient store
-     */
-    listener?: BiConsumer<U, U>;
-}
-/**
- * The hook to use for the transient store
- *
- * @param store - The store to use for the transient store
- * @param store.subscribe - The subscribe function to use for the transient store
- * @param store.getState - The getState function to use for the transient store
- * @param options - The options for the transient store
- * @param options.selector - The selector to use for the transient store
- * @param options.equalityFn - The equality function to use for the transient store
- * @param options.listener - The listener to use for the transient store
- * @returns The transient state ref
- */
-export declare function useTransientStore<T, U = T>({ subscribe, getState }: Subscribable<T>, { selector, equalityFn, listener, }?: UseTransientStoreOptions<T, U>): MutableRefObject<U>;
-export {};

package/types/use-window-size.d.ts

@@ -1,17 +0,0 @@
-/**
- * The size of the window.
- */
-export interface WindowSize {
-    /**
-     * The width of the window.
-     */
-    width: number;
-    /**
-     * The height of the window.
-     */
-    height: number;
-}
-/**
- * The hook to get the size of the window.
- */
-export declare function useWindowSize(): WindowSize;