Hex Core JS
    Preparing search index...

    Type Alias PhoneNumberInputProps

    PhoneNumberInputProps: {
        autoComplete?: string;
        autoFocus?: boolean;
        defaultCountryCode?: CountryCode | "USER";
        disabled?: boolean;
        id?: string;
        invalid?: boolean;
        name?: string;
        noCountryCode?: boolean;
        onBlur?: () => void;
        onFocus?: () => void;
        placeholder?: string;
        setValue: (value: TextFieldValue) => void;
        sideEffect?: (v: TextFieldValue) => void;
        value: TextFieldValue;
    } & Pick<InputProps, "before" | "after" | "gap"> & Partial<
        ClassNameProps & StyleProps,
    >

    Type Declaration

    • OptionalautoComplete?: string

      Auto-complete option for the input (supports the usual HTML values).

    • OptionalautoFocus?: boolean

      Indicates if the input should be auto-focused.

    • OptionaldefaultCountryCode?: CountryCode | "USER"

      The default country code to use when blank initially (two-digit ISO code for the country). Supports the special value "USER", which uses the user's locale to pick the default country code (this is the default value for this prop).

    • Optionaldisabled?: boolean

      Indicates if the input is disabled.

    • Optionalid?: string

      The ID of the input.

    • Optionalinvalid?: boolean

      Indicates if the input is invalid.

    • Optionalname?: string

      The name of the input.

    • OptionalnoCountryCode?: boolean

      Prevents the country code input from rendering. Instead renders a single input.

    • OptionalonBlur?: () => void

      A callback function to call when focus is removed from the input.

    • OptionalonFocus?: () => void

      A callback function to call when the input becomes focused.

    • Optionalplaceholder?: string

      Placeholder text to display when the value is blank.

    • setValue: (value: TextFieldValue) => void

      A callback function to update the input value when a change happens.

    • OptionalsideEffect?: (v: TextFieldValue) => void

      A side effect function to call when the value changes as a result of user interaction with this input, and not external updates to the field value.

    • value: TextFieldValue

      The value of the input.

    Settings

    Member Visibility