ping-identity
    Preparing search index...

    Type Alias PhoneNumberCollector

    PhoneNumberCollector: BaseCollector & {
        countryCode: string;
        defaultCountryCode: string;
        extension?: string;
        extensionLabel: string;
        phoneNumber: string;
        showExtension: boolean;
        type: "PHONE_NUMBER";
        validatePhoneNumber: boolean;
    }

    Phone number input collector.

    Type Declaration

    • countryCode: string

      Currently entered country code (mutable).

    • defaultCountryCode: string

      Default country code from server configuration (read-only).

    • Optionalextension?: string

      Currently entered phone extension (mutable, optional).

    • extensionLabel: string

      Label for the phone extension input (read-only).

    • phoneNumber: string

      Currently entered phone number (mutable).

    • showExtension: boolean

      Whether the phone extension input should be displayed (read-only).

    • type: "PHONE_NUMBER"
    • validatePhoneNumber: boolean

      Whether phone number format validation is enabled (read-only).

    countryCode, phoneNumber, and optional extension are mutable values passed to next(). defaultCountryCode, validatePhoneNumber, showExtension, and extensionLabel are server-provided configuration. Render an extension control when showExtension is true; the submitted extension can still be omitted.