IActiveProps

interface
State & Interaction

Controls the active/selected state of a component — accepts a boolean to force the state on, or an IActiveState object to override visual props (color, bgColor, border…) only while the state is engaged.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

active
boolean | IStateEffectConfig
When true forces the component into its active state. When an IActiveState object, applies prop overrides (color, bgColor, border, rounded, elevation, padding, margin, gap) only while active.
activeClass
string
Additional CSS class applied to the root element while the component is active.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Using active with an object override

vue