Interface FocusProps

Props of the useFocus hook.

interface FocusProps {
    isDisabled?: boolean;
    onBlur?: (() => void);
    onFocus?: (() => void);
    onFocusChange?: ((isFocused: boolean) => void);
    onFocusVisible?: (() => void);
}

Hierarchy (view full)

Properties

isDisabled? onBlur? onFocus? onFocusChange? onFocusVisible?

Properties

OptionalisDisabled

isDisabled?: boolean

If true then focus events are disabled.

Default

false

OptionalonBlur

onBlur?: (() => void)

A handler that is called when the element loses focus.

OptionalonFocus

onFocus?: (() => void)

A handler that is called when the element receives focus.

OptionalonFocusChange

onFocusChange?: ((isFocused: boolean) => void)

A handler that is called when the element's focus status changes.

Type declaration

    • (isFocused): void

    • Parameters

      • isFocused: boolean

        true if an element is focused.

      Returns void

OptionalonFocusVisible

onFocusVisible?: (() => void)

A handler that is called when the element receives focus that must be visible to a user.

Settings

Member Visibility

On This Page

Properties