Checkbox

Use the checkbox() function to add a checkbox control to your scene.

const isRed = checkbox("Is red?");

update(() => {
    sphere(32)
        .color(isRed.value() ? "red" : "cyan");
});

Initial value

Set the optional initial value. By default, the initial value is false.

// Sets initial value to true
checkbox("Is red?", true);

Callback

You can provide a callback function that gets called whenever the checkbox value changes.

checkbox("Is red?", null, (value) => {
    console.log("Checkbox value changed to:", value);
});

Returns the Checkbox object:

checkboxObject.setValue(true);
const isChecked = checkboxObject.value();

container: HTMLDivElement

checkboxObject.container.style.borderColor = "teal";

checkbox: HTMLInputElement

checkboxObject.checkbox.style.backgroundColor = "yellow";

label: HTMLLabelElement | null

if (checkboxObject.label) {
    checkboxObject.label.textContent = "Visible";
}

value(): boolean

const isChecked = checkboxObject.value();

setValue(value: boolean): void

checkboxObject.setValue(false);