VaneUI

Documentation

GitHub

Getting Started

Core Concepts Installation Usage Basics

Basic Components

Button Badge Chip Checkbox Label Code Divider Input

Layout Components

Section Container Row Col Stack Card Grid3 Grid4 Grid5 Grid6

Typography Components

Text Title PageTitle SectionTitle Link List ListItem

Customization

Theming Overview Using ThemeProvider Theme & ThemeOverride ThemeDefaults ExtraClasses CSS Variables

Layout Components

Grid6

A six-column grid layout component for creating compact, organized displays. Ideal for icon grids, feature collections, and detailed content arrangements.

Basic Grid6

A six-column grid layout that creates balanced, visually appealing arrangements.

Item 1

Item 2

Item 3

Item 4

Item 5

Item 6

Item 7

Item 8

Item 9

Item 10

Item 11

Item 12

BasicGrid6.tsx

<Grid6>
  <div className="p-4 bg-gray-100 rounded">Item 1</div>
  <div className="p-4 bg-gray-100 rounded">Item 2</div>
  <div className="p-4 bg-gray-100 rounded">Item 3</div>
  <div className="p-4 bg-gray-100 rounded">Item 4</div>
  <div className="p-4 bg-gray-100 rounded">Item 5</div>
  <div className="p-4 bg-gray-100 rounded">Item 6</div>
  <div className="p-4 bg-gray-100 rounded">Item 7</div>
  <div className="p-4 bg-gray-100 rounded">Item 8</div>
  <div className="p-4 bg-gray-100 rounded">Item 9</div>
  <div className="p-4 bg-gray-100 rounded">Item 10</div>
  <div className="p-4 bg-gray-100 rounded">Item 11</div>
  <div className="p-4 bg-gray-100 rounded">Item 12</div>
</Grid6>

Grid Sizes

Grids come in different sizes such as xs, sm, md, lg, xl.

Extra Small Grid6

Large Grid6

Item 1

Item 2

Item 3

Item 4

Item 5

Item 6

GridSizes.tsx

<Col lg>
  <div>
    <Text semibold>Extra Small Grid6</Text>
    <Grid6 xs>
      <div className="p-1 bg-gray-100 rounded text-xs text-center">1</div>
      <div className="p-1 bg-gray-100 rounded text-xs text-center">2</div>
      <div className="p-1 bg-gray-100 rounded text-xs text-center">3</div>
      <div className="p-1 bg-gray-100 rounded text-xs text-center">4</div>
      <div className="p-1 bg-gray-100 rounded text-xs text-center">5</div>
      <div className="p-1 bg-gray-100 rounded text-xs text-center">6</div>
    </Grid6>
  </div>
  <div>
    <Text semibold>Large Grid6</Text>
    <Grid6 lg>
      <div className="p-6 bg-gray-100 rounded">Item 1</div>
      <div className="p-6 bg-gray-100 rounded">Item 2</div>
      <div className="p-6 bg-gray-100 rounded">Item 3</div>
      <div className="p-6 bg-gray-100 rounded">Item 4</div>
      <div className="p-6 bg-gray-100 rounded">Item 5</div>
      <div className="p-6 bg-gray-100 rounded">Item 6</div>
    </Grid6>
  </div>
</Col>

Grid with Gap Control

Control spacing between grid items for different layout requirements.

No Gap

With Gap

1 (default)

GridwithGapControl.tsx

<Col lg>
  <div>
    <Text semibold>No Gap</Text>
    <Grid6 noGap>
      <div className="p-2 bg-gray-100 border text-center">1</div>
      <div className="p-2 bg-gray-100 border text-center">2</div>
      <div className="p-2 bg-gray-100 border text-center">3</div>
      <div className="p-2 bg-gray-100 border text-center">4</div>
      <div className="p-2 bg-gray-100 border text-center">5</div>
      <div className="p-2 bg-gray-100 border text-center">6</div>
    </Grid6>
  </div>
  <div>
    <Text semibold>With Gap</Text>
    <Grid6>
      <div className="p-2 bg-gray-100 rounded text-center">1 (default)</div>
      <div className="p-2 bg-gray-100 rounded text-center">2</div>
      <div className="p-2 bg-gray-100 rounded text-center">3</div>
      <div className="p-2 bg-gray-100 rounded text-center">4</div>
      <div className="p-2 bg-gray-100 rounded text-center">5</div>
      <div className="p-2 bg-gray-100 rounded text-center">6</div>
    </Grid6>
  </div>
