SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias DialogBooleanInput

    DialogBooleanInput: Message<"soulfire.v1.DialogBooleanInput"> & {
        initial: boolean;
        key: string;
        label: string;
        onFalse: string;
        onTrue: string;
    }

    Boolean checkbox input in a dialog.

    Type Declaration

    • initial: boolean

      Initial checked state. Default: false.

      from field: bool initial = 3;

    • key: string

      Identifier used when submitting the dialog.

      from field: string key = 1;

    • label: string

      Display label for the checkbox.

      from field: string label = 2;

    • onFalse: string

      String value to submit when unchecked. Default: "false".

      from field: string on_false = 5;

    • onTrue: string

      String value to submit when checked. Default: "true".

      from field: string on_true = 4;

    from message soulfire.v1.DialogBooleanInput