add vue example

ethangardner · ethangardner · commit a5ff5d560a9e · 2025-11-21T15:03:06.000-05:00
diff --git a/examples/with-solid/README.md b/examples/with-solid/README.md
@@ -1,3 +1,3 @@
-# React
+# SolidJS
 
-This is a bare-bones example to demonstrate how to use USWDS Elements in a React project.
+This is a bare-bones example to demonstrate how to use USWDS Elements in a SolidJS project.
diff --git a/examples/with-sveltekit/README.md b/examples/with-sveltekit/README.md
@@ -1,38 +1,3 @@
-# sv
+# SvelteKit
 
-Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
-
-## Creating a project
-
-If you're seeing this, you've probably already done this step. Congrats!
-
-```sh
-# create a new project in the current directory
-npx sv create
-
-# create a new project in my-app
-npx sv create my-app
-```
-
-## Developing
-
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
-
-```sh
-npm run dev
-
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
-```
-
-## Building
-
-To create a production version of your app:
-
-```sh
-npm run build
-```
-
-You can preview the production build with `npm run preview`.
-
-> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
+This is a bare-bones example to demonstrate how to use USWDS Elements in a SvelteKit project.
diff --git a/examples/with-vue/.gitignore b/examples/with-vue/.gitignore
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/examples/with-vue/.vscode/extensions.json b/examples/with-vue/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["Vue.volar"]
+}
diff --git a/examples/with-vue/README.md b/examples/with-vue/README.md
@@ -0,0 +1,3 @@
+# Vue
+
+This is a bare-bones example to demonstrate how to use USWDS Elements in a Vue project.
diff --git a/examples/with-vue/index.html b/examples/with-vue/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>with-vue</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>
diff --git a/examples/with-vue/package.json b/examples/with-vue/package.json
@@ -0,0 +1,23 @@
+{
+  "name": "with-vue",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vue-tsc -b && vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@uswds/elements": "1.0.0-alpha.4",
+    "vue": "^3.5.24"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.0",
+    "@vitejs/plugin-vue": "^6.0.1",
+    "@vue/tsconfig": "^0.8.1",
+    "typescript": "~5.9.3",
+    "vite": "^7.2.2",
+    "vue-tsc": "^3.1.3"
+  }
+}
diff --git a/examples/with-vue/public/vite.svg b/examples/with-vue/public/vite.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>
diff --git a/examples/with-vue/src/App.vue b/examples/with-vue/src/App.vue
@@ -0,0 +1,9 @@
+<!-- src/App.vue -->
+<script setup lang="ts">
+import { UsaBanner } from "@uswds/elements";
+</script>
+
+<template>
+  <usa-banner></usa-banner>
+  <h1>My Vue App</h1>
+</template>
diff --git a/examples/with-vue/src/main.ts b/examples/with-vue/src/main.ts
@@ -0,0 +1,5 @@
+import { createApp } from "vue";
+import "./style.css";
+import App from "./App.vue";
+
+createApp(App).mount("#app");
diff --git a/examples/with-vue/src/style.css b/examples/with-vue/src/style.css
@@ -0,0 +1,21 @@
+:root {
+  font-family: system-ui, Avenir, Helvetica, Arial, sans-serif;
+  line-height: 1.5;
+  font-weight: 400;
+}
+
+body {
+  margin: 0;
+  min-width: 320px;
+  min-height: 100vh;
+}
+
+h1 {
+  font-size: 3.2em;
+  line-height: 1.1;
+}
+
+#app {
+  margin: 0 auto;
+  text-align: center;
+}
diff --git a/examples/with-vue/tsconfig.app.json b/examples/with-vue/tsconfig.app.json
@@ -0,0 +1,19 @@
+{
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
+    "types": [
+      "vite/client",
+      "./node_modules/@uswds/elements/dist/types/custom-element-vuejs.d.ts"
+    ],
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "erasableSyntaxOnly": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.vue"]
+}
diff --git a/examples/with-vue/tsconfig.json b/examples/with-vue/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "files": [],
+  "references": [
+    { "path": "./tsconfig.app.json" },
+    { "path": "./tsconfig.node.json" }
+  ]
+}
diff --git a/examples/with-vue/tsconfig.node.json b/examples/with-vue/tsconfig.node.json
@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "target": "ES2023",
+    "lib": ["ES2023"],
+    "module": "ESNext",
+    "types": ["node"],
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "erasableSyntaxOnly": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["vite.config.ts"]
+}
diff --git a/examples/with-vue/vite.config.ts b/examples/with-vue/vite.config.ts
@@ -0,0 +1,16 @@
+// vite.config.ts
+import { defineConfig } from "vite";
+import vue from "@vitejs/plugin-vue";
+
+export default defineConfig({
+  plugins: [
+    vue({
+      template: {
+        compilerOptions: {
+          // Treat all tags starting with 'usa-' as custom elements
+          isCustomElement: (tag) => tag.startsWith("usa-"),
+        },
+      },
+    }),
+  ],
+});
diff --git a/storybook/framework-guidance.mdx b/storybook/framework-guidance.mdx
@@ -5,6 +5,7 @@ import SolidExample from "../examples/with-solid/src/App.tsx?raw";
 import SolidTsconfigExample from "../examples/with-solid/tsconfig.app.json?raw";
 import SolidDTsExample from "../examples/with-solid/src/custom-elements.d.ts?raw";
 import SvelteKitExample from "../examples/with-sveltekit/src/routes/+page.svelte?raw";
+import VueExample from "../examples/with-vue/src/App.vue?raw";
 
 <Meta title="Documentation/Framework Specific Guidance" />
 
@@ -65,3 +66,31 @@ Once you do that, ensure that your `tsconfig.json` file contains`"include": ["sr
 This is a minimal example of implementation in [SvelteKit](https://svelte.dev/docs/kit/introduction).
 
 <Source code={SvelteKitExample} language="svelte" />
+
+### Vue
+
+This is a minimal example of implementation in [Vue](https://vuejs.org/).
+
+<Source code={VueExample} language="vue" />
+
+Additionally, your build tool needs to know about the custom elements so they are not parsed at build time. This is how you do it in Vite:
+
+```
+// vite.config.ts
+import { defineConfig } from "vite";
+import vue from "@vitejs/plugin-vue";
+
+export default defineConfig({
+  plugins: [
+    vue({
+      template: {
+        compilerOptions: {
+          // Treat all tags starting with 'usa-' as custom elements
+          isCustomElement: (tag) => tag.startsWith("usa-"),
+        },
+      },
+    }),
+  ],
+});
+
+```

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "recommendations": ["Vue.volar"]`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Vue`
	`2`	`+`
	`3`	`+This is a bare-bones example to demonstrate how to use USWDS Elements in a Vue project.`