mcpField
N
nuxt-ui

nuxt-ui

github.com/nuxt-contentDesign & UI74054 installsUpdated 1w ago
Repository

About nuxt-ui

A guidance skill for developers using Nuxt UI v4, a Vue and Nuxt component library. It provides task-specific references for installation, components, themes, forms, overlays, and composables.

Key features

  1. 01Installation and setup guidance
  2. 02Component references
  3. 03Theme customization
  4. 04Form and validation guidance
  5. 05Overlay and composable references

Use cases

  1. 01Installing and configuring Nuxt UI
  2. 02Choosing and using UI components
  3. 03Customizing colors and variants
  4. 04Building validated forms

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/nuxt-content/nuxt-studio --skill nuxt-ui

After installing, type/nuxt-uiin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

components/
accordion.md
alert.md
app.md
auth-form.md
avatar-group.md
avatar.md
badge.md
banner.md
blog-post.md
blog-posts.md
breadcrumb.md
button.md
calendar.md
card.md
carousel.md
changelog-version.md
changelog-versions.md
chat-message.md
chat-messages.md
chat-palette.md
chat-prompt-submit.md
chat-prompt.md
checkbox-group.md
checkbox.md
chip.md
collapsible.md
color-mode-avatar.md
color-mode-button.md
color-mode-image.md
color-mode-select.md

Details

From the project README

Nuxt UI v4

Component library for Vue 3 and Nuxt 4+ built on Reka UI (headless) + Tailwind CSS v4 + Tailwind Variants.

Current stable version: v4.3.0 (December 2025)

When to Use

  • Installing/configuring @nuxt/ui
  • Using UI components (Button, Card, Table, Form, etc.)
  • Customizing theme (colors, variants, CSS variables)
  • Building forms with validation
  • Using overlays (Modal, Toast, CommandPalette)
  • Working with composables (useToast, useOverlay)

For Vue component patterns: use vue skill For Nuxt routing/server: use nuxt skill

Available Guidance

FileTopics
references/installation.mdNuxt/Vue setup, pnpm gotchas, UApp wrapper, module options, prefix, tree-shaking
references/theming.mdSemantic colors, CSS variables, app.config.ts, Tailwind Variants
references/components.mdComponent index by category (125+ components)
components/*.mdPer-component details (button.md, modal.md, etc.)
references/forms.mdForm components, validation (Zod/Valibot), useFormField
references/overlays.mdToast, Modal, Slideover, Drawer, CommandPalette
references/composables.mduseToast, useOverlay, defineShortcuts, useScrollspy

Usage Pattern

Load based on context:

DO NOT read all files at once. Load based on context.

Key Concepts

ConceptDescription
UAppRequired wrapper component for Toast, Tooltip, overlays
Tailwind VariantsType-safe styling with slots, variants, compoundVariants
Semantic Colorsprimary, secondary, success, error, warning, info, neutral
Reka UIHeadless component primitives (accessibility built-in)

For headless component primitives (API details, accessibility patterns, asChild): read the reka-ui skill

Quick Reference

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@nuxt/ui'],
  css: ['~/assets/css/main.css']
})
/* assets/css/main.css */
@import 'tailwindcss';
@import '@nuxt/ui';
<!-- app.vue - UApp wrapper required -->
<template>
  <UApp>
    <NuxtPage />
  </UApp>
</template>

Resources


Token efficiency: Main skill ~300 tokens, each sub-file ~800-1200 tokens

Comments

Markdown supported