Boolean Schema

Represents a boolean value in the submission.

The submission value is either true or false, defaulting to false.

obj {
    id = "#schema"
    properties {
        boolean("terms") {
            title = "I agree to the terms and conditions"
        }
    }
}

Properties

Property	Type	Required	Description
`$id`	String	No	A unique id which can be used to refer to the schema.
`additionalText`	String	No	Additional information to be displayed to the user.
`alert`	AlertLayout	No	Configure an alert which will be displayed above the UI for this schema. This can be used to provide warnings or additional information to the user, but shouldn't be used for validation. For client-side validation please see the validation available on each schema type, or see Validate Async and Action for server-side validation.
`analyticsId`	String	No	An internal id which is attached to analytics events relating to the schema. It allows you to override $id during event emission, it is not user-facing and does not have to be unique within the step.
`autofillKey`	String	No	Identifies the type of data which the client can autofill for this schema. This is provided in a `.` delimited string, in the format `source.prop`, e.g `contact.email`. In this example, the client should suggest values from the `email` property on objects retrieved from the `contact` source to autofill this field. The only currently supported source is `contact`. It will inspect contacts from the native client address book (if available). Supported properties on the `contact` source are: - `givenName` - `familyName` - `fullName` - `email` - `firstLine` - `city` - `state` - `postalCode` - `countryCode`
`control`	String	No	An identifier which can be used to request the client use a particular UI control to represent this schema.
`default`	Boolean	No	The default value to use for this schema. This will be overridden by a value in the model of the Step if one is provided.
`description`	String	No	A user-facing description for the schema.
`disabled`	Boolean	No	If true, the UI for this schema will not accept input, but the corresponding data will still be submitted. Defaults to false.
`help`	Help	No	Provide additional help information to the user.
`hidden`	Boolean	No	If true, no UI will be shown to the user for this schema, but the corresponding data will still be submitted. Defaults to false.
`icon`	Icon	No	An icon which the client can use to represent this entity.
`image`	Image	No	An image which the client can use to represent this entity.
`inlineAlert`	InlineAlert	No	An alert that will be displayed inline with the item.
`keywords`	Array<String>	No	A list of keywords that can be used when searching or filtering items in a One Of Schema. Only applies when this schema is child schema in a One Of Schema.
`media`	Media	No	A media object which the client can use to represent this entity.
`onChange`	Behavior	No	The Behavior that should be performed when the schema value changes.
`persistAsync`	PersistAsync	No
`refreshStepOnChange`	Boolean	No	When true, the step will be refreshed when the value of this schema changes.
`summary`	Summary.Provider	No	Configure how this schema will be summarised when included in an Array Schema.
`supportingValues`	SupportingValues	No	An object containing two strings representing two user-facing values. One being clearly more important than the other.
`tags`	Array<String>	No	An optional list of identifiers used to configure renderers.
`title`	String	No	A user-facing title for the schema.
`type`	String	Yes	It must be `boolean`.
`validationAsync`	ValidateAsync	No

Controls

`checkbox-item`

Use a checkbox component with support for additional context such as a third line of text and an inline alert.

obj {
    id = "#schema"
    properties {
        boolean("marketing") {
            title = "Marketing emails"
            description = "Receive tips and product updates from Wise."
            control = Control.Schema.Boolean.CHECKBOX_ITEM
        }
    }
}

`switch-item`

Use an input suitable for on/off switch.

boolean("recurringPayment") {
    title = "Recurring payment"
    control = "switch-item"
    defaultValue = true
}