@lesnoypudge/utils-react/build/hooks/useIsFocused/useIsFocused.d.ts

lesnoypudge's utils-react

import { useRefManager } from '../useRefManager';
export declare namespace useIsFocused {
    type Options = {
        /**
         * Tracks if element has focused children.
         * @default false
         */
        within?: boolean;
        /**
         * Tracks if focus is visible to user.
         * @default false
         */
        visible?: boolean;
        /**
         * Disable state updates. Ref will keep updating.
         * @default false
         */
        stateless?: boolean;
        /**
         * Triggered when element receive focus.
         */
        onFocus?: (focusedElement: Element) => void;
        /**
         * Triggered when element lose focus.
         */
        onBlur?: (e: FocusEvent) => void;
    };
    type Return = {
        isFocused: boolean;
        isFocusedRef: useRefManager.RefManager<boolean>;
    };
}
/**
 * Tracks element's configurable focus state.
 */
export declare const useIsFocused: (elementRef: useRefManager.NullableRefManager<HTMLElement>, options?: useIsFocused.Options) => useIsFocused.Return;