Checkbox Field
Config
Option | Description |
|---|---|
| To be used as the property name when stored and retrieved from the database. More |
| Text used as a field label in the Admin panel or an object with keys for each language. |
| Provide a custom validation function that will be executed on both the Admin panel and the backend. More |
| Build an index for this field to produce faster queries. Set this field to |
| If this field is top-level and nested in a config supporting Authentication, include its data in the user JWT. |
| Provide field-based hooks to control logic for this field. More |
| Provide field-based access control to denote what users can see and do with this field's data. More |
| Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel. |
| Provide data to be used for this field's default value, will default to false if field is also |
| Enable localization for this field. Requires localization to be enabled in the Base config. |
| Require this field to have a value. |
| Admin-specific configuration. See the default field admin config for more details. |
| Extension point for adding custom data (e.g. for plugins) |
\* An asterisk denotes that a property is required.
Example
collections/ExampleCollection.ts