ping-identity
    Preparing search index...

    Type Alias BooleanCollector

    BooleanCollector: BaseCollector & {
        appearance: "CHECKBOX" | "SWITCH";
        errorMessage: string;
        richContent?: RichContent;
        type: "SINGLE_CHECKBOX";
        value: boolean;
    }

    Single checkbox or toggle collector.

    Type Declaration

    • appearance: "CHECKBOX" | "SWITCH"

      Render hint — whether to display as a checkbox or a switch toggle.

    • errorMessage: string

      Validation error message shown when required is true and value is false.

    • OptionalrichContent?: RichContent

      Optional rich content with template text and named link replacements.

      Present when the server includes a richContent object in the field definition.

    • type: "SINGLE_CHECKBOX"
    • value: boolean

      Current checked state (mutable — set via next()).

    Corresponds to the native BOOLEAN inputType / SINGLE_CHECKBOX server type. Extends BaseCollector — has key, label, and required.

    When required is true and value is false, the native SDK's validate() emits a validation error using errorMessage. JS consumers should surface errorMessage to the user in that case.

    Settings

    Member Visibility