@boxcustodia/library 2.0.0-alpha.17 → 2.0.0-alpha.18

package/dist/index.d.ts

@@ -45,6 +45,7 @@ import * as React_2 from 'react';
 import { ReactElement } from 'react';
 import { ReactNode } from 'react';
 import { ReactPortal } from 'react';
+import { RefCallback } from 'react';
 import { RefObject } from 'react';
 import { RegisterOptions } from 'react-hook-form';
 import { ScrollArea as ScrollAreaPrimitive } from '@base-ui/react/scroll-area';
@@ -177,9 +178,9 @@ export declare type AlertDialogProps = Omit<AlertDialogPrimitive.Root.Props, "ch
     onAction?: () => void;
     /** Visual variant for the action button. @default "default" */
     variant?: VariantProps<typeof buttonVariants>["variant"];
-    /** Label for the cancel button. @default "Cancel" */
+    /** Label for the cancel button. @default "Cancelar" */
     closeText?: ReactNode;
-    /** Label for the action button. @default "Confirm" */
+    /** Label for the action button. @default "Confirmar" */
     actionText?: ReactNode;
     /** Styles the dialog popup panel. */
     className?: string;
@@ -714,10 +715,6 @@ export declare type ControllableState<T> = {
     onChange?: (state: T) => void;
 };
 
-declare type CopiedValue = string | null;
-
-declare type CopyFunction = (text: string) => Promise<boolean>;
-
 export declare const createSafeContext: <T>() => readonly [() => T & ({} | undefined), default_2.Provider<T | null>];
 
 export declare function createToastManager(): ToastManager<any> & {
@@ -2416,7 +2413,23 @@ export declare const useAutocompleteFilter: typeof AutocompletePrimitive.useFilt
 
 export declare const useClickOutside: <T extends HTMLElement = HTMLElement>(callback: () => void, watch?: boolean) => RefObject<T | null>;
 
-export declare function useClipboard(): [CopiedValue, CopyFunction];
+export declare function useClipboard(options?: UseClipboardInput): UseClipboardReturnValue;
+
+export declare interface UseClipboardInput {
+    /** Time in ms after which the copied state will reset, `2000` by default */
+    timeout?: number;
+}
+
+export declare interface UseClipboardReturnValue {
+    /** Function to copy a string value to the clipboard */
+    copy: (value: string) => void;
+    /** Function to reset copied state and error */
+    reset: () => void;
+    /** Error if copying failed, `null` otherwise */
+    error: Error | null;
+    /** Boolean indicating if the value was copied successfully */
+    copied: boolean;
+}
 
 export declare const useComboboxFilter: typeof ComboboxPrimitive.useFilter;
 
@@ -2435,7 +2448,12 @@ export declare function useDisclosure(initialState?: boolean, callbacks?: {
     readonly toggle: () => void;
 }];
 
-export declare function useDocumentTitle(title: string): void;
+export declare function useDocumentTitle(title: string, options?: UseDocumentTitleInput): void;
+
+export declare interface UseDocumentTitleInput {
+    /** Restore the previous `document.title` when the component unmounts. Defaults to `false`. */
+    restoreOnUnmount?: boolean;
+}
 
 export declare function useEventListener<K extends keyof HTMLElementEventMap, T extends HTMLElement = any>(type: K, listener: (this: HTMLDivElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): RefObject<T | null>;
 
@@ -2447,15 +2465,19 @@ export declare function useHookForm<T extends FieldValues = FieldValues>(schema:
 
 export declare function useHotkey(keys: string | string[], handler: (event: KeyboardEvent) => void, options?: HotkeyOptions): RefObject<any>;
 
-export declare function useHover<T extends HTMLElement>(options?: UseHoverOptions): {
-    ref: React.RefObject<T | null>;
-    isHovering: boolean;
-};
+export declare function useHover<T extends HTMLElement = HTMLElement>(options?: UseHoverInput): UseHoverReturnValue<T>;
 
-declare type UseHoverOptions = {
+export declare interface UseHoverInput {
+    /** Fired when the pointer enters the target element. Receives the native MouseEvent. */
     onHoverStart?: (event: MouseEvent) => void;
+    /** Fired when the pointer leaves the target element. Receives the native MouseEvent. */
     onHoverEnd?: (event: MouseEvent) => void;
-};
+}
+
+export declare interface UseHoverReturnValue<T extends HTMLElement = HTMLElement> {
+    hovered: boolean;
+    ref: RefCallback<T>;
+}
 
 export declare function useIsInsideFieldRoot(): boolean;
 
@@ -2498,6 +2520,10 @@ export declare function useObject<T extends GenericObject_2>(): MaybeReturn<T>;
 
 export declare function useObject<T extends GenericObject_2>(initialValue: T): Return<T>;
 
+export declare function useOnMount(callback: UseOnMountCallback): void;
+
+export declare type UseOnMountCallback = () => void | (() => void);
+
 export declare function usePagination({ totalItems, pageSize, currentPage: currentPageProp, defaultCurrentPage, onCurrentPageChange, initialCurrentPage, onChange, }: usePaginationProps): {
     next: () => void;
     prev: () => void;