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

    Interface HeadlessSelectProps<T>

    Props for the useSelect hook.

    interface HeadlessSelectProps<T> {
        id?: string;
        isAutofocused?: boolean;
        isDisabled?: boolean;
        isInvalid?: boolean;
        onBlur?: () => void;
        onChange: (value: T) => void;
        onFocus?: () => void;
        onFocusChange?: (isFocused: boolean) => void;
        onFocusVisible?: () => void;
        onHoverChange?: (isHovered: boolean) => void;
        onHoverEnd?: () => void;
        onHoverStart?: () => void;
        onOpenChange?: (isOpened: boolean) => void;
        onPress?: () => void;
        onPressChange?: (isPressed: boolean) => void;
        onPressEnd?: () => void;
        onPressStart?: () => void;
        value: T | undefined;
    }

    Type Parameters

    • T

      A selected value.

    Hierarchy (View Summary)

    Index

    Properties

    id? isAutofocused? isDisabled? isInvalid? onBlur? onChange onFocus? onFocusChange? onFocusVisible? onHoverChange? onHoverEnd? onHoverStart? onOpenChange? onPress? onPressChange? onPressEnd? onPressStart? value

    Properties

    id?: string

    An ID that uniquely identifies the select control.

    isAutofocused?: boolean

    If true, the element is auto-focusable within a focus scope.

    false
    isDisabled?: boolean

    If true, hover interactions are disabled.

    false
    isInvalid?: boolean

    If true, the control is marked as invalid.

    false
    onBlur?: () => void

    A handler that is called when the element loses focus.

    onChange: (value: T) => void

    A callback invoked when the selected value changes.

    Type Declaration

      • (value: T): void

      • Parameters

        • value: T

          The new selected value.

        Returns void

    onFocus?: () => void

    A handler that is called when the element receives focus.

    onFocusChange?: (isFocused: boolean) => void

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

    Type Declaration

      • (isFocused: boolean): void

      • Parameters

        • isFocused: boolean

          true if the element is focused.

        Returns void

    onFocusVisible?: () => void

    A handler that is called when the element receives focus and focus should be visible.

    onHoverChange?: (isHovered: boolean) => void

    A handler that is called when the hover state changes.

    Type Declaration

      • (isHovered: boolean): void

      • Parameters

        • isHovered: boolean

          true if the element is hovered.

        Returns void

    onHoverEnd?: () => void

    A handler that is called when a hover interaction ends.

    onHoverStart?: () => void

    A handler that is called when a hover interaction starts.

    onOpenChange?: (isOpened: boolean) => void

    A callback invoked when the open state of the select popover changes.

    Type Declaration

      • (isOpened: boolean): void

      • Parameters

        • isOpened: boolean

          true if the select popover should be visible.

        Returns void

    onPress?: () => void

    A handler that is called when the press is released over the target.

    onPressChange?: (isPressed: boolean) => void

    A handler that is called when the pressed state changes.

    Type Declaration

      • (isPressed: boolean): void

      • Parameters

        • isPressed: boolean

          true if the element is pressed.

        Returns void

    onPressEnd?: () => void

    A handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.

    onPressStart?: () => void

    A handler that is called when a press interaction starts.

    value: T | undefined

    The currently selected value.

    Settings

    Member Visibility

    On This Page

    Properties