Log inGet started
World

Builtin Library

Branchmain
Branchesmainpublish
Commitdd348ac6c3

README.md

checkbox

Check-mark style boolean input with a trailing label.

Exports

  • checkbox(label: string?, id: string?, checked: any?, opts: CheckboxOpts?) -> WidgetNode — build a checkbox widget node.

Types:

  • CheckboxOpts = { props?, onChange?, style? }

Usage

local checkbox = require("@builtin::modules.zui.widget.checkbox")

checkbox("Enabled", "cb1", true, { onChange = "cb1:change" })

Notes

  • Initial checked is coerced via value == true — anything that isn't strictly true becomes false.
  • onChange receives a ValueChanged(boolean) event when the user toggles the box.