UICheckbox
Defined in: ui/src/UICheckbox.ts:15
Interactive checkbox with optional label.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UICheckbox(
props):UICheckbox
Defined in: ui/src/UICheckbox.ts:34
Parameters
Section titled “Parameters”Returns
Section titled “Returns”UICheckbox
Properties
Section titled “Properties”container
Section titled “container”
readonlycontainer:DisplayContainer
Defined in: ui/src/UICheckbox.ts:16
yogaNode
Section titled “yogaNode”
readonlyyogaNode:Node
Defined in: ui/src/UICheckbox.ts:17
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”checked
Section titled “checked”Get Signature
Section titled “Get Signature”get checked():
boolean
Defined in: ui/src/UICheckbox.ts:106
Returns
Section titled “Returns”boolean
displayObject
Section titled “displayObject”Get Signature
Section titled “Get Signature”get displayObject():
DisplayContainer
Defined in: ui/src/UICheckbox.ts:19
Returns
Section titled “Returns”DisplayContainer
Implementation of
Section titled “Implementation of”visible
Section titled “visible”Get Signature
Section titled “Get Signature”get visible():
boolean
Defined in: ui/src/UICheckbox.ts:97
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set visible(
v):void
Defined in: ui/src/UICheckbox.ts:101
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
void
Defined in: ui/src/UICheckbox.ts:179
Idempotent — a second call is a no-op.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”setDisabled()
Section titled “setDisabled()”setDisabled(
v):void
Defined in: ui/src/UICheckbox.ts:110
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
update()
Section titled “update()”update(
p):void
Defined in: ui/src/UICheckbox.ts:117
Parameters
Section titled “Parameters”Partial<UICheckboxProps>
Returns
Section titled “Returns”void