Easy U.S. Web Design System (USWDS) integration for Nuxt.js.

✨  Release Notes

Nuxt USWDS integrates the Vue USWDS library into Nuxt.js.

• Auto import all Vue USWDS components.
• Automatically uses NuxtLink for Vue USWDS component linking.
• Supports all Vue USWDS options.

1. Add nuxt-uswds dependency to your project. You will also need to install vue-uswds as it is a peer dependency.

# Using npm
npm install nuxt-uswds vue-uswds
# Using pnpm
pnpm add nuxt-uswds vue-uswds
# Using yarn
yarn add nuxt-uswds vue-uswds

2. Add nuxt-uswds to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: ['nuxt-uswds'],
});

That's it! You can now use all Vue USWDS components in your Nuxt app ✨

The module supports the following options. They can be added to your nuxt.config.ts module configuration:

{
  modules: [
    [
      'nuxt-uswds',
      {
        // Modules options...
      },
    ],
  ];
}

# Install dependencies
npm install
# Generate type stubs
npm run dev:prepare
# Develop with the playground
npm run dev
# Build the playground
npm run dev:build
# Run ESLint
npm run lint
# Type check
npm run types
# Run Vitest
npm run test
npm run test:watch