ICounterProps

interface
Component Props

Full props contract for <OrigamCounter> — a numeric badge that clamps to a max value, with the full design surface (color, border, spacing, elevation, density, rounded, transition).

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.

active
boolean
When true the counter is visible. When false it is hidden.
disabled
boolean
Disables the counter, muting its interactive appearance.
max
string | number
Maximum displayable value. When `value` exceeds `max`, the counter displays `{max}+`.
value
string | number
Numeric value to display inside the counter badge.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Counter with a max cap

vue