ISwitchProps

interface
Forms & Inputs

Full prop surface for <OrigamSwitch> — extends selection-control, input, color, border, elevation, density, margin/padding, rounded and active/hover contracts, with three switch-specific facets: indeterminate, inset and flat.

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.

indeterminate
boolean
Puts the switch in a three-state (indeterminate) mode — neither ON nor OFF.
inset
boolean
Enables the Material inset variant — taller, fully-rounded rail with inner thumb.
flat
boolean
Removes elevation and border from the switch track surface.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Indeterminate three-state switch

html