IBadgeProps

interface
Component Props

Full props contract for <OrigamBadge> — a floating status indicator anchored to a child element. Supports numeric content, dot mode, floating/inline placement, offset, v-model visibility, and the full color/border/rounded/elevation/transition design 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.

content
number | string
Text or number rendered inside the badge pill. When omitted the badge shows as an unlabelled dot.
dot
boolean
Forces a minimal dot badge regardless of the content prop.
floating
boolean
Positions the badge absolutely over the top-right corner of its parent (default floating behaviour).
inline
boolean
Renders the badge inline with adjacent content instead of positioned absolutely.
label
string
Accessible aria-label for the badge (for screen readers when content is a number).
max
number | string
Maximum numeric value to display. When content exceeds max, renders "{max}+" (e.g. "99+").
modelValue
boolean
Controls the visibility of the badge via v-model.
offsetX
number | string
Horizontal offset from the anchor edge in pixels or CSS length.
offsetY
number | string
Vertical offset from the anchor edge in pixels or CSS length.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Notification badge with max cap

vue