@boxcustodia/library 1.1.0 → 1.2.1

package/dist/src/hooks/useArray/useArray.d.ts

@@ -0,0 +1,14 @@
+import { ListIterateeCustom } from 'lodash';
+
+declare function useArray<T>(defaultProp: T[]): readonly [T[], {
+    readonly insertAt: (index: number, item: T) => void;
+    readonly removeAt: (index: number) => void;
+    readonly updateAt: (index: number, newItem: T) => void;
+    readonly clear: () => void;
+    readonly reset: () => void;
+    readonly push: (item: T) => void;
+    readonly set: (newList: T[]) => void;
+    readonly pop: () => void;
+    readonly update: (predicate: ListIterateeCustom<T, boolean>, newItem: T | ((item: T) => T)) => void;
+}];
+export default useArray;

package/dist/src/hooks/useAsync/__doc__/useAsync.stories.d.ts

@@ -0,0 +1,18 @@
+import { Meta, StoryObj } from '@storybook/react';
+
+declare const meta: Meta;
+export default meta;
+type Story = StoryObj;
+export declare const Basic: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};
+/**
+ * ```tsx
+ * interface UseAsyncOptions<T> {
+ *  onError?: (error: Error) => void;
+ *  onSuccess?: (data: T) => void;
+ *  onFinish?: () => void;
+ * }
+ * ```
+ */
+export declare const Advanced: Story;

package/dist/src/hooks/useAsync/__test__/useAsync.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/useAsync/index.d.ts

@@ -0,0 +1 @@
+export { default as useAsync } from './useAsync';

package/dist/src/hooks/useAsync/useAsync.d.ts

@@ -0,0 +1,19 @@
+import { DependencyList } from 'react';
+
+interface UseAsyncOptions<T> {
+    onError?: (error: Error) => void;
+    onSuccess?: (data: T) => void;
+    onFinish?: () => void;
+}
+interface AsyncState<T> {
+    loading: boolean;
+    error: Error | null;
+    data: T | null;
+    refetch: () => void;
+}
+interface Props<T> extends UseAsyncOptions<T> {
+    fn: () => Promise<T>;
+    dependencies?: DependencyList;
+}
+declare function useAsync<T>({ fn, dependencies, onError, onSuccess, onFinish, }: Props<T>): AsyncState<T>;
+export default useAsync;

package/dist/src/hooks/useClickOutside/__doc__/useClickOutside.stories.d.ts

@@ -0,0 +1,7 @@
+import { Meta } from '@storybook/react';
+
+declare const meta: Meta;
+export default meta;
+export declare const Default: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};

package/dist/src/hooks/useClickOutside/__test__/useClickOutside.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/useClickOutside/index.d.ts

@@ -0,0 +1 @@
+export { default as useClickOutside } from './useClickOutside';

package/dist/src/hooks/useClickOutside/useClickOutside.d.ts

@@ -0,0 +1,2 @@
+declare const useClickOutside: <T extends HTMLElement = HTMLElement>(callback: () => void, watch?: boolean) => import('react').RefObject<T | null>;
+export default useClickOutside;

package/dist/src/hooks/useClipboard/__doc__/useClipboard.stories.d.ts

@@ -0,0 +1,9 @@
+import { Meta, StoryObj } from '@storybook/react';
+
+/**
+ * Permite copiar texto al portapapeles del usuario. Devuelve el texto copiado actualmente y una función para copiar nuevo texto. Incluye manejo de compatibilidad y errores.
+ */
+declare const meta: Meta;
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Default: Story;

package/dist/src/hooks/useClipboard/__test__/useClipboard.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/useClipboard/index.d.ts

@@ -0,0 +1 @@
+export { default as useClipboard } from './useClipboard';

package/dist/src/hooks/useClipboard/useClipboard.d.ts

@@ -0,0 +1,4 @@
+type CopiedValue = string | null;
+type CopyFunction = (text: string) => Promise<boolean>;
+declare function useCopyToClipboard(): [CopiedValue, CopyFunction];
+export default useCopyToClipboard;

package/dist/src/hooks/useDebounceCallback/__doc__/useDebouncedCallback.stories.d.ts

