Do you like balloons?
<orb-checkbox required checked="mixed">Do you like balloons?</orb-checkbox>

Properties

checked

Description Whether or not the checkbox is active
Attribute checked
Type "false" | "mixed" | "true"
Default "false"

defaultChecked

Description Original value form will reset to
Attribute default-checked
Type "false" | "mixed" | "true"
Default undefined

labelPlacement

Description Whether or not the label should go before or after the checkbox
Attribute label-placement
Type "end" | "start"
Default "end"

ready

Description A promise that resolves when the component has completed it’s initial render
Attribute –
Type Promise<unknown>
Default new Promise((res) => (this.#resolve = res))

required

Description Marks the control as required in the form. This will only affect indeterminate checkboxes.
Attribute required
Type boolean
Default false

value

Description By default, it will submit true or false depending on the checked state. Use this property to submit a custom value instead.
Attribute value
Type string
Default undefined

Events

orbCheckedChange

Description Emits the current value whenever it’s state changes
Type CustomEvent<"false" | "mixed" | "true">

Custom States

State Initial Value Description
:state(optional) true
:state(required) false

Dependencies

Used by

Graph

graph TD; orb-calendar --> orb-checkbox orb-cell --> orb-checkbox orb-grid --> orb-checkbox style orb-checkbox fill:#f9f,stroke:#333,stroke-width:4px