@orion-ds/react 1.0.1 → 1.0.2

package/dist/hooks/useCopyToClipboard.d.ts

@@ -0,0 +1,72 @@
+/**
+ * useCopyToClipboard Hook
+ *
+ * Provides a function to copy text to clipboard with status tracking.
+ *
+ * @example
+ * ```tsx
+ * const { copy, copied, error } = useCopyToClipboard();
+ *
+ * return (
+ *   <Button onClick={() => copy('Hello!')}>
+ *     {copied ? 'Copied!' : 'Copy'}
+ *   </Button>
+ * );
+ * ```
+ */
+/**
+ * Options for useCopyToClipboard hook
+ */
+export interface UseCopyToClipboardOptions {
+    /**
+     * Duration in ms to show "copied" state
+     * @default 2000
+     */
+    copiedDuration?: number;
+    /**
+     * Callback when copy succeeds
+     */
+    onSuccess?: (text: string) => void;
+    /**
+     * Callback when copy fails
+     */
+    onError?: (error: Error) => void;
+}
+/**
+ * Return type for useCopyToClipboard hook
+ */
+export interface UseCopyToClipboardReturn {
+    /**
+     * Function to copy text to clipboard
+     */
+    copy: (text: string) => Promise<boolean>;
+    /**
+     * Whether text was recently copied
+     */
+    copied: boolean;
+    /**
+     * The last copied text
+     */
+    copiedText: string | null;
+    /**
+     * Any error that occurred
+     */
+    error: Error | null;
+    /**
+     * Reset the copied state
+     */
+    reset: () => void;
+}
+/**
+ * Hook to copy text to clipboard
+ *
+ * @param options - Configuration options
+ * @returns Copy function and status
+ */
+export declare function useCopyToClipboard(options?: UseCopyToClipboardOptions): UseCopyToClipboardReturn;
+/**
+ * Simplified hook that just returns the copy function
+ * For simple use cases where you don't need status tracking
+ */
+export declare function useCopy(): (text: string) => Promise<boolean>;
+//# sourceMappingURL=useCopyToClipboard.d.ts.map

package/dist/hooks/useCopyToClipboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCopyToClipboard.d.ts","sourceRoot":"","sources":["../../src/hooks/useCopyToClipboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAIH;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,GAAE,yBAA8B,GACtC,wBAAwB,CA2E1B;AAED;;;GAGG;AACH,wBAAgB,OAAO,IAAI,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAG5D"}

package/dist/hooks/useDebounce.d.ts

@@ -0,0 +1,58 @@
+/**
+ * useDebounce Hook
+ *
+ * Debounces a value, updating only after a specified delay.
+ *
+ * @example
+ * ```tsx
+ * const [search, setSearch] = useState('');
+ * const debouncedSearch = useDebounce(search, 300);
+ *
+ * useEffect(() => {
+ *   // Only runs 300ms after user stops typing
+ *   fetchResults(debouncedSearch);
+ * }, [debouncedSearch]);
+ * ```
+ */
+/**
+ * Hook to debounce a value
+ *
+ * @param value - Value to debounce
+ * @param delay - Debounce delay in milliseconds
+ * @returns Debounced value
+ */
+export declare function useDebounce<T>(value: T, delay: number): T;
+/**
+ * Options for useDebouncedCallback
+ */
+export interface UseDebouncedCallbackOptions {
+    /**
+     * Whether to call immediately on the leading edge
+     * @default false
+     */
+    leading?: boolean;
+    /**
+     * Whether to call on the trailing edge
+     * @default true
+     */
+    trailing?: boolean;
+    /**
+     * Maximum time to wait before forcing invocation
+     */
+    maxWait?: number;
+}
+/**
+ * Hook to create a debounced callback function
+ *
+ * @param callback - Function to debounce
+ * @param delay - Debounce delay in milliseconds
+ * @param options - Additional options
+ * @returns Debounced callback and control functions
+ */
+export declare function useDebouncedCallback<T extends (...args: unknown[]) => unknown>(callback: T, delay: number, options?: UseDebouncedCallbackOptions): {
+    callback: (...args: Parameters<T>) => void;
+    cancel: () => void;
+    flush: () => void;
+    isPending: () => boolean;
+};
+//# sourceMappingURL=useDebounce.d.ts.map

package/dist/hooks/useDebounce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDebounce.d.ts","sourceRoot":"","sources":["../../src/hooks/useDebounce.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAIH;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,CAczD;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,EAC5E,QAAQ,EAAE,CAAC,EACX,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,2BAAgC,GACxC;IACD,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAC3C,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,SAAS,EAAE,MAAM,OAAO,CAAC;CAC1B,CAmFA"}

package/dist/hooks/useDisclosure.d.ts