@@ -0,0 +1,8 @@
+import { Meta, StoryObj } from '@storybook/react';
+
+declare const meta: Meta;
+export default meta;
+export declare const Basic: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};
+export declare const DifferentDelays: StoryObj;

package/dist/src/hooks/useDebounceCallback/index.d.ts

@@ -0,0 +1 @@
+export { default as useDebouncedCallback } from './useDebouncedCallback';

package/dist/src/hooks/useDebounceCallback/useDebouncedCallback.d.ts

@@ -0,0 +1,2 @@
+declare function useDebouncedCallback<T extends (...args: any[]) => any>(callback: T, delay: number): (...args: Parameters<T>) => void;
+export default useDebouncedCallback;

package/dist/src/hooks/useDebounceValue/__doc__/useDebouncedValue.stories.d.ts

@@ -0,0 +1,8 @@
+import { Meta, StoryObj } from '@storybook/react';
+
+declare const meta: Meta;
+export default meta;
+export declare const Basic: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};
+export declare const MultipleDelays: StoryObj;

package/dist/src/hooks/useDebounceValue/index.d.ts

@@ -0,0 +1 @@
+export { default as useDebouncedValue } from './useDebouncedValue';

package/dist/src/hooks/useDebounceValue/useDebouncedValue.d.ts

@@ -0,0 +1,2 @@
+declare function useDebouncedValue<T>(value: T, delay: number): T;
+export default useDebouncedValue;

package/dist/src/hooks/useDisclosure/__doc__/useDisclosure.stories.d.ts

@@ -0,0 +1,10 @@
+import { Meta } from '@storybook/react';
+
+/**
+ * Hook que facilita el manejo de un estado booleano. Provee métodos para abrir, cerrar y toggle el estado
+ */
+declare const meta: Meta;
+export default meta;
+export declare const Default: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};

package/dist/src/hooks/useDisclosure/__test__/useDisclosure.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/useDisclosure/index.d.ts

@@ -0,0 +1 @@
+export { default as useDisclosure } from './useDisclosure';

package/dist/src/hooks/useDisclosure/useDisclosure.d.ts

@@ -0,0 +1,9 @@
+declare function useDisclosure(initialState?: boolean, callbacks?: {
+    onOpen?: () => void;
+    onClose?: () => void;
+}): readonly [boolean, {
+    readonly open: () => void;
+    readonly close: () => void;
+    readonly toggle: () => void;
+}];
+export default useDisclosure;

package/dist/src/hooks/useDocumentTitle/__doc__/useDocumentTitle.stories.d.ts

@@ -0,0 +1,6 @@
+import { Meta, StoryObj } from '@storybook/react';
+
+declare const meta: Meta;
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Default: Story;

package/dist/src/hooks/useDocumentTitle/index.d.ts

@@ -0,0 +1 @@
+export { default as useDocumentTitle } from './useDocumentTitle';

package/dist/src/hooks/useDocumentTitle/useDocumentTitle.d.ts

@@ -0,0 +1,2 @@
+declare function useDocumentTitle(title: string): void;
+export default useDocumentTitle;

package/dist/src/hooks/useEventListener/__doc__/useEventListener.stories.d.ts

@@ -0,0 +1,18 @@
+import { Meta } from '@storybook/react';
+
+/**
+ * Hook que facilita el manejor de eventos
+ *
+ * Evita tener que hacer el `useEffect` con el cleanup
+ */
+declare const meta: Meta;
+export default meta;
+/**
+ * ```tsx
+ * const ref = useEventListener<HTMLELEMENT>("EVENT_KEY", callback);
+ * return <HTMLELEMENT ref={ref} />;
+ * ```
+ */
+export declare const Default: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};

package/dist/src/hooks/useEventListener/__test__/useEventListener.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/useEventListener/index.d.ts

@@ -0,0 +1 @@
+export { default as useEventListener } from './useEventListener';

package/dist/src/hooks/useEventListener/useEventListener.d.ts

@@ -0,0 +1,2 @@
+declare function useEventListener<K extends keyof HTMLElementEventMap, T extends HTMLElement = any>(type: K, listener: (this: HTMLDivElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): import('react').RefObject<T | null>;
+export default useEventListener;

package/dist/src/hooks/useFocusTrap/__doc__/useFocusTrap.stories.d.ts

@@ -0,0 +1,10 @@
+import { Meta } from '@storybook/react';
+
+/**
+ * Hook que atrapa el focus en un scope
+ */
+declare const meta: Meta;
+export default meta;
+export declare const Default: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};

