@karmaniverous/hook-form-semantic
    Preparing search index...

    Interface HookFormPhoneProps<TFieldValues, TName>

    interface HookFormPhoneProps<
        TFieldValues extends FieldValues = FieldValues,
        TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>,
    > {
        countrySearch?: boolean;
        hookControl?: Control<TFieldValues, any, TFieldValues>;
        hookDefaultValue?: PathValueImpl<TFieldValues, TName>;
        hookDisabled?: boolean;
        hookName: TName;
        hookRules?: Omit<
            RegisterOptions<TFieldValues, TName>,
            "disabled" | "valueAsNumber" | "valueAsDate" | "setValueAs",
        >;
        hookShouldUnregister?: boolean;
        isValidating?: boolean;
        logger?: Logger;
        mobileBreakpoint?: number;
        phoneAllowMaskOverflow?: boolean;
        phoneCharAfterDialCode?: string;
        phoneCountries?: CountryData[];
        phoneDefaultCountry?: CountryIso2;
        phoneDefaultMask?: string;
        phoneDisableCountryGuess?: boolean;
        phoneDisableDialCodeAndPrefix?: boolean;
        phoneDisableDialCodePrefill?: boolean;
        phoneDisableFormatting?: boolean;
        phoneForceDialCode?: boolean;
        phoneHistorySaveDebounceMS?: number;
        phoneInputRef?: MutableRefObject<HTMLInputElement | null>;
        phoneOnChange?: (
            data: { country: ParsedCountry; inputValue: string; phone: string },
        ) => void;
        phonePlaceholderNumberChar?: string;
        phonePreferredCountries?: CountryIso2[];
        phonePrefix?: string;
        [key: string]: any;
        [key: number]: any;
    }

    Type Parameters

    Hierarchy

    • HookFormProps<TFieldValues, TName>
    • Omit<
          FormFieldProps,
          "disabled"
          | "error"
          | "name"
          | "onBlur"
          | "onChange"
          | "ref"
          | "value",
      >
    • PrefixProps<Omit<UsePhoneInputConfig, "value">, "phone">
      • HookFormPhoneProps

    Indexable

    • [key: string]: any
    • [key: number]: any
    Index
    countrySearch? hookControl? hookDefaultValue? hookDisabled? hookName hookRules? hookShouldUnregister? isValidating? logger? mobileBreakpoint? phoneAllowMaskOverflow? phoneCharAfterDialCode? phoneCountries? phoneDefaultCountry? phoneDefaultMask? phoneDisableCountryGuess? phoneDisableDialCodeAndPrefix? phoneDisableDialCodePrefill? phoneDisableFormatting? phoneForceDialCode? phoneHistorySaveDebounceMS? phoneInputRef? phoneOnChange? phonePlaceholderNumberChar? phonePreferredCountries? phonePrefix?
    countrySearch?: boolean

    Enable typeahead on the country selector. Off by default: the search variant renders a real text input inside the selector, which puts a caret in the tab order where users expect a button — tabbing from the previous field lands in the country filter and typed digits filter countries instead of dialling. The non-search dropdown is still fully keyboard operable (arrows, Enter, letter-jump).

    hookControl?: Control<TFieldValues, any, TFieldValues>
    hookDefaultValue?: PathValueImpl<TFieldValues, TName>
    hookDisabled?: boolean
    hookName: TName
    hookRules?: Omit<
        RegisterOptions<TFieldValues, TName>,
        "disabled" | "valueAsNumber" | "valueAsDate" | "setValueAs",
    >
    hookShouldUnregister?: boolean
    isValidating?: boolean
    logger?: Logger
    mobileBreakpoint?: number
    phoneAllowMaskOverflow?: boolean
    phoneCharAfterDialCode?: string
    phoneCountries?: CountryData[]
    phoneDefaultCountry?: CountryIso2
    phoneDefaultMask?: string
    phoneDisableCountryGuess?: boolean
    phoneDisableDialCodeAndPrefix?: boolean
    phoneDisableDialCodePrefill?: boolean
    phoneDisableFormatting?: boolean
    phoneForceDialCode?: boolean
    phoneHistorySaveDebounceMS?: number
    phoneInputRef?: MutableRefObject<HTMLInputElement | null>
    phoneOnChange?: (
        data: { country: ParsedCountry; inputValue: string; phone: string },
    ) => void
    phonePlaceholderNumberChar?: string
    phonePreferredCountries?: CountryIso2[]
    phonePrefix?: string

    Settings
    Member Visibility

    On This Page
    Properties