Skip to content

Checkbox

A checkbox lets users toggle a simple yes-or-no value.

Checkboxes are useful for flags such as published, active, confirmed, visible, billable, or requires approval. They are input components, so they read from and save to one field on the record.

When to Use It

Use a checkbox when the question has a clear true-or-false answer.

Checkboxes work best for simple flags where the unchecked state is just as meaningful as the checked state. If the choice is an on/off setting that users may expect to switch frequently, Switch may feel clearer. If users need to choose between several named options, use Radio or Select.

What Can Be Configured

Label

The label should describe the checked state clearly, such as "Published" or "Requires approval". Avoid labels that make the unchecked state ambiguous.

Behaviour

A checkbox can be made read-only when the value is controlled by a workflow or calculated elsewhere.

Layout

Single checkboxes can sit near related fields or be arranged with other checkbox options. The layout can be compact for dense forms or more spacious when the option needs emphasis.

Conditional Display

The checkbox can be shown only for relevant record types, statuses, or user roles.