ICheckboxBtnProps
interface
Form & Input
Props for <OrigamCheckboxBtn>. Extends ISelectionControlProps with indeterminate state support — the third visual state between checked and unchecked.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- indeterminateboolean
- Puts the checkbox into an indeterminate state (neither checked nor unchecked). Typically used for a parent checkbox when children are in a mixed state.
- indeterminateIconTIcon
- Icon displayed when the checkbox is in the indeterminate state. Defaults to the DS minus/dash glyph.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Indeterminate parent checkbox