Basic Components

Chip

Represents a complex entity in a compact form, such as an attribute, tag, or contact. Chips can be interactive, allowing for user input or triggering actions.

Source Edit this page

Compact, monospace-leaning token for representing tags, attributes, filter values, or other discrete entities inline with text. Chips default to secondary appearance, outline variant, rounded shape, and mono font — tuned for code-adjacent and metadata contexts.

When to Use

Tags, labels, and keyword filters attached to a record.
Attribute or metadata pills inside cards and lists (versions, environments, IDs).
Removable selections inside an input or filter bar (combine with an inline icon).
Inline category markers in code samples and API tables — mono is the default.

When NOT to Use

For status indicators that need uppercase emphasis, prefer Badge (pill, uppercase, semibold by default).
For triggering actions or navigation, prefer Button or Link.
For inline code snippets, prefer Code.

Basic Usage

Each appearance prop maps to a semantic color from the active theme.

primarybrandaccentsecondarytertiarysuccessdangerwarninginfolinkinherit

<Row flexWrap>
  <Chip primary>primary</Chip>
  <Chip brand>brand</Chip>
  <Chip accent>accent</Chip>
  <Chip>secondary</Chip>
  <Chip tertiary>tertiary</Chip>
  <Chip success>success</Chip>
  <Chip danger>danger</Chip>
  <Chip warning>warning</Chip>
  <Chip info>info</Chip>
  <Chip link>link</Chip>
  <Chip inherit>inherit</Chip>
</Row>

Sizes

Chips come in five sizes — xs, sm, md (default), lg, xl. Size drives font-size, padding, gap, and border-radius simultaneously via CSS variables.

xssmmdlgxl

<Row flexWrap>
  <Chip xs>xs</Chip>
  <Chip sm>sm</Chip>
  <Chip>md</Chip>
  <Chip lg>lg</Chip>
  <Chip xl>xl</Chip>
</Row>

Variants

Chips can be styled as filled, outline (default), or ghost.

primarybrandaccentsecondary

<Col>
  <Row flexWrap>
    <Chip filled primary>primary</Chip>
    <Chip filled brand>brand</Chip>
    <Chip filled accent>accent</Chip>
    <Chip filled>secondary</Chip>
  </Row>
  <Row flexWrap>
    <Chip primary>primary</Chip>
    <Chip brand>brand</Chip>
    <Chip accent>accent</Chip>
    <Chip>secondary</Chip>
  </Row>
  <Row flexWrap>
    <Chip ghost primary>primary</Chip>
    <Chip ghost brand>brand</Chip>
    <Chip ghost accent>accent</Chip>
    <Chip ghost>secondary</Chip>
  </Row>
</Col>

Shapes

Chips support three border-radius styles: rounded (default), pill, and sharp.

roundedpillsharp

<Row flexWrap>
  <Chip>rounded</Chip>
  <Chip pill>pill</Chip>
  <Chip sharp>sharp</Chip>
</Row>

Font Family

Chips default to mono to fit code-adjacent contexts. Override with sans or serif when the surrounding copy calls for it.

v1.4.2Active userEditorial

<Row flexWrap>
  <Chip>v1.4.2</Chip>
  <Chip sans>Active user</Chip>
  <Chip serif>Editorial</Chip>
</Row>

With Icon

Drop an icon directly inside the chip — gap is on by default, so spacing is automatic.

Favorite Verified Blocked

<Row flexWrap>
  <Chip brand><Heart/> Favorite</Chip>
  <Chip success><CheckSquare/> Verified</Chip>
  <Chip danger><X/> Blocked</Chip>
</Row>

Tag and Filter Lists

The canonical chip pattern: a wrapping row of tokens that classify or filter content.

Article tags

typescriptreacttailwinddesign-systemsaccessibility

<Card>
  <Title>Article tags</Title>
  <Row flexWrap>
    <Chip>typescript</Chip>
    <Chip>react</Chip>
    <Chip>tailwind</Chip>
    <Chip>design-systems</Chip>
    <Chip>accessibility</Chip>
  </Row>
</Card>

Removable Chips

Pair a chip with an inline close icon to represent removable selections inside a filter bar.

typescript react blocked

<Row flexWrap>
  <Chip>typescript <X/></Chip>
  <Chip>react <X/></Chip>
  <Chip danger filled>blocked <X/></Chip>
</Row>

As Link

Pass href to render the chip as an <a> — useful for clickable tag listings. When href is set, the chip gains a keyboard focus-visible outline by default. Opt out with noFocusVisible.

typescript react tailwind

<Row flexWrap>
  <Chip href="#">typescript</Chip>
  <Chip href="#" brand>react</Chip>
  <Chip href="#" accent>tailwind</Chip>
</Row>

Customizing

Set app-wide Chip defaults with ThemeProvider's themeDefaults:

import { ThemeProvider, Chip } from '@vaneui/ui';

<ThemeProvider themeDefaults={{
  chip: { brand: true, filled: true, pill: true },
}}>
  <Chip>v2.0</Chip>
</ThemeProvider>

Add prop-conditional classes with extraClasses — applied whenever the matching boolean prop is active:

