@oneblink/sdk-core
    Preparing search index...

    Type Alias CheckboxElement

    CheckboxElement: FormElementWithOptionsBase & {
        buttons: boolean;
        canToggleAll?: boolean;
        defaultValue?: string[];
        requiredAll?: boolean;
        type: "checkboxes";
    }

    An element to display multiple options to a user and allowing them choose multiple.

    The element must have an id property that contains a universally unique identifier (UUID). The identifier must be a Version 4 (V4) UUID and must conform to the formatting requirements defined in this RFC 9562 specification: https://www.rfc-editor.org/rfc/rfc9562.html

    Type declaration

    • buttons: boolean
    • OptionalcanToggleAll?: boolean
    • OptionaldefaultValue?: string[]

      While this property is called defaultValue, it should actually be called defaultIds because it should not be set with a value from one of the options in the options array. It must be set to the ids of the options from the options array to be chosen by default.

    • OptionalrequiredAll?: boolean
    • type: "checkboxes"

    Settings

    Member Visibility