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

    Interface HeadlessNumberInputProps

    Props for the useNumberInput hook.

    interface HeadlessNumberInputProps {
        format?: NumberFormat;
        id?: string;
        isAutofocused?: boolean;
        isCopyDecoded?: boolean;
        isDisabled?: boolean;
        isInvalid?: boolean;
        isSignLocked?: boolean;
        isUndefinedValueFormatted?: boolean;
        onBlur?: () => void;
        onChange?: (value: number | undefined) => void;
        onFocus?: () => void;
        onFocusChange?: (isFocused: boolean) => void;
        onFocusVisible?: () => void;
        onHoverChange?: (isHovered: boolean) => void;
        onHoverEnd?: () => void;
        onHoverStart?: () => void;
        value: number | undefined;
    }

    Hierarchy (View Summary)

    Index

    Properties

    format? id? isAutofocused? isCopyDecoded? isDisabled? isInvalid? isSignLocked? isUndefinedValueFormatted? onBlur? onChange? onFocus? onFocusChange? onFocusVisible? onHoverChange? onHoverEnd? onHoverStart? value

    Properties

    format?: NumberFormat

    The number format to use.

    By default, a format based on the current locale is used.

    id?: string

    An ID that uniquely identifies the text input.

    isAutofocused?: boolean

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

    false
    isCopyDecoded?: boolean

    If true, formatting is removed when a number is copied or cut.

    false
    isDisabled?: boolean

    If true, hover interactions are disabled.

    false
    isInvalid?: boolean

    If true, the input is marked as invalid.

    false
    isSignLocked?: boolean

    If true, the handler prevents changing the sign of the edited number.

    false
    isUndefinedValueFormatted?: boolean

    If true, formatting is rendered for an undefined value.

    false
    onBlur?: () => void

    A handler that is called when the element loses focus.

    onChange?: (value: number | undefined) => void

    A callback invoked when the input value changes.

    Type Declaration

      • (value: number | undefined): void

      • Parameters

        • value: number | undefined

          The new input 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.

    value: number | undefined

    The current input value.

    Settings

    Member Visibility

    On This Page

    Properties