package/dist/src/hooks/useFocusTrap/index.d.ts

@@ -0,0 +1 @@
+export { default as useFocusTrap } from './useFocusTrap';

package/dist/src/hooks/useFocusTrap/scopeTab.d.ts

@@ -0,0 +1 @@
+export declare function scopeTab(node: HTMLElement, event: KeyboardEvent): void;

package/dist/src/hooks/useFocusTrap/tabbable.d.ts

@@ -0,0 +1,4 @@
+export declare const FOCUS_SELECTOR = "a, input, select, textarea, button, object, [tabindex]";
+export declare function focusable(element: HTMLElement): boolean | "";
+export declare function tabbable(element: HTMLElement): boolean | "";
+export declare function findTabbableDescendants(element: HTMLElement): HTMLElement[];

package/dist/src/hooks/useFocusTrap/useFocusTrap.d.ts

@@ -0,0 +1,2 @@
+declare function useFocusTrap(active?: boolean): (instance: HTMLElement | null) => void;
+export default useFocusTrap;

package/dist/src/hooks/useHotkey/__docs__/useHotkey.stories.d.ts

@@ -0,0 +1,23 @@
+import { Meta, StoryObj } from '@storybook/react';
+
+declare const meta: Meta;
+export default meta;
+type Story = StoryObj<typeof meta>;
+/**
+ * Opciones
+ *
+ * ```tsx
+ * type HotkeyOptions = {
+ * // Es el evento que se va a utilizar; Keydown, Keyup, Keypress
+ * eventName?: HotkeyEventName;
+ * @default "keydown"
+ * // si se debe prevenir los comandos por defecto del navegador
+ * preventDefault?: boolean;
+ * @default true
+ * // si los comandos se deberían ejecutar mientras el usuario está escribiendo en un input o textarea
+ * ignoreInputFields?: boolean;
+ * @default false
+ * };
+ * ```
+ **/
+export declare const Default: Story;

package/dist/src/hooks/useHotkey/__test__/useHotkey.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/useHotkey/__utils__/create-hotkey-listener.d.ts

@@ -0,0 +1 @@
+export declare const createListener: (keys: string | string[], handler: (event: KeyboardEvent) => void, preventDefault: boolean, ignoreInputFields: boolean, watch: boolean) => (event: KeyboardEvent) => void;

package/dist/src/hooks/useHotkey/__utils__/index.d.ts

@@ -0,0 +1,3 @@
+export * from './match-key-modifiers';
+export * from './is-input-field';
+export * from './create-hotkey-listener';

package/dist/src/hooks/useHotkey/__utils__/is-input-field.d.ts

@@ -0,0 +1,2 @@
+export declare const isInputField: (element: HTMLElement) => boolean;
+export declare const shouldIgnoreEvent: (event: KeyboardEvent, ignoreInputFields: boolean) => boolean;

package/dist/src/hooks/useHotkey/__utils__/match-key-modifiers.d.ts

@@ -0,0 +1,8 @@
+export declare const getKeyModifiers: (key: string) => {
+    mainKey: string;
+    isShift: boolean;
+    isCtrl: boolean;
+    isAlt: boolean;
+    isMeta: boolean;
+};
+export declare const matchKeyModifiers: (event: KeyboardEvent, key: string) => boolean;

package/dist/src/hooks/useHotkey/index.d.ts

@@ -0,0 +1 @@
+export { default as useHotkey } from './useHotkey';

package/dist/src/hooks/useHotkey/useHotkey.d.ts

@@ -0,0 +1,10 @@
+export type Keys = string | string[];
+export type HotkeyEventName = "keydown" | "keypress" | "keyup";
+export type HotkeyOptions = {
+    watch?: boolean;
+    eventName?: HotkeyEventName;
+    preventDefault?: boolean;
+    ignoreInputFields?: boolean;
+};
+declare function useHotkey(keys: string | string[], handler: (event: KeyboardEvent) => void, options?: HotkeyOptions): import('react').RefObject<any>;
+export default useHotkey;

package/dist/src/hooks/useHover/__doc__/useHover.stories.d.ts

