VaneUI

VaneUI

Basic Components

Code

Renders inline code snippets with syntax highlighting. Perfect for displaying code examples, commands, file paths, or technical terms within text content.

Basic Usage

Inline code snippets with default styling.

Use the npm install command to install packages.The const variable = 'value' syntax declares a constant.
react-icon

BasicUsage.tsx

<Row flexWrap>
  <span>
    Use the 
    <Code>npm install</Code>
     command to install packages.
  </span>
  <span>
    The 
    <Code>const variable = 'value'</Code>
     syntax declares a constant.
  </span>
</Row>

Sizes

Code elements in different sizes - xs, sm, md, lg, xl.

Size xs: console.log('Hello')
Size sm: console.log('Hello')
Size md: console.log('Hello')
Size lg: console.log('Hello')
Size xl: console.log('Hello')
react-icon

Sizes.tsx

<Col>
  <Row>
    <span>
      Size xs: 
      <Code xs>console.log('Hello')</Code>
    </span>
  </Row>
  <Row>
    <span>
      Size sm: 
      <Code sm>console.log('Hello')</Code>
    </span>
  </Row>
  <Row>
    <span>
      Size md: 
      <Code md>console.log('Hello')</Code>
    </span>
  </Row>
  <Row>
    <span>
      Size lg: 
      <Code lg>console.log('Hello')</Code>
    </span>
  </Row>
  <Row>
    <span>
      Size xl: 
      <Code xl>console.log('Hello')</Code>
    </span>
  </Row>
</Col>

Appearances

Different code color variants for syntax highlighting.

primary codebrand codeaccent codesecondary codetertiary codesuccess codedanger codewarning codeinfo codelink code
react-icon

Appearances.tsx

<Row flexWrap>
  <Code primary>primary code</Code>
  <Code brand>brand code</Code>
  <Code accent>accent code</Code>
  <Code secondary>secondary code</Code>
  <Code tertiary>tertiary code</Code>
  <Code success>success code</Code>
  <Code danger>danger code</Code>
  <Code warning>warning code</Code>
  <Code info>info code</Code>
  <Code link>link code</Code>
</Row>

Code in Context

Code elements used within text content.

To create a new React component, use function Component() {} or the arrow function syntax const Component = () => {}.

Install the package with npm i @vaneui/ui and then import it using import { Button } from "@vaneui/ui".

The useState hook returns an array with two elements: the current state value and a setter function like [state, setState].

react-icon

CodeinContext.tsx

<Col>
  <Text>
    To create a new React component, use 
    <Code>{`function Component() {}`}</Code>
     or the arrow function syntax 
    <Code>{`const Component = () => {}`}</Code>
    .
  </Text>
  <p>
    Install the package with 
    <Code primary>npm i @vaneui/ui</Code>
     and then import it using 
    <Code secondary>{`import { Button } from "@vaneui/ui"`}</Code>
    .
  </p>
  <Text>
    The 
    <Code info>useState</Code>
     hook returns an array with two elements: the current state value and a setter function like 
    <Code info>[state, setState]</Code>
    .
  </Text>
</Col>

Keyboard Shortcuts

Code elements for displaying keyboard shortcuts and commands.

Ctrl+C

or

Cmd+V

react-icon

KeyboardShortcuts.tsx

<Row flexWrap>
  <Text primary>
    <Code>Ctrl</Code>
    +
    <Code>C</Code>
  </Text>
  or
  <Text primary>
    <Code primary>Cmd</Code>
    +
    <Code primary>V</Code>
  </Text>
</Row>

Code Props

Size

Size props for controlling component dimensions

xs

Extra small size

sm

Small size

md

Medium size (default)

lg

Large size

xl

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

Focus Visible

Focus visible props for controlling focus-visible outlines

focusVisible

Enable focus-visible outline

noFocusVisible

Disable focus-visible outline

Shape

Shape props for controlling component border radius

pill

Fully rounded corners (circular)

sharp

No rounded corners (square)

rounded

Medium rounded corners (default)

Font Weight

Font weight props for controlling text weight

thin

Thin font weight (100)

extralight

Extra light font weight (200)

light

Light font weight (300)

normal

Normal font weight (400)

medium

Medium font weight (500)

semibold

Semibold font weight (600)

bold

Bold font weight (700)

extrabold

Extra bold font weight (800)

black

Black font weight (900)

Font Style

Font style props for controlling text style

italic

Italic font style

notItalic

Not italic (normal) font style

Text Decoration

Text decoration props for controlling text underline/strikethrough

underline

Add underline decoration below text

lineThrough

Add strikethrough/line-through decoration across text

noUnderline

Remove text decoration (no underline, strikethrough, etc.)

overline

Add overline decoration above text

Text Transform

Text transform props for controlling text case

uppercase

Transform text to uppercase

lowercase

Transform text to lowercase

capitalize

Capitalize first letter of each word

normalCase

Normal text case (no transformation)

Font Family

Font family props for controlling text font

sans

Sans-serif font family (default)

serif

Serif font family

mono

Monospace font family

Text Align

Text alignment props for controlling text position

textLeft

Align text to left

textCenter

Align text to center

textRight

Align text to right

textJustify

Justify text

Padding

Padding props for controlling internal spacing

padding

Enable internal padding

noPadding

Disable internal padding

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

On this page

Code

Basic Usage

Sizes

Appearances

Code in Context

Keyboard Shortcuts

Code Props

Size

Hide

Items

Justify

Position

Display

Overflow

Wrap

Gap

Flex Direction

Reverse

Appearance

Border

Shadow

Ring

Focus Visible

Shape

Font Weight

Font Style

Text Decoration

Text Transform

Font Family

Text Align

Padding

Variant

Transparent

Responsive