Checkbox

Checkbox is a check box with its label beside it, for lists of independent yes/no choices such as what to include in an export.

A check box with its label to the right. It holds the same kind of value as a Toggle, drawn differently: use check boxes for lists of independent yes/no choices, a toggle for settings.

Checkbox.builder("includeKeys")
        .label(Text.translatable("mymod.includeKeys", "Include key bindings"))
        .value(() -> export.includeKeys)
        .onChange(checked -> export.includeKeys = checked)
        .build();

Builder#

Behaviour#

• A click calls onChange with the opposite of value; the box shows the new state only if value returns it.
• From 1.16 it is vanilla's own check box; older versions get an equivalent drawing.
• Footer: no.

Test it#

host.click("includeKeys");

Rendered as [checkbox includeKeys] [x] Include key bindings, or [ ] while unchecked.

See also#

• Javadoc: Checkbox