Skip to content
Velkin LogoVelkin Logo
Velkin
VELKIN/UI

Modern UI components for product teams and their AI agents. Lit core, typed wrappers, live MCP.

sales@velkinui.com

Product

  • Docs
  • Components
  • Studio
  • Pricing

Resources

  • Quick start
  • Blog
  • Changelog
  • Roadmap
  • Status

Project

  • About
  • Contact
  • License
  • Privacy
  • Terms

© 2026 Velkin. MIT core · Pro licenses available.

VELKIN

Badge

A badge component for counts, status dots, and overlay marks.

vu-badge · @velkin/react/badge

Copy page

Import

React
npm i @velkin/react

import { VuBadge } from "@velkin/react/badge";

Examples

API

Props

PropTypeDefaultDescription
valuestring""Count or short text fallback.
maxnumber99Cap numeric values to `N+`; `0` disables. Default: `99`.
dotbooleanfalsePure-dot mode. Default: `false`.
sizeVuBadgeSize"md"Pill scale (`sm`|`md`|`lg`; shared core with button). Default: `"md"`.
colorVuBadgeColor"danger"Intent palette; defaults to `"danger"` for count/alert marks. Default: `"danger"`.
placementVuBadgePlacement"top-right"Corner anchor. Default: `"top-right"`.
offsetstring""CSS-length nudge from the anchor corner.
borderedbooleantrueColored ring with halo cutout. Default: `true`.
showbooleantrueExplicit visibility toggle. Default: `true`.
hideOnZerobooleanfalseAuto-hides when numeric `value` is 0 (`hideonzero` attr). Default: `false`.
processingbooleanfalseOutward pulse animation. Default: `false`.
disabledbooleanfalseDims the badge. Default: `false`.
labelstring""Accessible name override.

Slots

SlotDescription
—- Anchor content the badge overlays.
markCustom badge glyph; ignored when `dot` is true.

CSS parts

PartDescription
baseWrapper holding anchor and badge.
badgeOverlaid pill or dot.

Types

NameDefinition
VuBadgeColor
"default" | "primary" | "success" | "warning" | "danger"
VuBadgePlacement
"top-right"
| "top-left"
| "bottom-right"
| "bottom-left"
| "top-center"
VuBadgeSize
"sm" | "md" | "lg"

Related

Data display

  • AvatarAn avatar component with image, initials, icon, or custom content.
  • Avatar GroupAn avatar group component that stacks overlapping avatars.
  • ChipA chip component for tags and filters with dismiss or toggle actions.
  • Data TableA data table component with sorting, filtering, and selection.
  • DividerA divider component for horizontal or vertical layout separation.
  • File ViewerA file viewer component for previewing uploaded or linked files.

Guides

  • AppearanceShared visual props
  • EventsSelection and change events

Browse

  • Previous: Avatar GroupEarlier in the sidebar
  • Next: ChipLater in the sidebar
  • All componentsBrowse the full index