Getting Started

Installation (Nuxt)

Install and configure @witchcraft/ui in your Nuxt project.

Install

npm install @witchcraft/ui

Nuxt Setup

Add the module to your nuxt.config.ts:

nuxt.config.ts
export default defineNuxtConfig({
    modules: ['@witchcraft/ui']
})

The module automatically sets up:

  • Tailwind CSS v4 with a custom witchcraft-ui.css file
  • unplugin-icons/nuxt for icon support
  • Reka UI via reka-ui/nuxt

Tailwind CSS

Import the generated stylesheet in your Tailwind CSS file:

~/assets/css/tailwind.css
@import "@tailwindcss" source("../../app");
@import "../../.nuxt/witchcraft-ui.css";

Icons

The module installs unplugin-icons/nuxt and configures it with custom styles. You can disable this with the includeUnpluginIconsPlugins option.

Helpers

Some helpers are not auto-imported. Import them from #witchcraft-ui-helpers:

import { someHelper } from "#witchcraft-ui-helpers"

Anything else can be imported from #witchcraft-ui.