# `Cinder.Filters.Checkbox`
[🔗](https://github.com/sevenseacat/cinder/blob/v0.16.0/lib/cinder/filters/checkbox.ex#L1)

Checkbox filter implementation for Cinder tables.

Provides single checkbox filtering for boolean and non-boolean fields.
When checked, applies an equality filter with the configured value.
When unchecked, no filter is applied (shows all records).

## Examples

    # Boolean field - value defaults to true
    <:col field="published" filter={[type: :checkbox, label: "Show published only"]} />

    # Non-boolean field - explicit value required
    <:col field="status" filter={[type: :checkbox, value: "published", label: "Show published only"]} />

    # Legacy format (still supported)
    <:col field="active" filter={:checkbox} filter_options={[value: true, label: "Active accounts only"]} />

## Filter Options

- `value` - The value to filter by when checked (defaults to `true` for boolean fields)
- `label` - Display text for the checkbox (required)

---

*Consult [api-reference.md](api-reference.md) for complete listing*