技能包

Nuxt UI:在 v4 裡接入元件庫,並讓 Agent 按 AGENTS.md 工作

適合要在 Nuxt 專案接入這套 Vue UI、或讓編碼 Agent 按倉庫規範改元件的人,但當前頁面是 v4 分支,不要和 v3/v2 混用。

官方來源 · Nuxt UI

安裝

pnpm add @nuxt/ui tailwindcss

適合誰

如果你在做 Nuxt 介面,希望用現成的 Vue UI,而不是從零拼無障礙元件,這個倉庫更合適。它把 Reka UI、Tailwind CSS 和 Tailwind Variants 合在一起,用來做複雜、可訪問、高效能的介面。相關上游分別是

https://reka-ui.com/

https://tailwindcss.com/

https://www.tailwind-variants.org/

你需要一個能改 nuxt.config 的 Nuxt 專案,並接受用 pnpm 安裝依賴。只想讓編碼 Agent 幫忙改元件、主題或測試的人,應先讀倉庫提供的 AGENTS.md。它沒有把某一家 Agent 產品寫成唯一支援對象,只說會被所有 AI coding agents 自動拾取。

3 分鐘完成第一次嘗試

官方安裝命令按頁面寫成這一條:

pnpm add @nuxt/ui tailwindcss

這會改專案依賴,不是唯讀查看。先確認當前目錄就是你的 Nuxt 應用、本機有 pnpm,再執行。裝完後把模組寫進設定,摘錄給出的是:

export default defineNuxtConfig({
  modules: ['@nuxt/ui'],
  css: ['~/assets/css/main.css']
})

它要求存在 ~/assets/css/main.css 這條 CSS 入口,但沒有寫出該檔內容。不要自行補 @import 或元件用法。成功訊號是:依賴已裝上,modules 裡能看到 @nuxt/ui,應用能按你現有方式啟動且沒有因為缺這個模組而報錯。若 Agent 開始添加未在摘錄中出現的按鈕示例或改主題 token,先停下來。

更低風險的核對:打開

https://github.com/nuxt/ui/blob/v4/AGENTS.md

讓 Agent 只解釋元件結構或主題約定,先不改檔。

使用案例

案例一:在 Nuxt 應用接入 v4。按上面的 pnpm 命令安裝 @nuxt/ui 和 tailwindcss,再註冊 @nuxt/ui 模組並指向 ~/assets/css/main.css。頁面沒有寫 npm/yarn 等價命令,也沒有寫 Vue 單檔裡第一個元件該怎麼引。因此你能確認的只有:依賴和模組註冊這兩步。CSS 檔裡要寫什麼、頁面上要放哪個元件,都超出這份摘錄,必須另查你本地已有文件或源碼,不能假裝這裡已經給過。

案例二:讓編碼 Agent 按倉庫規範做事。AGENTS.md 為 AI 助手提供貢獻指南,涵蓋元件結構、主題模式、測試約定和文件指引,並且會被自動拾取。任務應是唯讀對照,例如「按 AGENTS.md 檢查這個元件的結構/主題/測試是否偏離」。它沒有寫具體測試命令,也沒有寫文件站點的發布方式。所以第一次不要讓 Agent 批次重寫文件或補測試檔;先讓它指出依據段落和將改路徑。

使用邊界

你現在看的是 v4 分支。Nuxt UI v3 在

https://github.com/nuxt/ui/tree/v3

v2 在

https://github.com/nuxt/ui/tree/v2

不要把舊分支的模組名、目錄或主題寫法套到 v4。頁面沒有寫 v4 與 v3 的遷移表。

安裝路徑就是 pnpm add @nuxt/ui tailwindcss。不要並列另一套套件管理器命令。Reka UI 和 Tailwind Variants 被寫成能力來源,不是第二條安裝器。

第一次停在裝依賴、註冊模組,或唯讀 AGENTS.md。任何改元件源碼、補測試、改主題或重寫 CSS 入口的動作,都要先讓 Agent 複述將改的檔,你確認後再繼續。