Skip to content

OrigamBadge ​

<OrigamBadge> is the floating notification chip you stick on top of another element to surface a count, a status, or an unread indicator. The host element is rendered through the default slot — the chip is absolutely positioned on top of it and shows / hides via the modelValue prop.

Basic usage ​

vue
<template>
    <OrigamBadge :model-value="true" :content="3">
        <OrigamAvatar text="AP" />
    </OrigamBadge>
</template>

Content ​

content accepts a number, a string, or any printable value. Set max to clamp the rendered number (the badge then prints {max}+).

vue
<template>
    <OrigamBadge :model-value="true" :content="42" :max="9" />
    <OrigamBadge :model-value="true" content="NEW" />
</template>

Dot mode ​

dot collapses the chip into a 9-pixel circle without content. Use this for "something happened" indicators where the count itself is not meaningful.

vue
<template>
    <OrigamBadge :model-value="true" dot />
</template>

Inline ​

inline swaps the chip from absolute positioning to inline flow, which makes it act as a tag inside a paragraph.

vue
<template>
    <p>
        Status:
        <OrigamBadge :model-value="true" inline content="active" />
    </p>
</template>

Floating ​

floating shifts the chip outside the bounding box of the host element instead of overlapping it. Useful for circular hosts (avatars) where overlap would crop the badge.

vue
<template>
    <OrigamBadge :model-value="true" floating :content="3">
        <OrigamAvatar text="AP" />
    </OrigamBadge>
</template>

Location ​

location accepts any of the origam anchor strings ('top right', 'bottom left', 'top center', …). Combine with offsetX / offsetY for fine-grained nudging without breaking the cardinal axis.

vue
<template>
    <OrigamBadge :model-value="true" location="top right" :content="2">
        <OrigamAvatar text="AP" />
    </OrigamBadge>
    <OrigamBadge :model-value="true" location="bottom left" dot>
        <OrigamAvatar text="AP" />
    </OrigamBadge>
</template>

Status ​

status applies the feedback intent ladder — same semantic tokens as OrigamAvatar. The colour pair --origam-color__feedback--{intent}---{bg|fg} keeps the badge readable in both light and dark themes.

vue
<template>
    <OrigamBadge :model-value="true" status="success" :content="1" />
    <OrigamBadge :model-value="true" status="warning" :content="1" />
    <OrigamBadge :model-value="true" status="error"   :content="1" />
    <OrigamBadge :model-value="true" status="info"    :content="1" />
</template>

Color (intent) ​

Outside of the status helper, color and bg-color accept the same intent ladder as the rest of origam.

vue
<template>
    <OrigamBadge :model-value="true" bg-color="primary" :content="1" />
    <OrigamBadge :model-value="true" bg-color="secondary" :content="1" />
</template>

Icon ​

Pass icon to render an icon glyph instead of content. The slot badge lets you fully override the visual.

vue
<template>
    <OrigamBadge :model-value="true" :icon="MDI_ICONS.HEART">
        <OrigamAvatar text="AP" />
    </OrigamBadge>
</template>

Prepend / append ​

prependIcon / appendIcon / prependAvatar / appendAvatar add a leading or trailing glyph on either side of the badge content — the standard IAdjacentProps surface shared with OrigamBtn / OrigamAlert / OrigamChip. Both sides can be set at once. The prepend / append slots override the icon/avatar with fully custom content.

vue
<template>
    <OrigamBadge
        :model-value="true"
        :content="3"
        :prepend-icon="MDI_ICONS.CHEVRON_LEFT"
        :append-icon="MDI_ICONS.CHEVRON_RIGHT"
    >
        <OrigamAvatar text="AP" />
    </OrigamBadge>
</template>

Clicking either side emits click:prepend / click:append — useful to wire a dismiss or drill-down action without swallowing clicks on the host element itself.

Rounded / border / elevation ​

The same chrome mixins as the rest of origam apply to the badge chip itself.

vue
<template>
    <OrigamBadge :model-value="true" :content="1" border />
    <OrigamBadge :model-value="true" :content="1" rounded="default" />
    <OrigamBadge :model-value="true" :content="1" :elevation="4" />
