{"id":16261478,"url":"https://github.com/patrickcate/nuxt-uswds","last_synced_at":"2026-01-20T04:32:42.172Z","repository":{"id":227856031,"uuid":"769697198","full_name":"patrickcate/nuxt-uswds","owner":"patrickcate","description":"Vue USWDS integration for Nuxt.js","archived":false,"fork":false,"pushed_at":"2024-04-08T07:56:02.000Z","size":701,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2024-04-08T08:57:46.805Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/patrickcate.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-09T19:55:14.000Z","updated_at":"2024-04-15T08:36:08.205Z","dependencies_parsed_at":"2024-03-24T03:25:56.889Z","dependency_job_id":"8927fb4f-f929-416a-9923-6ceeac2bcea7","html_url":"https://github.com/patrickcate/nuxt-uswds","commit_stats":null,"previous_names":["patrickcate/nuxt-uswds"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickcate%2Fnuxt-uswds","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickcate%2Fnuxt-uswds/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickcate%2Fnuxt-uswds/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickcate%2Fnuxt-uswds/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/patrickcate","download_url":"https://codeload.github.com/patrickcate/nuxt-uswds/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247728903,"owners_count":20986376,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T16:41:38.459Z","updated_at":"2026-01-20T04:32:42.166Z","avatar_url":"https://github.com/patrickcate.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![vue-uswds logo](https://raw.githubusercontent.com/patrickcate/nuxt-uswds/main/playground/public/logo.svg)\n\n# Nuxt USWDS\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![License][license-src]][license-href]\n\nEasy U.S. Web Design System (USWDS) integration for Nuxt.js.\n\n[✨ \u0026nbsp;Release Notes](/CHANGELOG.md)\n\n## Introduction\n\nNuxt USWDS integrates the [Vue USWDS](https://github.com/patrickcate/vue-uswds) library into Nuxt.js.\n\n## Features\n\n- [Auto import](https://nuxt.com/docs/guide/concepts/auto-imports) all Vue USWDS components.\n- Automatically uses `NuxtLink` for Vue USWDS component linking.\n- Supports all [Vue USWDS](https://patrickcate.github.io/vue-uswds/?path=/story/guide-configuration--page) options.\n\n## Quick Setup\n\n1. Add `nuxt-uswds` dependency to your project. You will also need to install `vue-uswds` as it is a peer dependency.\n\n```bash\n# Using npm\nnpm install nuxt-uswds vue-uswds\n\n# Using pnpm\npnpm add nuxt-uswds vue-uswds\n\n# Using yarn\nyarn add nuxt-uswds vue-uswds\n```\n\n2. Add `nuxt-uswds` to the `modules` section of `nuxt.config.ts`\n\n```js\nexport default defineNuxtConfig({\n  modules: ['nuxt-uswds'],\n});\n```\n\nThat's it! You can now use all Vue USWDS components in your Nuxt app ✨\n\n## Options\n\nThe module supports the following options. They can be added to your `nuxt.config.ts` module configuration:\n\n```js\n{\n  modules: [\n    [\n      'nuxt-uswds',\n      {\n        // Modules options...\n      },\n    ],\n  ];\n}\n```\n\n| Name                       | Type      | Default | Description                                                                                                                                                                                                                                                              |\n| -------------------------- | --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `autoImportBaseComponents` | `boolean` | `true`  | Enabled Nuxt's auto-import of all Vue USWDS base components. You should only need to turn disable this option if you have a name conflict with Vue USWDS's `BaseLink` or `BaseHeading` internal components.                                                              |\n| `autoImportComponents`     | `boolean` | `true`  | Enabled Nuxt's auto-import of all regular Vue USWDS components.                                                                                                                                                                                                          |\n| `baseComponentPrefix`      | `string`  | `''`    | If you have a name conflict with Nuxt.js's auto importing of Vue USWDS's `BaseLink` or `BaseHeading` internal components, you can set an additional prefix with this option.                                                                                             |\n| `componentPrefix`          | `string`  | `''`    | All [Vue USWDS components](https://patrickcate.github.io/vue-uswds/) are prefixed with `Usa`. This should prevent any name conflicts with Nuxt.js's auto importing of components. If you encounter an issues however, you can add an additional prefix with this option. |\n| `vueUswds`                 | `object`  | `{}`    | Any [Vue USWDS](https://patrickcate.github.io/vue-uswds/?path=/story/guide-configuration--page) options to want to use. The `routerComponentName` option is automatically set to 'NuxtLink'                                                                              |\n\n## Development\n\n```bash\n# Install dependencies\nnpm install\n\n# Generate type stubs\nnpm run dev:prepare\n\n# Develop with the playground\nnpm run dev\n\n# Build the playground\nnpm run dev:build\n\n# Run ESLint\nnpm run lint\n\n# Type check\nnpm run types\n\n# Run Vitest\nnpm run test\nnpm run test:watch\n```\n\n\u003c!-- Badges --\u003e\n\n[npm-version-src]: https://img.shields.io/npm/v/nuxt-uswds/latest.svg?style=flat\u0026colorA=020420\u0026colorB=00DC82\n[npm-version-href]: https://npmjs.com/package/nuxt-uswds\n[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-uswds.svg?style=flat\u0026colorA=020420\u0026colorB=00DC82\n[npm-downloads-href]: https://npmjs.com/package/nuxt-uswds\n[license-src]: https://img.shields.io/npm/l/nuxt-uswds.svg?style=flat\u0026colorA=020420\u0026colorB=00DC82\n[license-href]: https://npmjs.com/package/nuxt-uswds\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickcate%2Fnuxt-uswds","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatrickcate%2Fnuxt-uswds","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickcate%2Fnuxt-uswds/lists"}