import { ThemeProvider, Chip } from '@vaneui/ui';

<ThemeProvider extraClasses={{
  chip: {
    danger: 'animate-pulse',
    success: 'shadow-sm',
  },
}}>
  <Chip danger>blocked</Chip>
</ThemeProvider>

Chip Props

Prop	Category	Default	Description
`accent`	Appearance		Accent color appearance (rose)
`brand`	Appearance		Brand color appearance (blue)
`danger`	Appearance		Danger color appearance (red)
`info`	Appearance		Info color appearance (cyan)
`inherit`	Appearance		Inherit appearance from parent — suppresses own data-appearance/data-variant, uses parent's CSS variables
`link`	Appearance		Link color appearance (blue, for hyperlinks)
`primary`	Appearance		Primary color appearance (gray)
`secondary`	Appearance	✓	Secondary color appearance (gray)
`success`	Appearance		Success color appearance (green)
`tertiary`	Appearance		Tertiary color appearance
`warning`	Appearance		Warning color appearance (amber)
`disabled`	Disabled		Disable the component — reduces opacity, changes cursor to not-allowed, and prevents interaction
`flex1`	Flex		Take up remaining space (= `flex-1`, i.e. `flex: 1 1 0%`)
`flexAuto`	Flex		Grow but respect intrinsic size (= `flex-auto`, i.e. `flex: 1 1 auto`)
`flexNone`	Flex		Don't grow and don't shrink (= `flex-none`, i.e. `flex: none`)
`heading`	Font Family		Heading font family (defaults to sans, independently customizable via --font-heading CSS variable)
`mono`	Font Family	✓	Monospace font family
`sans`	Font Family		Sans-serif font family (default)
`serif`	Font Family		Serif font family
`italic`	Font Style		Italic font style
`notItalic`	Font Style		Not italic (normal) font style
`black`	Font Weight		Black font weight (900)
`bold`	Font Weight		Bold font weight (700)
`extrabold`	Font Weight		Extra bold font weight (800)
`extralight`	Font Weight		Extra light font weight (200)
`light`	Font Weight		Light font weight (300)
`medium`	Font Weight		Medium font weight (500)
`normal`	Font Weight	✓	Normal font weight (400)
`semibold`	Font Weight		Semibold font weight (600)
`thin`	Font Weight		Thin font weight (100)
`inheritSize`	Inherit Size		Inherit font-size and line-height from the nearest parent typography element
`noInheritSize`	Inherit Size		Keep own font-size; do not inherit from parent
`noPadding`	Padding		Disable internal padding
`padding`	Padding	✓	Enable internal padding
`paddingX`	Padding		Enable only horizontal padding
`paddingY`	Padding		Enable only vertical padding
`pill`	Shape		Fully rounded corners (circular)
`rounded`	Shape	✓	Medium rounded corners (default)
`sharp`	Shape		No rounded corners (square)
`noShrink`	Shrink		Prevent the flex item from shrinking below its content size (= `shrink-0`)
`lg`	Size		Large size
`md`	Size	✓	Medium size (default)
`sm`	Size		Small size
`xl`	Size		Extra large size
`xs`	Size		Extra small size
`textCenter`	Text Align		Align text to center
`textJustify`	Text Align		Justify text
`textLeft`	Text Align		Align text to left
`textRight`	Text Align		Align text to right
`lineThrough`	Text Decoration		Add strikethrough/line-through decoration across text
`noUnderline`	Text Decoration		Remove text decoration (no underline, strikethrough, etc.)
`overline`	Text Decoration		Add overline decoration above text
`underline`	Text Decoration		Add underline decoration below text
`capitalize`	Text Transform		Capitalize first letter of each word
`lowercase`	Text Transform		Transform text to lowercase
`normalCase`	Text Transform		Normal text case (no transformation)
`uppercase`	Text Transform		Transform text to uppercase
`filled`	Variant		Filled variant - solid background with contrasting text color
`ghost`	Variant		Ghost variant - transparent background, no border, appearance-colored text, tinted hover background
`outline`	Variant	✓	Outline variant - transparent background with border and colored text (default)

Layout & utility props (gap, padding, hide, items, justify, ...) — documented on Common Props