</template>

Slots ​

SlotSlot propsDescription
default—The host element the badge attaches to.
badge—Override the badge chip content (icon / text / custom).
prepend—Override the leading icon/avatar (see prependIcon / prependAvatar).
append—Override the trailing icon/avatar (see appendIcon / appendAvatar).

Events ​

EventPayloadDescription
update:hoverbooleanHover toggled on mouse enter / leave.
click:prependMouseEventThe leading (prepend) icon/avatar/slot was clicked.
click:appendMouseEventThe trailing (append) icon/avatar/slot was clicked.

Props (interface) ​

ts
interface IBadgeProps extends ICommonsComponentProps, ITagProps,
    IBorderProps, IColorProps, ILocationProps, IRoundedProps,
    ITransitionComponentProps, IStatusProps, IHoverProps,
    IElevationProps, ITypographyProps, IAdjacentProps {
    content?: number | string
    dot?: boolean
    floating?: boolean
    inline?: boolean
    label?: string         // i18n key for aria-label, defaults to 'origam.badge'
    max?: number | string
    modelValue?: boolean
    offsetX?: number | string
    offsetY?: number | string
}

Adjacent props (IAdjacentProps) ​

PropTypeDescription
prependIconTIconLeading icon, rendered before the content.
appendIconTIconTrailing icon, rendered after the content.
prependAvatarstringLeading avatar image URL.
appendAvatarstringTrailing avatar image URL.

Typography props ​

Bound on the __badge pill (the visible surface). Both props have a real visual effect because the __badge SCSS block reads their matching CSS variables.

PropTypeDefaultCSS variable
fontSizeTFontSize—--origam-badge__badge---font-size
fontWeightTFontWeight—--origam-badge__badge---font-weight

Anatomy ​

html
<div class="origam-badge origam-badge--{status} origam-badge--floating">
    <div class="origam-badge__wrapper">
        <!-- default slot — the host element -->
        <span class="origam-badge__badge" role="status"
              aria-live="polite" aria-atomic="true">
            <!-- icon or content -->
        </span>
    </div>
</div>

Design tokens consumed ​

CSS variablePurpose
--origam-badge__badge---background-color / --origam-badge__badge---colorDefault chrome of the chip.
--origam-badge__badge---border-radius / --origam-badge__badge---border-widthChrome shape.
--origam-badge__badge---font-size / --origam-badge__badge---font-weightNumber rendering.
--origam-badge__badge---height / --origam-badge__badge---min-widthChip metrics.
--origam-badge__badge---padding-block-* / --origam-badge__badge---padding-inline-*Chip padding.
--origam-badge--{intent}---background-color / --origam-badge--{intent}---colorPer-status palette.
--origam-badge__wrapper---*Host wrapper layout (display, padding, margin).

The full list lives in packages/ds/src/assets/css/tokens/light.css and dark.css (SCSS twins under packages/ds/src/assets/scss/tokens/) — grep for --origam-badge.

Accessibility ​

  • The chip carries role="status", aria-live="polite", and aria-atomic="true". Screen readers announce updates as they happen (e.g. counter increments) without re-announcing the host.
  • aria-label announces the badge's content directly (e.g. "3", "NEW") when it has one, re-announcing it whenever it changes (paired with role="status" / aria-live="polite"). In dot mode and icon-only mode, where there is no textual content to read, it falls back to the translated label i18n key (defaults to origam.badge → "Badge").
  • Override label to pass a tailored localised string for the fallback case, or when the numeric content alone is not informative enough ("3 unread messages" rather than "3").

Theming notes ​

  • Status colours come from the shared --origam-color__feedback--*---* semantic tokens, so theme switching is automatic.
  • For one-off styling, the SCSS exposes --origam-badge__badge---background-color / --origam-badge__badge---color as instance-level overrides via :style.
  • OrigamAvatar — common host for the badge.
  • OrigamChip — inline counterpart for tag-like UI.
  • OrigamIcon — used internally when icon is set.