Skip to content

virtueorg/ui

Repository files navigation

Virtue UI

A simple Svelte component library built on top of melt-ui and TailwindCSS.

Prerequisites

You only need to configure TailwindCSS in your project and you're good to go!

Installation

To install the component library, simply install it with the following command

npm install virtue-ui

To make the library work, you also need to put the following code in your tailwind.config.js file. Please note that you can customize everything according to your needs!

/** @type {import('tailwindcss').Config} */
export default {
  content: [
    "./src/**/*.{html,js,svelte,ts}",
    "node_modules/virtue-ui/**/*.{html,js,svelte,ts}",
  ],

  theme: {
    extend: {
      colors: {
        background: "#09090b",
        foreground: "#f4f4f5",
        muted: "#a1a1aa",
        primary: "#818cf8",
        warning: "#fbbf24",
        error: "#f87171",
        panel: "#111113",
      },
    },
  },

  plugins: [],
};

Usage

Simply import what you need and use it, it's as simple as that!

<script lang="ts">
  import { Button } from "virtue-ui";
</script>

<Button.Root>Hello world!</Button.Root>

About

The official Virtue UI library for Svelte

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors