Toggle Field

This is an advanced-use feature, and likely not something you'll need to configure. What you probably want is the content types reference!

The toggle field represents a true/false toggle. This field is typically used for boolean content values. You could use this to toggle a certain feature on the page on or off.

Options

REQUIRED
component
'toggle'

The name of the plugin component. Always 'toggle'


REQUIRED
name
string

The path to some value in the data being edited.


label
string

A human readable label for the field. Defaults to the name.


description
string

Description that expands on the purpose of the field or prompts a specific action.


toggleโ€‹Labels
boolean | { true: string; false: string }

Customize 'labels' next to the true / false states of the toggle. When true, the labels default to 'Yes' and 'No'. Alternatively, you can pass an object with the properties true and false with custom strings to render as labels.

Default is false.

All properties marked as REQUIRED must be specified for the field to work properly.

This interfaces only shows the keys unique to the date field. Visit the Field Config docs for a complete list of options.

Example: Published Flag

Below is an example of how a toggle field could be used to mark a blog post as published.