UICheckbox
Defined in: ui/src/UICheckbox.ts:27
Interactive checkbox with optional label.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UICheckbox(
props):UICheckbox
Defined in: ui/src/UICheckbox.ts:56
Parameters
Section titled “Parameters”Returns
Section titled “Returns”UICheckbox
Overrides
Section titled “Overrides”Properties
Section titled “Properties”_transform
Section titled “_transform”
readonly_transform:ElementTransform
Defined in: ui/src/UIElementBase.ts:20
Internal
Inherited from
Section titled “Inherited from”container
Section titled “container”
readonlycontainer:DisplayContainer
Defined in: ui/src/UICheckbox.ts:28
yogaNode
Section titled “yogaNode”
readonlyyogaNode:Node
Defined in: ui/src/UICheckbox.ts:29
Overrides
Section titled “Overrides”Accessors
Section titled “Accessors”checked
Section titled “checked”Get Signature
Section titled “Get Signature”get checked():
boolean
Defined in: ui/src/UICheckbox.ts:211
Returns
Section titled “Returns”boolean
disabled
Section titled “disabled”Get Signature
Section titled “Get Signature”get disabled():
boolean
Defined in: ui/src/UICheckbox.ts:216
Whether the checkbox refuses the pointer and a confirm press.
Returns
Section titled “Returns”boolean
displayObject
Section titled “displayObject”Get Signature
Section titled “Get Signature”get displayObject():
DisplayContainer
Defined in: ui/src/UICheckbox.ts:31
Returns
Section titled “Returns”DisplayContainer
Overrides
Section titled “Overrides”focusable
Section titled “focusable”Get Signature
Section titled “Get Signature”get focusable():
boolean
Defined in: ui/src/UICheckbox.ts:226
Whether the checkbox takes part in focus navigation.
Returns
Section titled “Returns”boolean
focused
Section titled “focused”Get Signature
Section titled “Get Signature”get focused():
boolean
Defined in: ui/src/UICheckbox.ts:221
Whether the checkbox holds focus in the scope that owns it.
Returns
Section titled “Returns”boolean
rotation
Section titled “rotation”Get Signature
Section titled “Get Signature”get rotation():
number
Defined in: ui/src/UIElementBase.ts:50
See LayoutProps.rotation.
Returns
Section titled “Returns”number
Set Signature
Section titled “Set Signature”set rotation(
value):void
Defined in: ui/src/UIElementBase.ts:54
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Get Signature
Section titled “Get Signature”get scale():
Readonly<{x:number;y:number; }>
Defined in: ui/src/UIElementBase.ts:41
See LayoutProps.scale.
Returns
Section titled “Returns”Readonly<{ x: number; y: number; }>
Set Signature
Section titled “Set Signature”set scale(
value):void
Defined in: ui/src/UIElementBase.ts:45
Parameters
Section titled “Parameters”number | { x: number; y: number; }
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”transformOrigin
Section titled “transformOrigin”Get Signature
Section titled “Get Signature”get transformOrigin():
Readonly<{x:number;y:number; }>
Defined in: ui/src/UIElementBase.ts:32
See LayoutProps.transformOrigin.
Returns
Section titled “Returns”Readonly<{ x: number; y: number; }>
Set Signature
Section titled “Set Signature”set transformOrigin(
value):void
Defined in: ui/src/UIElementBase.ts:36
Parameters
Section titled “Parameters”number | { x: number; y: number; }
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”visible
Section titled “visible”Get Signature
Section titled “Get Signature”get visible():
boolean
Defined in: ui/src/UICheckbox.ts:202
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set visible(
v):void
Defined in: ui/src/UICheckbox.ts:206
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”zIndex
Section titled “zIndex”Get Signature
Section titled “Get Signature”get zIndex():
number
Defined in: ui/src/UIElementBase.ts:59
See LayoutProps.zIndex.
Returns
Section titled “Returns”number
Set Signature
Section titled “Set Signature”set zIndex(
value):void
Defined in: ui/src/UIElementBase.ts:63
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”_inspectState()
Section titled “_inspectState()”_inspectState():
object
Defined in: ui/src/UICheckbox.ts:321
Internal
Returns
Section titled “Returns”object
checked
Section titled “checked”checked:
boolean
disabled
Section titled “disabled”disabled:
boolean
focusable
Section titled “focusable”focusable:
boolean
focused
Section titled “focused”focused:
boolean
pressed
Section titled “pressed”pressed:
boolean
activate()
Section titled “activate()”activate():
void
Defined in: ui/src/UICheckbox.ts:178
Toggle the box and fire onChange. The click path and the focus scope’s
confirm both come through here. update({ checked }) sets the value
silently.
Returns
Section titled “Returns”void
applyLayout()
Section titled “applyLayout()”applyLayout():
void
Defined in: ui/src/UICheckbox.ts:190
Follow the box layout gave this row, which is what the outline rings.
Returns
Section titled “Returns”void
applyTransformProps()
Section titled “applyTransformProps()”
protectedapplyTransformProps(props):void
Defined in: ui/src/UIElementBase.ts:27
Apply the four transform props present in props. A present key holding
undefined resets that prop to its default. Throws before writing
anything if a value is not finite.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”UIElementBase.applyTransformProps
destroy()
Section titled “destroy()”destroy():
void
Defined in: ui/src/UICheckbox.ts:338
Idempotent — a second call is a no-op.
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”setDisabled()
Section titled “setDisabled()”setDisabled(
v):void
Defined in: ui/src/UICheckbox.ts:230
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
update()
Section titled “update()”update(
p):void
Defined in: ui/src/UICheckbox.ts:245
Parameters
Section titled “Parameters”Partial<UICheckboxProps>
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/ui.md.