IBtnProps

interface
Component Props

Props for <OrigamBtn> — the primary action component. Supports all visual surfaces (color, bgColor, border, elevation, rounded, size, density, dimension, padding, margin), link navigation, ripple, loader, position, location, group membership, adjacent icons, status, hover, and variant.

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.

flat
boolean
Deprecated — use variant="flat" instead. Kept for backward compatibility.
active
boolean | IActiveState
Forces the active (pressed) visual state.
icon
boolean | TIcon
Icon-only mode when boolean true, or explicit icon name. Removes text padding and makes the button square.
block
boolean
Makes the button span the full width of its container.
slim
boolean
Reduces horizontal padding for a compact appearance.
stacked
boolean
Stacks icon above text in a column layout.
wrap
boolean
text
string
Button label text — alternative to default slot.
status
TStatus
statusIconPosition
TStatusPosition

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Primary action button with icon

html