BooleanInput

Collects a boolean as a switch.

Open in Storybook

In a filter the dispatcher swaps it for TriStateBooleanInput, a three-way toggle — a checkbox cannot express “I don't care”, which is what an unset filter means.

Example

<BooleanInput source="is_available" />

Props

The component wraps React Admin's BooleanInput and forwards its props; it only fixes the margins so the control lines up with the text inputs around it.

Name	Type	Default	Description
source (required)	string	—	Name of the field in the form record
label	string | ReactElement | false	label from the schema	false hides the label
helperText	string | ReactElement | false	helpText from the schema	Text under the input
defaultValue	boolean	defaultValue from the schema	Initial value in a create form
disabled	boolean	false	Disables the switch

TriStateBooleanInput

Name	Type	Default	Description
source (required)	string	—	Name of the filter
label	string | ReactElement | false	label from the schema	false hides the label next to the toggle

The three positions store true, false and ''. The empty string is what clears the filter — undefined would leave the previous value in place.

Schema mapping

Any field with type: "boolean":

{"name": "is_available", "type": "boolean", "defaultValue": true}

Python

class Product(models.Model):
    is_available = models.BooleanField(default=True)

Ruby

See also

• BooleanField — the display counterpart