@@ -0,0 +1,10 @@
+import { Meta } from '@storybook/react';
+
+/**
+ * Hook que facilita el manejo de un estado booleano. Provee métodos para abrir, cerrar y toggle el estado
+ */
+declare const meta: Meta;
+export default meta;
+export declare const Default: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};

package/dist/src/hooks/useHover/__test__/useHover.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/useHover/index.d.ts

@@ -0,0 +1 @@
+export { default as useHover } from './useHover';

package/dist/src/hooks/useHover/useHover.d.ts

@@ -0,0 +1,9 @@
+type UseHoverOptions = {
+    onHoverStart?: (event: MouseEvent) => void;
+    onHoverEnd?: (event: MouseEvent) => void;
+};
+declare function useHover<T extends HTMLElement>(options?: UseHoverOptions): {
+    ref: React.RefObject<T | null>;
+    isHovering: boolean;
+};
+export default useHover;

package/dist/src/hooks/useIsVisible/__doc__/useIsVisible.stories.d.ts

@@ -0,0 +1,10 @@
+import { Meta, StoryObj } from '@storybook/react';
+
+/**
+ * Hook que permite detectar si un elemento es visible para el usuario
+ *
+ * Extiende la API de `IntersectionObserver`
+ */
+declare const meta: Meta;
+export default meta;
+export declare const Default: StoryObj;

package/dist/src/hooks/useIsVisible/index.d.ts

@@ -0,0 +1 @@
+export { default as useIsVisible } from './useIsVisible';

package/dist/src/hooks/useIsVisible/useIsVisible.d.ts

@@ -0,0 +1,11 @@
+import { RefObject } from 'react';
+
+interface UseIsVisibleProps extends IntersectionObserverInit {
+    onVisible?: () => void;
+}
+interface UseIsVisibleReturn<T> {
+    ref: RefObject<T | null>;
+    isVisible: boolean;
+}
+declare function useIsVisible<T extends HTMLElement>({ onVisible, root, rootMargin, threshold, }?: UseIsVisibleProps): UseIsVisibleReturn<T>;
+export default useIsVisible;

package/dist/src/hooks/useLocalStorage/__doc__/useLocalStorage.stories.d.ts

@@ -0,0 +1,33 @@
+import { Meta } from '@storybook/react';
+
+/**
+ * Hook que proporciona una interfaz sencilla para interactuar con el localStorage de manera tipada.
+ *
+ * Este hook permite almacenar, recuperar y eliminar valores en el localStorage de manera segura,
+ * utilizando una API genérica que asegura la consistencia de tipos en TypeScript. Es compatible con cualquier
+ * tipo de dato, desde strings hasta objetos complejos.
+ *
+ * @param key - La clave del localStorage donde se almacenará el valor.
+ * @param initialValue - El valor inicial que se utilizará si no hay datos almacenados bajo la clave proporcionada.
+ * @returns Una tupla con el valor almacenado, una función para actualizarlo y otra para eliminarlo.
+ *
+ * @example
+ * const [name, setName, removeName] = useLocalStorage<string>("name", "John Doe");
+ *
+ * @example
+ * const [count, setCount, removeCount] = useLocalStorage<number>("count", 0);
+ *
+ * @example
+ * const [items, setItems, removeItems] = useLocalStorage<string[]>("items", ["apple", "banana"]);
+ */
+declare const meta: Meta;
+export default meta;
+export declare const Default: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};
+export declare const WithNumber: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};
+export declare const WithArray: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};

package/dist/src/hooks/useLocalStorage/__test__/useLocalStorage.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/useLocalStorage/index.d.ts

@@ -0,0 +1 @@
+export { default as useLocalStorage } from './useLocalStorage';

package/dist/src/hooks/useLocalStorage/useLocalStorage.d.ts

@@ -0,0 +1,3 @@
+declare function useLocalStorage<T>(key: string): [T | undefined, (value: T) => void, () => void];
+declare function useLocalStorage<T>(key: string, initialValue: T): [T, (value: T) => void, () => void];
+export default useLocalStorage;

package/dist/src/hooks/useMediaQuery/__doc__/useMediaQuery.stories.d.ts

