Checkbox Field

Checkbox Field

Form Field

The checkbox field renders a single checkbox.

show_content:
    type: checkbox
    label: Display content

The following field properties are commonly used.

PropertyDescription
labela name when displaying the form field to the user.
defaulta default value to use for new records.
commenttext to display below the checkbox.

You may use the default property to check the checkbox by default.

show_content:
    type: checkbox
    label: Display content
    default: true

Use the comment to display some accompanying text.

is_active:
    type: checkbox
    label: Active
    comment: Check this box to make the record active.
On This Page