vaiperui

docs / getting started

Getting started

From zero to your first screen: CSS imported, a component rendered and the variant you want.

Your first component

With the CSS imported, using a component is one line. Here, a Button with the primary variant:

Button.tsx
import { Button } from "vaiperui";
export function Save() {
return <Button variantColor="primary">Save</Button>;
}
preview

Variants

The components share the same layout props — variantColor, size, radius and animation. The Button adds variant and hover; see each component's reference for the full list.

variants.tsx
<Button variantColor="success" radius="full">
Confirm
</Button>
<Button variant="outlined" variantColor="warning">
Review
</Button>
<Button variantColor="danger" hover="lift">
Delete
</Button>

The differentiator: masks

The Input formats phones, cards, dates and documents automatically as the user types. Just pass mask.

Input.tsx
import { Input } from "vaiperui";
export function PhoneField() {
return <Input label="Phone" mask="phone" />;
}
preview

Where to go now

next step

This guide covered the essentials with Button and Input, but the library doesn't stop there. See the full reference for Button, Input or Select.