IBadgeProps
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
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
Héritage
Hérite de
Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- contentnumber | string
- Text or number rendered inside the badge pill. When omitted the badge shows as an unlabelled dot.
- dotboolean
- Forces a minimal dot badge regardless of the content prop.
- floatingboolean
- Positions the badge absolutely over the top-right corner of its parent (default floating behaviour).
- inlineboolean
- Renders the badge inline with adjacent content instead of positioned absolutely.
- labelstring
- Accessible aria-label for the badge (for screen readers when content is a number).
- maxnumber | string
- Maximum numeric value to display. When content exceeds max, renders "{max}+" (e.g. "99+").
- modelValueboolean
- Controls the visibility of the badge via v-model.
- offsetXnumber | string
- Horizontal offset from the anchor edge in pixels or CSS length.
- offsetYnumber | string
- Vertical offset from the anchor edge in pixels or CSS length.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Notification badge with max cap