@epilot/volt-ui-svelte
v0.3.0
Published
Svelte component library for Volt UI design system
Maintainers
Readme
@epilot/volt-ui-svelte
Svelte component library for the Volt UI design system. A tree-shakeable, accessible component library built with Svelte 5 and Tailwind CSS v4.
Docs
https://grand-yeot-414eb4.netlify.app
Installation
npm install @epilot/volt-ui-svelte @epilot/volt-tokensSetup
1. Import the styles
Import the Volt UI styles in your app's main CSS file or layout:
/* app.css or +layout.svelte */
@import "@epilot/volt-ui-svelte/styles";Or import directly in your Svelte layout:
<script>
import "@epilot/volt-ui-svelte/styles";
</script>2. Configure Tailwind CSS v4
Volt UI uses Tailwind CSS v4. Make sure your project is configured to use it:
// vite.config.js
import tailwindcss from "@tailwindcss/vite";
export default {
plugins: [tailwindcss()],
};Usage
<script>
import { Button, Checkbox, Label } from "@epilot/volt-ui-svelte";
</script>
<Button variant="primary" size="base">Click me</Button>
<Label>
<Checkbox />
Accept terms and conditions
</Label>Components
Form Components
- Button - Primary action button with variants (primary, secondary, outline, ghost, link, destructive)
- Checkbox - Checkbox input with label support
- Switch - Toggle switch component
- RadioGroup / RadioGroupItem - Radio button group
- Label - Form label component
- Field - Form field wrapper with validation support
FieldInput- Text inputFieldTextarea- Textarea inputFieldLabel- Field labelFieldDescription- Field description textFieldError- Field error messageFieldGroup- Field grouping
Overlay Components
- Dialog - Modal dialog component
DialogTrigger,DialogPortal,DialogOverlay,DialogCloseDialogContent,DialogHeader,DialogFooterDialogTitle,DialogDescription
- AlertDialog - Confirmation dialog component
AlertDialogTrigger,AlertDialogPortal,AlertDialogOverlayAlertDialogContent,AlertDialogHeader,AlertDialogFooterAlertDialogTitle,AlertDialogDescriptionAlertDialogAction,AlertDialogCancel
- Tooltip - Tooltip component
TooltipProvider,TooltipTrigger,TooltipContent
Display Components
- Badge - Status badge with color variants
- Separator - Visual separator line
- Spinner - Loading spinner
Utilities
- cn - Class name utility for merging Tailwind classes
Styling
Volt UI uses CSS custom properties prefixed with --volt- for theming. The design tokens are provided by @epilot/volt-tokens.
Light/Dark Mode
The components support light and dark modes. Apply the .dark class or data-theme="dark" to your root element:
<html class="dark">
<!-- or -->
<html data-theme="dark"></html>
</html>Requirements
- Svelte 5.0.0+
- Tailwind CSS 4.0.0+
License
MIT
