Components

Checkbox

The Checkbox Component.

The checkbox component represents a toggleable checkbox. It can display text alongside the checkbox.

Parameters

text
string
The text to display next to the checkbox.
checked
boolean
Whether the checkbox is checked or not.
active
boolean
Whether the checkbox is active or not.

Examples

Components.checkbox(Text.literal("Option"), true)
    .active(false)
Copyright © 2026