@@ -0,0 +1,74 @@
+/**
+ * useDisclosure Hook
+ *
+ * Manages open/close state for modals, drawers, dropdowns, etc.
+ *
+ * @example
+ * ```tsx
+ * const { isOpen, open, close, toggle } = useDisclosure();
+ *
+ * return (
+ *   <>
+ *     <Button onClick={toggle}>Toggle Modal</Button>
+ *     <Modal open={isOpen} onClose={close}>
+ *       Content
+ *     </Modal>
+ *   </>
+ * );
+ * ```
+ */
+/**
+ * Options for useDisclosure hook
+ */
+export interface UseDisclosureOptions {
+    /**
+     * Initial open state
+     * @default false
+     */
+    defaultOpen?: boolean;
+    /**
+     * Callback when state changes to open
+     */
+    onOpen?: () => void;
+    /**
+     * Callback when state changes to closed
+     */
+    onClose?: () => void;
+    /**
+     * Callback when state changes (open or close)
+     */
+    onChange?: (isOpen: boolean) => void;
+}
+/**
+ * Return type for useDisclosure hook
+ */
+export interface UseDisclosureReturn {
+    /**
+     * Whether the disclosure is open
+     */
+    isOpen: boolean;
+    /**
+     * Open the disclosure
+     */
+    open: () => void;
+    /**
+     * Close the disclosure
+     */
+    close: () => void;
+    /**
+     * Toggle the disclosure
+     */
+    toggle: () => void;
+    /**
+     * Set the disclosure state directly
+     */
+    setIsOpen: (value: boolean) => void;
+}
+/**
+ * Hook for managing open/close state
+ *
+ * @param options - Configuration options
+ * @returns Disclosure state and control functions
+ */
+export declare function useDisclosure(options?: UseDisclosureOptions): UseDisclosureReturn;
+//# sourceMappingURL=useDisclosure.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useDisclosure.d.ts","sourceRoot":"","sources":["../../src/hooks/useDisclosure.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAIH;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,IAAI,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,IAAI,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CACrC;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,OAAO,GAAE,oBAAyB,GACjC,mBAAmB,CAkDrB"}

package/dist/hooks/useKeyboard.d.ts

@@ -0,0 +1,101 @@
+/**
+ * useKeyboard Hook
+ *
+ * Handles keyboard shortcuts and key events.
+ *
+ * @example
+ * ```tsx
+ * // Single key
+ * useKeyboard('Escape', () => closeModal());
+ *
+ * // With modifiers
+ * useKeyboard('k', () => openSearch(), { meta: true });
+ * useKeyboard('s', () => save(), { ctrl: true });
+ *
+ * // Multiple keys
+ * useKeyboardShortcuts({
+ *   'Escape': () => closeModal(),
+ *   'Meta+k': () => openSearch(),
+ *   'Ctrl+s': () => save(),
+ * });
+ * ```
+ */
+/**
+ * Key modifier options
+ */
+export interface KeyModifiers {
+    /**
+     * Require Ctrl key
+     * @default false
+     */
+    ctrl?: boolean;
+    /**
+     * Require Alt/Option key
+     * @default false
+     */
+    alt?: boolean;
+    /**
+     * Require Shift key
+     * @default false
+     */
+    shift?: boolean;
+    /**
+     * Require Meta/Cmd key (Mac) or Windows key
+     * @default false
+     */
+    meta?: boolean;
+}
+/**
+ * Options for useKeyboard hook
+ */
+export interface UseKeyboardOptions extends KeyModifiers {
+    /**
+     * Whether the handler is enabled
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Event type to listen for
+     * @default 'keydown'
+     */
+    event?: 'keydown' | 'keyup' | 'keypress';
+    /**
+     * Whether to prevent default browser behavior
+     * @default true
+     */
+    preventDefault?: boolean;
+    /**
+     * Whether to stop event propagation
+     * @default false
+     */
+    stopPropagation?: boolean;
+    /**
+     * Target element (default: document)
+     */
+    target?: HTMLElement | null;
+    /**
+     * Only trigger if target element is focused
+     * @default false
+     */
+    targetOnly?: boolean;
+}
+/**
+ * Hook to handle a single keyboard shortcut
+ *
+ * @param key - Key to listen for (e.g., 'Escape', 'Enter', 'k')
+ * @param handler - Callback when key is pressed
+ * @param options - Additional options
+ */
+export declare function useKeyboard(key: string, handler: (event: KeyboardEvent) => void, options?: UseKeyboardOptions): void;
+/**
+ * Shortcut definition with handler
+ */
+export type KeyboardShortcuts = Record<string, () => void>;
+/**
+ * Hook to handle multiple keyboard shortcuts
+ *
+ * @param shortcuts - Object mapping shortcut strings to handlers
+ * @param options - Common options for all shortcuts
+ */
+export declare function useKeyboardShortcuts(shortcuts: KeyboardShortcuts, options?: Omit<UseKeyboardOptions, keyof KeyModifiers>): void;
+//# sourceMappingURL=useKeyboard.d.ts.map