</Col>

Grid Appearances

Different background appearances to create visual hierarchy and organization.

Primary Background

Secondary Background

GridAppearances.tsx

<Col lg>
  <div>
    <Text semibold>Primary Background</Text>
    <Grid6 primary>
      <div className="p-3 bg-white rounded shadow-sm text-center">1</div>
      <div className="p-3 bg-white rounded shadow-sm text-center">2</div>
      <div className="p-3 bg-white rounded shadow-sm text-center">3</div>
      <div className="p-3 bg-white rounded shadow-sm text-center">4</div>
      <div className="p-3 bg-white rounded shadow-sm text-center">5</div>
      <div className="p-3 bg-white rounded shadow-sm text-center">6</div>
    </Grid6>
  </div>
  <div>
    <Text semibold>Secondary Background</Text>
    <Grid6 secondary>
      <div className="p-3 bg-white rounded shadow-sm text-center">1</div>
      <div className="p-3 bg-white rounded shadow-sm text-center">2</div>
      <div className="p-3 bg-white rounded shadow-sm text-center">3</div>
      <div className="p-3 bg-white rounded shadow-sm text-center">4</div>
      <div className="p-3 bg-white rounded shadow-sm text-center">5</div>
      <div className="p-3 bg-white rounded shadow-sm text-center">6</div>
    </Grid6>
  </div>
</Col>

Icon Grid Example

Perfect for displaying collections of icons, features, or small cards in a compact layout.

Feature

Service

Product

Support

Tool

Resource

IconGridExample.tsx

<Grid6>
  <div
    className="p-4 bg-gradient-to-br from-red-50 to-red-100 rounded text-center"
  >
    <div className="w-8 h-8 bg-red-400 rounded-full mx-auto mb-2" />
    <Text xs>Feature</Text>
  </div>
  <div
    className="p-4 bg-gradient-to-br from-blue-50 to-blue-100 rounded text-center"
  >
    <div className="w-8 h-8 bg-blue-400 rounded-full mx-auto mb-2" />
    <Text xs>Service</Text>
  </div>
  <div
    className="p-4 bg-gradient-to-br from-green-50 to-green-100 rounded text-center"
  >
    <div className="w-8 h-8 bg-green-400 rounded-full mx-auto mb-2" />
    <Text xs>Product</Text>
  </div>
  <div
    className="p-4 bg-gradient-to-br from-yellow-50 to-yellow-100 rounded text-center"
  >
    <div className="w-8 h-8 bg-yellow-400 rounded-full mx-auto mb-2" />
    <Text xs>Support</Text>
  </div>
  <div
    className="p-4 bg-gradient-to-br from-purple-50 to-purple-100 rounded text-center"
  >
    <div className="w-8 h-8 bg-purple-400 rounded-full mx-auto mb-2" />
    <Text xs>Tool</Text>
  </div>
  <div
    className="p-4 bg-gradient-to-br from-pink-50 to-pink-100 rounded text-center"
  >
    <div className="w-8 h-8 bg-pink-400 rounded-full mx-auto mb-2" />
    <Text xs>Resource</Text>
  </div>
</Grid6>

Grid6 Props

Size

Size props for controlling component dimensions

Extra small size

Small size

Medium size (default)

Large size

Extra large size

Hide

Hide props for responsive element visibility

mobileHide

Hide element on mobile devices and below (max-mobile: 48rem)

tabletHide

Hide element on tablet devices and below (max-tablet: 64rem)

desktopHide

Hide element on desktop devices and below (max-desktop: 80rem)

Items

Items props for controlling flex item alignment (align-items)

itemsStart

Align items to start (top/left)

itemsEnd

Align items to end (bottom/right)

itemsCenter

Align items to center

itemsBaseline

Align items to baseline

itemsStretch

Stretch items to fill container

Justify

Justify props for controlling flex content alignment (justify-content)

