Usage

Badge provides five general variants: light, core, dark, outline, and dark-outline. Each variant has five color variants controlled by the colorVariant prop.

There is also the industryUpsell variant with its own set of color variants.

Note: The following variant and colorVariant combinations list the revised options in our design system.

import { Badge } from '@houzz/ui';

Size

Use the size prop to select from available size variants.

Color

Use the colorVariant to change color combinations.

Props

Badge
System Props

Badge composes Box and has all system props available

  • COMMON
  • TYPOGRAPHY
  • BORDER
  • LAYOUT
  • POSITION
  • FLEX
  • GRID
  • Learn More
NameTypeDescription
gradientResponsiveValue<TLengthStyledSystem, Required<Theme<TLengthStyledSystem>>>-
variant"light" | "core" | "dark" | "industryUpsell" | "outline" | "outline-dark"Type of badge
core
colorVariant"accent" | "neutral" | "danger" | "warning" | "success" | "promotionalOffer" | "featureHighlighting" | "upgrade" | "premium"Color variant
accent
iconReactNodeIcon to show before label

Accessibility