ISelectionControlProps
Props for <OrigamSelectionControl>, the base component shared by Checkbox, Switch, and Radio. Extends commons, a partial of the group props (excluding items), color, bgColor, active/hover state, and density, then adds individual control-level bindings: label, trueValue, falseValue, value, and required.
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.
- labelstring
- Text label rendered beside the control.
- trueValueany
- The value emitted when the control is checked/on. Defaults to true.
- falseValueany
- The value emitted when the control is unchecked/off. Defaults to false.
- valueany
- The value contributed to a group modelValue when this control is checked (array mode).
- requiredboolean
- Marks the input as required for native form validation.
- disabledboolean
- activeColorTColor
- activeBgColorTColor
- errorstring | boolean
- namestring
- readonlyboolean
- typestring
- modelValueany
- valueComparator(a: any, b: any) => boolean
- falseIconTIcon
- trueIconTIcon
- multipleboolean
- inlineboolean
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
A checkbox with custom true/false values