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.
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.
- activeboolean
- When true the counter is visible. When false it is hidden.
- disabledboolean
- Disables the counter, muting its interactive appearance.
- maxstring | number
- Maximum displayable value. When `value` exceeds `max`, the counter displays `{max}+`.
- valuestring | 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