@@ -0,0 +1,5 @@
+import { Meta } from '@storybook/react';
+
+declare const meta: Meta;
+export default meta;
+export declare const Default: () => import("react/jsx-runtime").JSX.Element;

package/dist/src/hooks/useMediaQuery/index.d.ts

@@ -0,0 +1 @@
+export { default as useMediaQuery } from './useMediaQuery';

package/dist/src/hooks/useMediaQuery/useMediaQuery.d.ts

@@ -0,0 +1,2 @@
+declare const useMediaQuery: (query: string) => boolean;
+export default useMediaQuery;

package/dist/src/hooks/useMemoizedFn/index.d.ts

@@ -0,0 +1 @@
+export { default as useMemoizedFn } from './useMemoizedFn';

package/dist/src/hooks/useMemoizedFn/useMemoizedFn.d.ts

@@ -0,0 +1,3 @@
+type noop = (this: any, ...args: any[]) => any;
+declare function useMemoizedFn<T extends noop>(fn: T): T;
+export default useMemoizedFn;

package/dist/src/hooks/useMutation/__doc__/useMutation.stories.d.ts

@@ -0,0 +1,22 @@
+import { Meta } from '@storybook/react';
+
+/**
+ * El hook `useMutation` permite manejar operaciones de mutación asincrónicas, proporcionando estados de carga, error y éxito.
+ *
+ * Opciones de configuración:
+ * - `fn`: La función de mutación que se ejecutará.
+ * - `onError`: Callback opcional que se llama cuando ocurre un error.
+ * - `onSuccess`: Callback opcional que se llama cuando la mutación es exitosa.
+ * - `onFinish`: Callback opcional que se llama cuando la mutación termina, sin importar si tuvo éxito o error. Es útil para hacer un `refetch` (de `useAsync`)
+ *
+ * Devuelve un objeto con las siguientes propiedades:
+ * - `mutate`: Función para ejecutar la mutación.
+ * - `loading`: Indica si la mutación está en progreso.
+ * - `error`: Contiene el error si la mutación falla.
+ * - `data`: Contiene los datos si la mutación es exitosa.
+ */
+declare const meta: Meta;
+export default meta;
+export declare const Form: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};

package/dist/src/hooks/useMutation/__test__/useMutation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/useMutation/index.d.ts

@@ -0,0 +1 @@
+export { default as useMutation } from './useMutation';

package/dist/src/hooks/useMutation/useMutation.d.ts

@@ -0,0 +1,15 @@
+type Mutation<TArgs extends any[], TReturn> = (...args: TArgs) => Promise<TReturn>;
+interface UseMutationOptions<TArgs extends any[], TReturn> {
+    fn: Mutation<TArgs, TReturn>;
+    onError?: (error: Error) => void;
+    onSuccess?: (data: TReturn) => void;
+    onFinish?: () => void;
+}
+interface UseMutationReturn<TArgs extends any[], TReturn> {
+    mutate: Mutation<TArgs, TReturn>;
+    loading: boolean;
+    error: Error | null;
+    data: TReturn | null;
+}
+export declare const useMutation: <TArgs extends any[], TReturn>(opts: UseMutationOptions<TArgs, TReturn>) => UseMutationReturn<TArgs, TReturn>;
+export default useMutation;

package/dist/src/hooks/useObject/__doc__/useObject.stories.d.ts

@@ -0,0 +1,17 @@
+import { Meta } from '@storybook/react';
+
+/**
+ * Hook para manejar un estado en forma de objeto
+ *
+ * `@param initialValue` - Valor inicial del estado, se recomienda pasar para evitar el caso donde el estado `T` pueda ser `T | undefined`
+ *
+ * `@returns` [state, setState, reset]
+ */
+declare const meta: Meta;
+export default meta;
+export declare const Default: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};
+export declare const Counter: {
+    render: () => import("react/jsx-runtime").JSX.Element;
+};

package/dist/src/hooks/useObject/__test__/useObject.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/useObject/index.d.ts

@@ -0,0 +1 @@
+export { default as useObject } from './useObject';

package/dist/src/hooks/useObject/useObject.d.ts

