Checkbox

Introduction

Checkbox stores a boolean — consent flags, feature toggles, and admin gates. Prefer Toggle when you want switch styling, or Checkbox list when users pick many keys from a set. Cast the model attribute to bool so dehydrated True / False round-trip cleanly.

Each variation below includes a short explanation, the fluent API to paste into your schema, and light/dark screenshots of the rendered control.

Basic checkbox

The default layout places the label beside the box. The field name is the wire path; the label is display-only chrome.

app/orbit/resources/user_resource.py

Checkbox.make('terms')
    .label('Accept terms and conditions')

Inline label

.inline() is the default: the label sits beside the checkbox on one row. Pass .inline(False) to stack the label above the checkbox when the copy is long or you want field alignment with stacked text inputs.

app/orbit/resources/user_resource.py

Checkbox.make('is_admin')
    .label('Administrator')
    .inline(False)

Default value

.default(True) pre-checks the box on create forms when no dehydrated state exists yet. Use sparingly — defaults that opt users into marketing or elevated roles are easy to miss.

app/orbit/resources/user_resource.py

Checkbox.make('subscribe')
    .label('Subscribe to product updates')
    .default(True)

Required

.required() marks the field and adds a required validation rule so submit fails when the box is unchecked — typical for terms acceptance.

app/orbit/resources/user_resource.py

Checkbox.make('terms')
    .label('I agree to the terms of service')
    .required()

Disabled

.disabled() renders a non-interactive checkbox for read-only review screens or when permission checks forbid edits. State still dehydrates if present.

app/orbit/resources/user_resource.py

Checkbox.make('verified')
    .label('Email verified')
    .disabled()

Closures work on .label(), .helper_text(), .placeholder(), .visible(), .disabled(), and .required() where applicable — see Form closures.