ILabelProps

interface
Form & Input

Props for <OrigamLabel> — the accessible label component used by form fields. Supports floating labels, required indicators, custom tag, and the full color, border, rounded, spacing surface.

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.

text
string
Label text content. Overridden by the default slot.
floating
boolean
Activates the floating label style, typically moving the label above the input on focus or when a value is present.
required
boolean
Appends a required indicator (asterisk) and sets the aria-required attribute on the label.
name
string
Associates the label with a form control by name (rendered as a for attribute).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Floating required label

vue