package/dist/hooks/useKeyboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useKeyboard.d.ts","sourceRoot":"","sources":["../../src/hooks/useKeyboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAIH;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,KAAK,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,UAAU,CAAC;IAEzC;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,EACvC,OAAO,GAAE,kBAAuB,GAC/B,IAAI,CAqFN;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,CAAC;AAuC3D;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,iBAAiB,EAC5B,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,MAAM,YAAY,CAAM,GACzD,IAAI,CAkEN"}

package/dist/hooks/useLocalStorage.d.ts

@@ -0,0 +1,48 @@
+/**
+ * useLocalStorage Hook
+ *
+ * Syncs state with localStorage for persistence across sessions.
+ *
+ * @example
+ * ```tsx
+ * const [theme, setTheme] = useLocalStorage('theme', 'light');
+ * const [user, setUser] = useLocalStorage<User | null>('user', null);
+ *
+ * // Value persists across page refreshes
+ * setTheme('dark');
+ * ```
+ */
+/**
+ * Options for useLocalStorage hook
+ */
+export interface UseLocalStorageOptions<T> {
+    /**
+     * Custom serializer function
+     * @default JSON.stringify
+     */
+    serializer?: (value: T) => string;
+    /**
+     * Custom deserializer function
+     * @default JSON.parse
+     */
+    deserializer?: (value: string) => T;
+    /**
+     * Whether to sync across tabs
+     * @default true
+     */
+    syncAcrossTabs?: boolean;
+}
+/**
+ * Hook to sync state with localStorage
+ *
+ * @param key - localStorage key
+ * @param initialValue - Initial value if key doesn't exist
+ * @param options - Additional options
+ * @returns [value, setValue, removeValue]
+ */
+export declare function useLocalStorage<T>(key: string, initialValue: T, options?: UseLocalStorageOptions<T>): [T, (value: T | ((prev: T) => T)) => void, () => void];
+/**
+ * Hook to sync state with sessionStorage (similar to useLocalStorage)
+ */
+export declare function useSessionStorage<T>(key: string, initialValue: T, options?: Omit<UseLocalStorageOptions<T>, 'syncAcrossTabs'>): [T, (value: T | ((prev: T) => T)) => void, () => void];
+//# sourceMappingURL=useLocalStorage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useLocalStorage.d.ts","sourceRoot":"","sources":["../../src/hooks/useLocalStorage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAIH;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,CAAC;IAElC;;;OAGG;IACH,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,CAAC;IAEpC;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAC/B,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,CAAC,EACf,OAAO,GAAE,sBAAsB,CAAC,CAAC,CAAM,GACtC,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,EAAE,MAAM,IAAI,CAAC,CAiHxD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,CAAC,EACf,OAAO,GAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAM,GAC9D,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,EAAE,MAAM,IAAI,CAAC,CAuDxD"}

package/dist/hooks/useMediaQuery.d.ts

@@ -0,0 +1,43 @@
+/**
+ * useMediaQuery Hook
+ *
+ * Detects if a media query matches the current viewport.
+ *
+ * @example
+ * ```tsx
+ * const isMobile = useMediaQuery('(max-width: 768px)');
+ * const isDark = useMediaQuery('(prefers-color-scheme: dark)');
+ * const prefersReducedMotion = useMediaQuery('(prefers-reduced-motion: reduce)');
+ * ```
+ */
+/**
+ * Hook to detect if a media query matches
+ *
+ * @param query - CSS media query string
+ * @returns Whether the media query matches
+ */
+export declare function useMediaQuery(query: string): boolean;
+/**
+ * Preset breakpoint hooks based on Orion Design System
+ */
+/**
+ * Returns true if viewport is mobile (< 640px)
+ */
+export declare function useIsMobile(): boolean;
+/**
+ * Returns true if viewport is tablet (640px - 1023px)
+ */
+export declare function useIsTablet(): boolean;
+/**
+ * Returns true if viewport is desktop (>= 1024px)
+ */
+export declare function useIsDesktop(): boolean;
+/**
+ * Returns true if user prefers dark color scheme
+ */
+export declare function usePrefersDarkMode(): boolean;
+/**
+ * Returns true if user prefers reduced motion
+ */
+export declare function usePrefersReducedMotion(): boolean;
+//# sourceMappingURL=useMediaQuery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useMediaQuery.d.ts","sourceRoot":"","sources":["../../src/hooks/useMediaQuery.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAIH;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAoCpD;AAED;;GAEG;AAEH;;GAEG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAErC;AAED;;GAEG;AACH,wBAAgB,WAAW,IAAI,OAAO,CAErC;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAEtC;AAED;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,OAAO,CAE5C;AAED;;GAEG;AACH,wBAAgB,uBAAuB,IAAI,OAAO,CAEjD"}