Prop	Category	Default	Description
`border`	Border		Enable border on all sides
`borderB`	Border		Enable border on bottom
`borderL`	Border		Enable border on left
`borderR`	Border		Enable border on right
`borderT`	Border		Enable border on top
`borderX`	Border		Enable border on left and right
`borderY`	Border		Enable border on top and bottom
`noBorder`	Border		Disable all borders
`cursorDefault`	Cursor		Default cursor - standard arrow
`cursorMove`	Cursor		Move cursor - indicates draggable element
`cursorNone`	Cursor		No cursor - hides the cursor
`cursorNotAllowed`	Cursor		Not-allowed cursor - indicates disabled state
`cursorPointer`	Cursor		Pointer cursor - indicates clickable element
`cursorText`	Cursor		Text cursor - indicates selectable text
`cursorWait`	Cursor		Wait cursor - indicates loading/processing
`block`	Display		Block display - takes full width, new line
`contents`	Display		Contents display - element's box is removed, children display as if parent didn't exist
`flex`	Display		Flex display - flexbox container
`grid`	Display		Grid display - CSS grid container
`hidden`	Display		Hidden display - element is not visible
`inline`	Display		Inline display - flows with text
`inlineBlock`	Display		Inline-block display - inline but with block properties
`inlineFlex`	Display	✓	Inline-flex display - inline flexbox container
`inlineGrid`	Display		Inline-grid display - inline grid container
`table`	Display		Table display - behaves like table element
`tableCell`	Display		Table-cell display - behaves like td element
`column`	Flex Direction		Flex direction column (vertical)
`columnReverse`	Flex Direction		Flex direction column-reverse
`row`	Flex Direction		Flex direction row (horizontal)
`rowReverse`	Flex Direction		Flex direction row-reverse
`focusVisible`	Focus Visible		Enable focus-visible outline
`noFocusVisible`	Focus Visible		Disable focus-visible outline
`gap`	Gap	✓	Enable gap spacing between children
`noGap`	Gap		Disable gap spacing
`hAuto`	Height		Set height to auto
`hFit`	Height	✓	Set height to fit-content
`hFull`	Height		Set height to 100%
`hScreen`	Height		Set height to 100vh (viewport height), removes max-height constraint
`desktopHide`	Hide		Hide element on desktop devices and below (max-desktop: 80rem)
`mobileHide`	Hide		Hide element on mobile devices and below (max-mobile: 48rem)
`tabletHide`	Hide		Hide element on tablet devices and below (max-tablet: 64rem)
`itemsBaseline`	Items		Align items to baseline
`itemsCenter`	Items	✓	Align items to center
`itemsEnd`	Items		Align items to end (bottom/right)
`itemsStart`	Items		Align items to start (top/left)
`itemsStretch`	Items		Stretch items to fill container
`justifyAround`	Justify		Distribute items with space around them
`justifyBaseline`	Justify		Align items along their baseline on main axis
`justifyBetween`	Justify		Distribute items with space between them
`justifyCenter`	Justify		Center items along the main axis
`justifyEnd`	Justify		Pack items toward the end of the main axis
`justifyEvenly`	Justify		Distribute items with equal space around them
`justifyStart`	Justify		Pack items toward the start of the main axis
`justifyStretch`	Justify		Stretch items to fill the main axis
`overflowAuto`	Overflow		Auto overflow - show scrollbars if needed
`overflowClip`	Overflow		Clip overflow - hard clip without scrollbars
`overflowHidden`	Overflow		Hidden overflow - clip content without scrollbars
`overflowScroll`	Overflow		Scroll overflow - always show scrollbars
`overflowVisible`	Overflow		Visible overflow - content extends beyond bounds
`overflowXAuto`	Overflow		Auto overflow on X-axis only
`overflowXClip`	Overflow		Clip overflow on X-axis only
`overflowXHidden`	Overflow		Hidden overflow on X-axis only
`overflowXScroll`	Overflow		Scroll overflow on X-axis only
`overflowXVisible`	Overflow		Visible overflow on X-axis only
`overflowYAuto`	Overflow		Auto overflow on Y-axis only
`overflowYClip`	Overflow		Clip overflow on Y-axis only
`overflowYHidden`	Overflow		Hidden overflow on Y-axis only
`overflowYScroll`	Overflow		Scroll overflow on Y-axis only
`overflowYVisible`	Overflow		Visible overflow on Y-axis only
`absolute`	Position		Absolute positioning
`fixed`	Position		Fixed positioning
`relative`	Position		Relative positioning
`static`	Position		Static positioning
`sticky`	Position		Sticky positioning
`responsive`	Responsive		Enable responsive sizing - uses breakpoint-specific classes for font size, padding, and gap
`reverse`	Reverse		Reverse the order of children
`noRing`	Ring		Disable focus ring
`ring`	Ring	✓	Enable focus ring
`noShadow`	Shadow	✓	Disable drop shadow
`shadow`	Shadow		Enable drop shadow
`noTransition`	Transition		Disable transitions for instant state changes
`transition`	Transition	✓	Enable smooth transitions between states
`transparent`	Transparent		Disable background color - makes component background transparent
`whitespaceBreakSpaces`	Whitespace		Break words to prevent overflow
`whitespaceNormal`	Whitespace		Normal wrapping - default browser behavior
`whitespaceNowrap`	Whitespace	✓	No wrap - text stays on single line
`whitespacePre`	Whitespace		Preserve whitespace and line breaks
`whitespacePreLine`	Whitespace		Preserve line breaks, collapse spaces, wrap text
`whitespacePreWrap`	Whitespace		Preserve whitespace, wrap text
`wAuto`	Width		Set width to auto
`wFit`	Width	✓	Set width to fit-content
`wFull`	Width		Set width to 100%
`wScreen`	Width		Set width to 100vw (viewport width), removes max-width constraint
`flexNoWrap`	Wrap		Force flex items to stay on single line (may overflow)
`flexWrap`	Wrap		Allow flex items to wrap to new lines when container is too narrow
`flexWrapReverse`	Wrap		Wrap flex items in reverse order (last items wrap first)