@@ -0,0 +1,6 @@
+type GenericObject = Record<string, any>;
+type Return<TState, TArgs = ((state: TState) => Partial<TState>) | Partial<TState>> = [TState, (arg: TArgs) => void, () => void];
+type MaybeReturn<TState> = Return<TState | undefined, ((state: TState | undefined) => Partial<TState>) | Partial<TState>>;
+declare function useObject<T extends GenericObject>(): MaybeReturn<T>;
+declare function useObject<T extends GenericObject>(initialValue: T): Return<T>;
+export default useObject;

package/dist/src/hooks/usePagination/__doc__/usePagination.stories.d.ts

@@ -0,0 +1,9 @@
+import { Meta } from '@storybook/react';
+
+/**
+ * Hook que facilita el manejo de paginaciones, recibe como param la cantidad de elementos, la cantidad de elementos por página y una función
+ * que se ejecuta cuando cambia la pagina
+ */
+declare const meta: Meta;
+export default meta;
+export declare const Default: () => import("react/jsx-runtime").JSX.Element;

package/dist/src/hooks/usePagination/__test__/usePagination.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/usePagination/index.d.ts

@@ -0,0 +1,2 @@
+export { default as usePagination } from './usePagination';
+export * from './usePagination';

package/dist/src/hooks/usePagination/usePagination.d.ts

@@ -0,0 +1,36 @@
+export type usePaginationProps = {
+    /**
+     * Cantidad total de elementos
+     */
+    totalItems: number;
+    /**
+     * Cantidad de elementos por página
+     */
+    pageSize: number;
+    /**
+     * Pagina inicial
+     */
+    initialCurrentPage?: number;
+    /**
+     * Callback que se ejecuta cuando cambia la pagina
+     */
+    onChange?: (value: {
+        currentPage: number;
+        pageSize: number;
+    }) => void;
+    siblingCount?: number;
+};
+declare function usePagination({ totalItems, pageSize, initialCurrentPage, onChange, }: usePaginationProps): {
+    next: () => void;
+    prev: () => void;
+    goTo: (page: number) => void;
+    currentPage: number;
+    maxPage: number;
+    isFirstPage: boolean;
+    isLastPage: boolean;
+    range: {
+        start: number;
+        end: number;
+    };
+};
+export default usePagination;

package/dist/src/hooks/usePortal/__doc__/usePortal.stories.d.ts

@@ -0,0 +1,7 @@
+import { Meta } from '@storybook/react';
+
+declare const meta: Meta;
+export default meta;
+export declare const Default: {
+    render: () => import('react').ReactPortal | null;
+};

package/dist/src/hooks/usePortal/__test__/usePortal.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/hooks/usePortal/index.d.ts

@@ -0,0 +1 @@
+export { default as usePortal } from './usePortal';

package/dist/src/hooks/usePortal/usePortal.d.ts

@@ -0,0 +1,6 @@
+import { ReactPortal, ReactNode } from 'react';
+
+declare function usePortal(id: string): {
+    render: (children: ReactNode) => ReactPortal | null;
+};
+export default usePortal;

package/dist/src/hooks/usePreventCloseWindow/__doc__/usePreventCloseWindow.stories.d.ts

@@ -0,0 +1,11 @@
+import { Meta } from '@storybook/react';
+
+/**
+ * Hook que permite prevenir que se cierre la ventana (muestra mensaje de aviso)
+ * Es útil para evitar que el usuario cierre la ventana accidentalmente mientras tiene cambios pendientes de guardar
+ */
+declare const meta: Meta;
+export default meta;
+export declare const Default: {
+    render: (args: any) => import("react/jsx-runtime").JSX.Element;
+};

package/dist/src/hooks/usePreventCloseWindow/index.d.ts

@@ -0,0 +1 @@
+export { default as usePreventCloseWindow } from './usePreventCloseWindow';

package/dist/src/hooks/usePreventCloseWindow/usePreventCloseWindow.d.ts

@@ -0,0 +1,13 @@
+interface UsePreventUnloadProps {
+    /**
+     * Propiedad que determina si la ventana se puede cerrar o no
+     */
+    shouldPrevent: boolean;
+    /**
+     * Mensaje que se va a mostrar al usuario antes de cerrar la ventana
+     * @deprecated ya no es soportado por los navegadores modernos
+     */
+    message?: string;
+}
+declare function usePreventClose({ shouldPrevent, message, }: UsePreventUnloadProps): void;
+export default usePreventClose;