Skip to content

Input Checkbox

anidivr edited this page Oct 30, 2022 · 1 revision

Basic checkbox

image

Code

Inputs

Name Type Default Description
checked boolean false When true, checkbox is visible. When false, checkbox is not visible
enabled boolean true When true, state can be changed. When false, interaction is disabled
width number 0.1 Width and height of checkbox in meters
backgroundmaterial Material Theme button material (color #505050) Background material. Set to override with custom material
disabledmaterial Material Theme disabled material (color #666666) Disabled material. Set to override with custom material
outlinematerial LineBasicMaterial Theme outline material (color white) Outline material. Set to override with custom material
checkmaterial Material Theme checkbox material (color cornflowerblue) Checkbox material. Set to override with custom material
selectable InteractiveObjects undefined Add to list of objects ray caster can test for overlap
geometry BufferGeoemtry Rounded rectangle shape Override to provide your own background geometry
checkgeometry BufferGeometry Plane Geometry Override to provide your own checkbox geometry

Outputs

Name Type Description
change boolean Triggered when check state changes. True when checked, false when unchecked

Examples

<flat-ui-input-checkbox [position]="[0.4, 0, 0]" [checked]="checked" [selectable]="selectable" (change)="changed($event)">
</flat-ui-input-checkbox>
Clone this wiki locally