ISelectionControlProps

interface
Form & Input

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.

typescript

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.

label
string
Text label rendered beside the control.
trueValue
any
The value emitted when the control is checked/on. Defaults to true.
falseValue
any
The value emitted when the control is unchecked/off. Defaults to false.
value
any
The value contributed to a group modelValue when this control is checked (array mode).
required
boolean
Marks the input as required for native form validation.
disabled
boolean
activeColor
TColor
activeBgColor
TColor
error
string | boolean
name
string
readonly
boolean
type
string
modelValue
any
valueComparator
(a: any, b: any) => boolean
falseIcon
TIcon
trueIcon
TIcon
multiple
boolean
inline
boolean

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

html