justifyStart

Pack items toward the start of the main axis

justifyEnd

Pack items toward the end of the main axis

justifyCenter

Center items along the main axis

justifyBetween

Distribute items with space between them

justifyAround

Distribute items with space around them

justifyEvenly

Distribute items with equal space around them

justifyStretch

Stretch items to fill the main axis

justifyBaseline

Align items along their baseline on main axis

Position

Position props for controlling CSS position property

relative

Relative positioning

absolute

Absolute positioning

fixed

Fixed positioning

sticky

Sticky positioning

static

Static positioning

Display

Display props for controlling CSS display property

inline

Inline display - flows with text

block

Block display - takes full width, new line

inlineBlock

Inline-block display - inline but with block properties

flex

Flex display - flexbox container

inlineFlex

Inline-flex display - inline flexbox container

grid

Grid display - CSS grid container

inlineGrid

Inline-grid display - inline grid container

contents

Contents display - element's box is removed, children display as if parent didn't exist

table

Table display - behaves like table element

tableCell

Table-cell display - behaves like td element

hidden

Hidden display - element is not visible

Overflow

Overflow props for controlling content overflow behavior

overflowAuto

Auto overflow - show scrollbars if needed

overflowHidden

Hidden overflow - clip content without scrollbars

overflowClip

Clip overflow - hard clip without scrollbars

overflowVisible

Visible overflow - content extends beyond bounds

overflowScroll

Scroll overflow - always show scrollbars

overflowXAuto

Auto overflow on X-axis only

overflowYAuto

Auto overflow on Y-axis only

overflowXHidden

Hidden overflow on X-axis only

overflowYHidden

Hidden overflow on Y-axis only

overflowXClip

Clip overflow on X-axis only

overflowYClip

Clip overflow on Y-axis only

overflowXVisible

Visible overflow on X-axis only

overflowYVisible

Visible overflow on Y-axis only

overflowXScroll

Scroll overflow on X-axis only

overflowYScroll

Scroll overflow on Y-axis only

Wrap

Wrap props for controlling flex wrapping behavior

flexWrap

Allow flex items to wrap to new lines when container is too narrow

flexNoWrap

Force flex items to stay on single line (may overflow)

flexWrapReverse

Wrap flex items in reverse order (last items wrap first)

Gap

Gap props for controlling spacing between children

gap

Enable gap spacing between children

noGap

Disable gap spacing

Flex Direction

Flex direction props for controlling flex layout direction

row

Flex direction row (horizontal)

column

Flex direction column (vertical)

rowReverse

Flex direction row-reverse

columnReverse

Flex direction column-reverse

Reverse

Reverse props for reversing child order

reverse

Reverse the order of children

Appearance

Appearance props for controlling component colors

primary

Primary color appearance (gray)

brand

Brand color appearance (blue)

accent

Accent color appearance (rose)

secondary

Secondary color appearance (gray)

tertiary

Tertiary color appearance

success

Success color appearance (green)

danger

Danger color appearance (red)

warning

Warning color appearance (amber)

info

Info color appearance (cyan)

link

Link color appearance (blue, for hyperlinks)

Border

Border props for controlling component borders

border

Enable border on all sides

borderT

Enable border on top

borderB

Enable border on bottom

borderL

Enable border on left

borderR

Enable border on right

borderX

Enable border on left and right

borderY

Enable border on top and bottom

noBorder

Disable all borders

Shadow

Shadow props for controlling drop shadows

shadow

Enable drop shadow

noShadow

Disable drop shadow

Ring

Ring props for controlling focus rings

ring

Enable focus ring

noRing

Disable focus ring

Shape

Shape props for controlling component border radius

pill

Fully rounded corners (circular)

sharp

No rounded corners (square)

rounded

Medium rounded corners (default)

Variant

Variant props for controlling component style variations

filled

Filled variant - solid background with contrasting text color

outline

Outline variant - transparent background with border and colored text (default)

Transparent

Transparent prop for disabling background color

transparent

Disable background color - makes component background transparent

Responsive

Responsive prop for enabling breakpoint-specific sizing

responsive

Enable responsive sizing - uses breakpoint-specific classes for font size, padding, and gap