React Hookers - v6.3.0
    Preparing search index...

    Interface FocusScopeProviderProps

    Props of the FocusScope component.

    interface FocusScopeProviderProps {
        approveFocusCandidate?: (element: FocusableElement) => boolean;
        children?: ReactNode;
        containerRef: RefObject<Element | null>;
        isAutofocused?: boolean;
        isFocusRestored?: boolean;
        isFocusTrap?: boolean;
        isScrollPrevented?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    approveFocusCandidate? children? containerRef isAutofocused? isFocusRestored? isFocusTrap? isScrollPrevented?

    Properties

    approveFocusCandidate?: (element: FocusableElement) => boolean

    Returns true if an element is allowed to receive focus. By default, all candidates are approved.

    children?: ReactNode

    Children rendered inside a focus scope.

    containerRef: RefObject<Element | null>

    A ref to a container element inside which focus state is managed.

    isAutofocused?: boolean

    If true, focuses the first approved candidate element inside the container when the scope is mounted.

    By default, autofocus is enabled if the focus ring is visible.

    isFocusRestored?: boolean

    If true, focus is restored to the element that was focused before this scope was mounted.

    By default, focus is restored if the focus ring is visible.

    isFocusTrap?: boolean

    If true, focus cannot leave the scope.

    false
    isScrollPrevented?: boolean

    If true, no scrolling will occur after the element receives focus. Otherwise, the browser scrolls the document to bring the newly focused element into view.

    false

    Settings

    Member Visibility

    On This Page

    Properties