opencode-agent-kit 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (361) hide show
  1. package/README.md +796 -0
  2. package/bin/commands/init.mjs +221 -0
  3. package/bin/init.mjs +21 -0
  4. package/package.json +22 -0
  5. package/template/.opencode/agent-docs/backend/README.md +0 -0
  6. package/template/.opencode/agent-docs/backend/node/BACKEND_PATTERNS.md +82 -0
  7. package/template/.opencode/agent-docs/backend/node/BACKEND_QUICK_START.md +49 -0
  8. package/template/.opencode/agent-docs/frontend/next/README.md +0 -0
  9. package/template/.opencode/agent-docs/frontend/nuxt/API_PATTERNS.md +807 -0
  10. package/template/.opencode/agent-docs/frontend/nuxt/CHEATSHEET.md +676 -0
  11. package/template/.opencode/agent-docs/frontend/nuxt/COMPLETION_REPORT.md +613 -0
  12. package/template/.opencode/agent-docs/frontend/nuxt/EXAMPLES.md +956 -0
  13. package/template/.opencode/agent-docs/frontend/nuxt/INDEX.md +596 -0
  14. package/template/.opencode/agent-docs/frontend/nuxt/MCP_GUIDE.md +881 -0
  15. package/template/.opencode/agent-docs/frontend/nuxt/MENTOR_CURRICULUM_30_DAYS.md +256 -0
  16. package/template/.opencode/agent-docs/frontend/nuxt/MENTOR_CURRICULUM_CHECKLIST.md +156 -0
  17. package/template/.opencode/agent-docs/frontend/nuxt/MENTOR_WEEKLY_ASSIGNMENTS.md +191 -0
  18. package/template/.opencode/agent-docs/frontend/nuxt/QUICK_START.md +509 -0
  19. package/template/.opencode/agent-docs/frontend/nuxt/README.md +506 -0
  20. package/template/.opencode/agent-docs/frontend/nuxt/README_AGENTS.md +140 -0
  21. package/template/.opencode/agent-docs/frontend/nuxt/README_DOCS.md +65 -0
  22. package/template/.opencode/agent-docs/frontend/nuxt/SUMMARY.md +474 -0
  23. package/template/.opencode/agent-docs/frontend/nuxt/TEAM_OPERATING_GUIDE.md +54 -0
  24. package/template/.opencode/agent-docs/frontend/nuxt/TESTING_GUIDE.md +904 -0
  25. package/template/.opencode/agent-docs/frontend/nuxt/WORKFLOWS.md +758 -0
  26. package/template/.opencode/agent-docs/frontend/react/API_PATTERNS.md +187 -0
  27. package/template/.opencode/agent-docs/frontend/react/CHEATSHEET.md +87 -0
  28. package/template/.opencode/agent-docs/frontend/react/INDEX.md +45 -0
  29. package/template/.opencode/agent-docs/frontend/react/QUICK_START.md +43 -0
  30. package/template/.opencode/agent-docs/frontend/react/README.md +159 -0
  31. package/template/.opencode/agent-docs/frontend/vue/README.md +0 -0
  32. package/template/.opencode/agent-docs/mobile/android/README.md +45 -0
  33. package/template/.opencode/agent-docs/mobile/flutter/README.md +44 -0
  34. package/template/.opencode/agents/android-developer.md +418 -0
  35. package/template/.opencode/agents/code-igniter-3-fullstack.md +345 -0
  36. package/template/.opencode/agents/code-reviewer.md +517 -0
  37. package/template/.opencode/agents/database-specialist.md +455 -0
  38. package/template/.opencode/agents/devops-specialist.md +562 -0
  39. package/template/.opencode/agents/flutter-developer.md +556 -0
  40. package/template/.opencode/agents/it-leader.md +911 -0
  41. package/template/.opencode/agents/laravel-advanced.md +691 -0
  42. package/template/.opencode/agents/node-backend-developer.md +343 -0
  43. package/template/.opencode/agents/nuxt-frontend-developer-mentor.md +402 -0
  44. package/template/.opencode/agents/nuxt-frontend-developer.md +1573 -0
  45. package/template/.opencode/agents/react-frontend-developer.md +1017 -0
  46. package/template/.opencode/agents/seo-specialist.md +681 -0
  47. package/template/.opencode/agents/ui-ux-designer.md +783 -0
  48. package/template/.opencode/commands/android-build/command.md +25 -0
  49. package/template/.opencode/commands/android-test/command.md +23 -0
  50. package/template/.opencode/commands/build-fix.md +29 -0
  51. package/template/.opencode/commands/checkpoint.md +74 -0
  52. package/template/.opencode/commands/code-review.md +40 -0
  53. package/template/.opencode/commands/e2e.md +363 -0
  54. package/template/.opencode/commands/eval.md +120 -0
  55. package/template/.opencode/commands/evolve.md +193 -0
  56. package/template/.opencode/commands/flutter-build/command.md +25 -0
  57. package/template/.opencode/commands/flutter-test/command.md +24 -0
  58. package/template/.opencode/commands/go-build.md +183 -0
  59. package/template/.opencode/commands/go-review.md +148 -0
  60. package/template/.opencode/commands/go-test.md +268 -0
  61. package/template/.opencode/commands/gpc-release/command.md +30 -0
  62. package/template/.opencode/commands/instinct-export.md +91 -0
  63. package/template/.opencode/commands/instinct-import.md +142 -0
  64. package/template/.opencode/commands/instinct-status.md +86 -0
  65. package/template/.opencode/commands/learn.md +70 -0
  66. package/template/.opencode/commands/multi-backend.md +158 -0
  67. package/template/.opencode/commands/multi-execute.md +310 -0
  68. package/template/.opencode/commands/multi-frontend.md +158 -0
  69. package/template/.opencode/commands/multi-plan.md +261 -0
  70. package/template/.opencode/commands/multi-workflow.md +183 -0
  71. package/template/.opencode/commands/orchestrate.md +172 -0
  72. package/template/.opencode/commands/plan.md +113 -0
  73. package/template/.opencode/commands/pm2.md +271 -0
  74. package/template/.opencode/commands/python-review.md +297 -0
  75. package/template/.opencode/commands/refactor-clean.md +28 -0
  76. package/template/.opencode/commands/sessions.md +305 -0
  77. package/template/.opencode/commands/setup-pm.md +80 -0
  78. package/template/.opencode/commands/skill-create.md +174 -0
  79. package/template/.opencode/commands/tdd.md +326 -0
  80. package/template/.opencode/commands/test-coverage.md +27 -0
  81. package/template/.opencode/commands/update-codemaps.md +17 -0
  82. package/template/.opencode/commands/update-docs.md +31 -0
  83. package/template/.opencode/commands/verify.md +59 -0
  84. package/template/.opencode/config.example.json +309 -0
  85. package/template/.opencode/config.json +341 -0
  86. package/template/.opencode/contexts/dev.md +20 -0
  87. package/template/.opencode/contexts/research.md +26 -0
  88. package/template/.opencode/contexts/review.md +22 -0
  89. package/template/.opencode/hooks/hooks.json +169 -0
  90. package/template/.opencode/instructions/INSTRUCTIONS.md +388 -0
  91. package/template/.opencode/package.json +5 -0
  92. package/template/.opencode/rules/README.md +82 -0
  93. package/template/.opencode/rules/android/gradle.md +62 -0
  94. package/template/.opencode/rules/android/testing.md +27 -0
  95. package/template/.opencode/rules/common/agents.md +49 -0
  96. package/template/.opencode/rules/common/coding-style.md +48 -0
  97. package/template/.opencode/rules/common/git-workflow.md +45 -0
  98. package/template/.opencode/rules/common/hooks.md +30 -0
  99. package/template/.opencode/rules/common/patterns.md +31 -0
  100. package/template/.opencode/rules/common/performance.md +55 -0
  101. package/template/.opencode/rules/common/security.md +29 -0
  102. package/template/.opencode/rules/common/testing.md +29 -0
  103. package/template/.opencode/rules/flutter/state-management.md +57 -0
  104. package/template/.opencode/rules/flutter/testing.md +42 -0
  105. package/template/.opencode/rules/golang/coding-style.md +26 -0
  106. package/template/.opencode/rules/golang/hooks.md +11 -0
  107. package/template/.opencode/rules/golang/patterns.md +39 -0
  108. package/template/.opencode/rules/golang/security.md +28 -0
  109. package/template/.opencode/rules/golang/testing.md +25 -0
  110. package/template/.opencode/rules/mobile/performance.md +36 -0
  111. package/template/.opencode/rules/python/coding-style.md +37 -0
  112. package/template/.opencode/rules/python/hooks.md +14 -0
  113. package/template/.opencode/rules/python/patterns.md +34 -0
  114. package/template/.opencode/rules/python/security.md +25 -0
  115. package/template/.opencode/rules/python/testing.md +33 -0
  116. package/template/.opencode/rules/typescript/coding-style.md +58 -0
  117. package/template/.opencode/rules/typescript/hooks.md +15 -0
  118. package/template/.opencode/rules/typescript/patterns.md +45 -0
  119. package/template/.opencode/rules/typescript/security.md +21 -0
  120. package/template/.opencode/rules/typescript/testing.md +11 -0
  121. package/template/.opencode/skills/api-documentation/SKILL.md +188 -0
  122. package/template/.opencode/skills/backend-patterns/SKILL.md +587 -0
  123. package/template/.opencode/skills/building-components/SKILL.md +37 -0
  124. package/template/.opencode/skills/building-components/references/accessibility.mdx +819 -0
  125. package/template/.opencode/skills/building-components/references/as-child.mdx +324 -0
  126. package/template/.opencode/skills/building-components/references/composition.mdx +239 -0
  127. package/template/.opencode/skills/building-components/references/data-attributes.mdx +413 -0
  128. package/template/.opencode/skills/building-components/references/definitions.mdx +258 -0
  129. package/template/.opencode/skills/building-components/references/design-tokens.mdx +57 -0
  130. package/template/.opencode/skills/building-components/references/docs.mdx +155 -0
  131. package/template/.opencode/skills/building-components/references/marketplaces.mdx +144 -0
  132. package/template/.opencode/skills/building-components/references/npm.mdx +166 -0
  133. package/template/.opencode/skills/building-components/references/polymorphism.mdx +583 -0
  134. package/template/.opencode/skills/building-components/references/principles.mdx +61 -0
  135. package/template/.opencode/skills/building-components/references/registry.mdx +169 -0
  136. package/template/.opencode/skills/building-components/references/state.mdx +99 -0
  137. package/template/.opencode/skills/building-components/references/styling.mdx +286 -0
  138. package/template/.opencode/skills/building-components/references/types.mdx +191 -0
  139. package/template/.opencode/skills/clickhouse-io/SKILL.md +429 -0
  140. package/template/.opencode/skills/coding-standards/SKILL.md +520 -0
  141. package/template/.opencode/skills/configure-ecc/SKILL.md +298 -0
  142. package/template/.opencode/skills/continuous-learning/SKILL.md +110 -0
  143. package/template/.opencode/skills/continuous-learning/config.json +18 -0
  144. package/template/.opencode/skills/continuous-learning/evaluate-session.sh +60 -0
  145. package/template/.opencode/skills/continuous-learning-v2/SKILL.md +284 -0
  146. package/template/.opencode/skills/continuous-learning-v2/agents/observer.md +137 -0
  147. package/template/.opencode/skills/continuous-learning-v2/agents/start-observer.sh +134 -0
  148. package/template/.opencode/skills/continuous-learning-v2/config.json +41 -0
  149. package/template/.opencode/skills/continuous-learning-v2/hooks/observe.sh +153 -0
  150. package/template/.opencode/skills/continuous-learning-v2/scripts/instinct-cli.py +489 -0
  151. package/template/.opencode/skills/continuous-learning-v2/scripts/test_parse_instinct.py +82 -0
  152. package/template/.opencode/skills/dart-add-unit-test/SKILL.md +122 -0
  153. package/template/.opencode/skills/dart-build-cli-app/SKILL.md +185 -0
  154. package/template/.opencode/skills/dart-collect-coverage/SKILL.md +141 -0
  155. package/template/.opencode/skills/dart-fix-runtime-errors/SKILL.md +166 -0
  156. package/template/.opencode/skills/dart-generate-test-mocks/SKILL.md +155 -0
  157. package/template/.opencode/skills/dart-migrate-to-checks-package/SKILL.md +126 -0
  158. package/template/.opencode/skills/dart-resolve-package-conflicts/SKILL.md +116 -0
  159. package/template/.opencode/skills/dart-run-static-analysis/SKILL.md +104 -0
  160. package/template/.opencode/skills/dart-use-pattern-matching/SKILL.md +146 -0
  161. package/template/.opencode/skills/django-patterns/SKILL.md +733 -0
  162. package/template/.opencode/skills/django-security/SKILL.md +592 -0
  163. package/template/.opencode/skills/django-tdd/SKILL.md +728 -0
  164. package/template/.opencode/skills/django-verification/SKILL.md +460 -0
  165. package/template/.opencode/skills/eval-harness/SKILL.md +227 -0
  166. package/template/.opencode/skills/firebase-basics/SKILL.md +103 -0
  167. package/template/.opencode/skills/firebase-basics/references/additional-skills.md +113 -0
  168. package/template/.opencode/skills/firebase-basics/references/cli-usage.md +31 -0
  169. package/template/.opencode/skills/firebase-basics/references/client-library-usage.md +45 -0
  170. package/template/.opencode/skills/firebase-basics/references/core-concepts.md +61 -0
  171. package/template/.opencode/skills/firebase-basics/references/iac-usage.md +40 -0
  172. package/template/.opencode/skills/firebase-basics/references/iam-security.md +74 -0
  173. package/template/.opencode/skills/firebase-basics/references/mcp-usage.md +63 -0
  174. package/template/.opencode/skills/flutter/SKILL.md +292 -0
  175. package/template/.opencode/skills/flutter-add-integration-test/SKILL.md +163 -0
  176. package/template/.opencode/skills/flutter-add-widget-preview/SKILL.md +145 -0
  177. package/template/.opencode/skills/flutter-add-widget-test/SKILL.md +154 -0
  178. package/template/.opencode/skills/flutter-apply-architecture-best-practices/SKILL.md +162 -0
  179. package/template/.opencode/skills/flutter-build-responsive-layout/SKILL.md +139 -0
  180. package/template/.opencode/skills/flutter-fix-layout-issues/SKILL.md +130 -0
  181. package/template/.opencode/skills/flutter-implement-json-serialization/SKILL.md +153 -0
  182. package/template/.opencode/skills/flutter-setup-declarative-routing/SKILL.md +255 -0
  183. package/template/.opencode/skills/flutter-setup-localization/SKILL.md +210 -0
  184. package/template/.opencode/skills/flutter-use-http-package/SKILL.md +174 -0
  185. package/template/.opencode/skills/frontend-design/SKILL.md +89 -0
  186. package/template/.opencode/skills/frontend-patterns/SKILL.md +631 -0
  187. package/template/.opencode/skills/golang-patterns/SKILL.md +673 -0
  188. package/template/.opencode/skills/golang-testing/SKILL.md +719 -0
  189. package/template/.opencode/skills/impeccable/SKILL.md +165 -0
  190. package/template/.opencode/skills/impeccable/agents/impeccable-asset-producer.md +101 -0
  191. package/template/.opencode/skills/impeccable/reference/adapt.md +190 -0
  192. package/template/.opencode/skills/impeccable/reference/animate.md +175 -0
  193. package/template/.opencode/skills/impeccable/reference/audit.md +133 -0
  194. package/template/.opencode/skills/impeccable/reference/bolder.md +113 -0
  195. package/template/.opencode/skills/impeccable/reference/brand.md +118 -0
  196. package/template/.opencode/skills/impeccable/reference/clarify.md +174 -0
  197. package/template/.opencode/skills/impeccable/reference/codex.md +105 -0
  198. package/template/.opencode/skills/impeccable/reference/cognitive-load.md +106 -0
  199. package/template/.opencode/skills/impeccable/reference/color-and-contrast.md +105 -0
  200. package/template/.opencode/skills/impeccable/reference/colorize.md +154 -0
  201. package/template/.opencode/skills/impeccable/reference/craft.md +123 -0
  202. package/template/.opencode/skills/impeccable/reference/critique.md +273 -0
  203. package/template/.opencode/skills/impeccable/reference/delight.md +302 -0
  204. package/template/.opencode/skills/impeccable/reference/distill.md +111 -0
  205. package/template/.opencode/skills/impeccable/reference/document.md +427 -0
  206. package/template/.opencode/skills/impeccable/reference/extract.md +69 -0
  207. package/template/.opencode/skills/impeccable/reference/harden.md +347 -0
  208. package/template/.opencode/skills/impeccable/reference/heuristics-scoring.md +234 -0
  209. package/template/.opencode/skills/impeccable/reference/interaction-design.md +195 -0
  210. package/template/.opencode/skills/impeccable/reference/layout.md +141 -0
  211. package/template/.opencode/skills/impeccable/reference/live.md +622 -0
  212. package/template/.opencode/skills/impeccable/reference/motion-design.md +109 -0
  213. package/template/.opencode/skills/impeccable/reference/onboard.md +234 -0
  214. package/template/.opencode/skills/impeccable/reference/optimize.md +258 -0
  215. package/template/.opencode/skills/impeccable/reference/overdrive.md +130 -0
  216. package/template/.opencode/skills/impeccable/reference/personas.md +179 -0
  217. package/template/.opencode/skills/impeccable/reference/polish.md +242 -0
  218. package/template/.opencode/skills/impeccable/reference/product.md +62 -0
  219. package/template/.opencode/skills/impeccable/reference/quieter.md +99 -0
  220. package/template/.opencode/skills/impeccable/reference/responsive-design.md +114 -0
  221. package/template/.opencode/skills/impeccable/reference/shape.md +165 -0
  222. package/template/.opencode/skills/impeccable/reference/spatial-design.md +100 -0
  223. package/template/.opencode/skills/impeccable/reference/teach.md +156 -0
  224. package/template/.opencode/skills/impeccable/reference/typeset.md +124 -0
  225. package/template/.opencode/skills/impeccable/reference/typography.md +159 -0
  226. package/template/.opencode/skills/impeccable/reference/ux-writing.md +107 -0
  227. package/template/.opencode/skills/impeccable/scripts/cleanup-deprecated.mjs +284 -0
  228. package/template/.opencode/skills/impeccable/scripts/command-metadata.json +94 -0
  229. package/template/.opencode/skills/impeccable/scripts/critique-storage.mjs +242 -0
  230. package/template/.opencode/skills/impeccable/scripts/design-parser.mjs +820 -0
  231. package/template/.opencode/skills/impeccable/scripts/detect-csp.mjs +198 -0
  232. package/template/.opencode/skills/impeccable/scripts/detect.mjs +21 -0
  233. package/template/.opencode/skills/impeccable/scripts/impeccable-paths.mjs +110 -0
  234. package/template/.opencode/skills/impeccable/scripts/is-generated.mjs +69 -0
  235. package/template/.opencode/skills/impeccable/scripts/live-accept.mjs +595 -0
  236. package/template/.opencode/skills/impeccable/scripts/live-browser-session.js +123 -0
  237. package/template/.opencode/skills/impeccable/scripts/live-browser.js +4860 -0
  238. package/template/.opencode/skills/impeccable/scripts/live-complete.mjs +75 -0
  239. package/template/.opencode/skills/impeccable/scripts/live-completion.mjs +18 -0
  240. package/template/.opencode/skills/impeccable/scripts/live-inject.mjs +446 -0
  241. package/template/.opencode/skills/impeccable/scripts/live-poll.mjs +200 -0
  242. package/template/.opencode/skills/impeccable/scripts/live-resume.mjs +48 -0
  243. package/template/.opencode/skills/impeccable/scripts/live-server.mjs +838 -0
  244. package/template/.opencode/skills/impeccable/scripts/live-session-store.mjs +254 -0
  245. package/template/.opencode/skills/impeccable/scripts/live-status.mjs +47 -0
  246. package/template/.opencode/skills/impeccable/scripts/live-wrap.mjs +632 -0
  247. package/template/.opencode/skills/impeccable/scripts/live.mjs +247 -0
  248. package/template/.opencode/skills/impeccable/scripts/load-context.mjs +141 -0
  249. package/template/.opencode/skills/impeccable/scripts/modern-screenshot.umd.js +14 -0
  250. package/template/.opencode/skills/impeccable/scripts/pin.mjs +214 -0
  251. package/template/.opencode/skills/iterative-retrieval/SKILL.md +202 -0
  252. package/template/.opencode/skills/java-coding-standards/SKILL.md +138 -0
  253. package/template/.opencode/skills/jetpack-compose/.skillfish.json +10 -0
  254. package/template/.opencode/skills/jetpack-compose/SKILL.md +420 -0
  255. package/template/.opencode/skills/jpa-patterns/SKILL.md +141 -0
  256. package/template/.opencode/skills/nutrient-document-processing/SKILL.md +165 -0
  257. package/template/.opencode/skills/nuxt-ui/SKILL.md +334 -0
  258. package/template/.opencode/skills/nuxt-ui/references/components.md +377 -0
  259. package/template/.opencode/skills/nuxt-ui/references/composables.md +127 -0
  260. package/template/.opencode/skills/nuxt-ui/references/layouts/chat.md +266 -0
  261. package/template/.opencode/skills/nuxt-ui/references/layouts/dashboard.md +220 -0
  262. package/template/.opencode/skills/nuxt-ui/references/layouts/docs.md +141 -0
  263. package/template/.opencode/skills/nuxt-ui/references/layouts/editor.md +168 -0
  264. package/template/.opencode/skills/nuxt-ui/references/layouts/page.md +260 -0
  265. package/template/.opencode/skills/nuxt-ui/references/theming.md +427 -0
  266. package/template/.opencode/skills/postgres-patterns/SKILL.md +146 -0
  267. package/template/.opencode/skills/project-guidelines-example/SKILL.md +345 -0
  268. package/template/.opencode/skills/python-patterns/SKILL.md +749 -0
  269. package/template/.opencode/skills/python-testing/SKILL.md +815 -0
  270. package/template/.opencode/skills/security-review/SKILL.md +494 -0
  271. package/template/.opencode/skills/security-review/cloud-infrastructure-security.md +361 -0
  272. package/template/.opencode/skills/shadcn-ui/README.md +248 -0
  273. package/template/.opencode/skills/shadcn-ui/SKILL.md +326 -0
  274. package/template/.opencode/skills/shadcn-ui/examples/auth-layout.tsx +177 -0
  275. package/template/.opencode/skills/shadcn-ui/examples/data-table.tsx +313 -0
  276. package/template/.opencode/skills/shadcn-ui/examples/form-pattern.tsx +177 -0
  277. package/template/.opencode/skills/shadcn-ui/resources/component-catalog.md +481 -0
  278. package/template/.opencode/skills/shadcn-ui/resources/customization-guide.md +516 -0
  279. package/template/.opencode/skills/shadcn-ui/resources/migration-guide.md +463 -0
  280. package/template/.opencode/skills/shadcn-ui/resources/setup-guide.md +412 -0
  281. package/template/.opencode/skills/shadcn-ui/scripts/verify-setup.sh +134 -0
  282. package/template/.opencode/skills/springboot-patterns/SKILL.md +304 -0
  283. package/template/.opencode/skills/springboot-security/SKILL.md +119 -0
  284. package/template/.opencode/skills/springboot-tdd/SKILL.md +157 -0
  285. package/template/.opencode/skills/springboot-verification/SKILL.md +100 -0
  286. package/template/.opencode/skills/strategic-compact/SKILL.md +63 -0
  287. package/template/.opencode/skills/strategic-compact/suggest-compact.sh +52 -0
  288. package/template/.opencode/skills/tdd-workflow/SKILL.md +409 -0
  289. package/template/.opencode/skills/vercel-composition-patterns/AGENTS.md +946 -0
  290. package/template/.opencode/skills/vercel-composition-patterns/SKILL.md +89 -0
  291. package/template/.opencode/skills/vercel-composition-patterns/rules/architecture-avoid-boolean-props.md +100 -0
  292. package/template/.opencode/skills/vercel-composition-patterns/rules/architecture-compound-components.md +112 -0
  293. package/template/.opencode/skills/vercel-composition-patterns/rules/patterns-children-over-render-props.md +87 -0
  294. package/template/.opencode/skills/vercel-composition-patterns/rules/patterns-explicit-variants.md +100 -0
  295. package/template/.opencode/skills/vercel-composition-patterns/rules/react19-no-forwardref.md +42 -0
  296. package/template/.opencode/skills/vercel-composition-patterns/rules/state-context-interface.md +191 -0
  297. package/template/.opencode/skills/vercel-composition-patterns/rules/state-decouple-implementation.md +113 -0
  298. package/template/.opencode/skills/vercel-composition-patterns/rules/state-lift-state.md +125 -0
  299. package/template/.opencode/skills/vercel-react-best-practices/AGENTS.md +2934 -0
  300. package/template/.opencode/skills/vercel-react-best-practices/SKILL.md +136 -0
  301. package/template/.opencode/skills/vercel-react-best-practices/rules/advanced-event-handler-refs.md +55 -0
  302. package/template/.opencode/skills/vercel-react-best-practices/rules/advanced-init-once.md +42 -0
  303. package/template/.opencode/skills/vercel-react-best-practices/rules/advanced-use-latest.md +39 -0
  304. package/template/.opencode/skills/vercel-react-best-practices/rules/async-api-routes.md +38 -0
  305. package/template/.opencode/skills/vercel-react-best-practices/rules/async-defer-await.md +80 -0
  306. package/template/.opencode/skills/vercel-react-best-practices/rules/async-dependencies.md +51 -0
  307. package/template/.opencode/skills/vercel-react-best-practices/rules/async-parallel.md +28 -0
  308. package/template/.opencode/skills/vercel-react-best-practices/rules/async-suspense-boundaries.md +99 -0
  309. package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-barrel-imports.md +59 -0
  310. package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-conditional.md +31 -0
  311. package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-defer-third-party.md +49 -0
  312. package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-dynamic-imports.md +35 -0
  313. package/template/.opencode/skills/vercel-react-best-practices/rules/bundle-preload.md +50 -0
  314. package/template/.opencode/skills/vercel-react-best-practices/rules/client-event-listeners.md +74 -0
  315. package/template/.opencode/skills/vercel-react-best-practices/rules/client-localstorage-schema.md +71 -0
  316. package/template/.opencode/skills/vercel-react-best-practices/rules/client-passive-event-listeners.md +48 -0
  317. package/template/.opencode/skills/vercel-react-best-practices/rules/client-swr-dedup.md +56 -0
  318. package/template/.opencode/skills/vercel-react-best-practices/rules/js-batch-dom-css.md +107 -0
  319. package/template/.opencode/skills/vercel-react-best-practices/rules/js-cache-function-results.md +80 -0
  320. package/template/.opencode/skills/vercel-react-best-practices/rules/js-cache-property-access.md +28 -0
  321. package/template/.opencode/skills/vercel-react-best-practices/rules/js-cache-storage.md +70 -0
  322. package/template/.opencode/skills/vercel-react-best-practices/rules/js-combine-iterations.md +32 -0
  323. package/template/.opencode/skills/vercel-react-best-practices/rules/js-early-exit.md +50 -0
  324. package/template/.opencode/skills/vercel-react-best-practices/rules/js-hoist-regexp.md +45 -0
  325. package/template/.opencode/skills/vercel-react-best-practices/rules/js-index-maps.md +37 -0
  326. package/template/.opencode/skills/vercel-react-best-practices/rules/js-length-check-first.md +49 -0
  327. package/template/.opencode/skills/vercel-react-best-practices/rules/js-min-max-loop.md +82 -0
  328. package/template/.opencode/skills/vercel-react-best-practices/rules/js-set-map-lookups.md +24 -0
  329. package/template/.opencode/skills/vercel-react-best-practices/rules/js-tosorted-immutable.md +57 -0
  330. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-activity.md +26 -0
  331. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-animate-svg-wrapper.md +47 -0
  332. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-conditional-render.md +40 -0
  333. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-content-visibility.md +38 -0
  334. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-hoist-jsx.md +46 -0
  335. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-hydration-no-flicker.md +82 -0
  336. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-hydration-suppress-warning.md +30 -0
  337. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-svg-precision.md +28 -0
  338. package/template/.opencode/skills/vercel-react-best-practices/rules/rendering-usetransition-loading.md +75 -0
  339. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-defer-reads.md +39 -0
  340. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-dependencies.md +45 -0
  341. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-derived-state-no-effect.md +40 -0
  342. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-derived-state.md +29 -0
  343. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-functional-setstate.md +74 -0
  344. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-lazy-state-init.md +58 -0
  345. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-memo-with-default-value.md +38 -0
  346. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-memo.md +44 -0
  347. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-move-effect-to-event.md +45 -0
  348. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-simple-expression-in-memo.md +35 -0
  349. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-transitions.md +40 -0
  350. package/template/.opencode/skills/vercel-react-best-practices/rules/rerender-use-ref-transient-values.md +73 -0
  351. package/template/.opencode/skills/vercel-react-best-practices/rules/server-after-nonblocking.md +73 -0
  352. package/template/.opencode/skills/vercel-react-best-practices/rules/server-auth-actions.md +96 -0
  353. package/template/.opencode/skills/vercel-react-best-practices/rules/server-cache-lru.md +41 -0
  354. package/template/.opencode/skills/vercel-react-best-practices/rules/server-cache-react.md +76 -0
  355. package/template/.opencode/skills/vercel-react-best-practices/rules/server-dedup-props.md +65 -0
  356. package/template/.opencode/skills/vercel-react-best-practices/rules/server-parallel-fetching.md +83 -0
  357. package/template/.opencode/skills/vercel-react-best-practices/rules/server-serialization.md +38 -0
  358. package/template/.opencode/skills/verification-loop/SKILL.md +120 -0
  359. package/template/.opencode/skills/web-design-guidelines/SKILL.md +39 -0
  360. package/template/AGENTS.md +32 -0
  361. package/template/opencode.json +354 -0
@@ -0,0 +1,377 @@
1
+ # Components
2
+
3
+ 125+ Vue components powered by Tailwind CSS and Reka UI. For any component's theme slots, read the generated theme file (Nuxt: `.nuxt/ui/<component>.ts`, Vue: `node_modules/.nuxt-ui/ui/<component>.ts`).
4
+
5
+ ## Layout
6
+
7
+ Core structural components for organizing your application's layout.
8
+
9
+ | Component | Purpose |
10
+ |---|---|
11
+ | `UApp` | **Required** root wrapper for toasts, tooltips, overlays |
12
+ | `UHeader` | Responsive header with mobile menu (`#title`, `#default`, `#right`, `#body`) |
13
+ | `UFooter` | Footer (`#left`, `#default`, `#right`, `#top`, `#bottom`) |
14
+ | `UFooterColumns` | Multi-column footer with link groups |
15
+ | `UMain` | Main content area (respects `--ui-header-height`) |
16
+ | `UContainer` | Centered max-width container (`--ui-container`) |
17
+
18
+ ## Element
19
+
20
+ Essential UI building blocks.
21
+
22
+ | Component | Key props |
23
+ |---|---|
24
+ | `UButton` | `label`, `icon`, `color`, `variant`, `size`, `loading`, `disabled`, `to` |
25
+ | `UBadge` | `label`, `color`, `variant`, `size` |
26
+ | `UAvatar` | `src`, `alt`, `icon`, `text`, `size` |
27
+ | `UAvatarGroup` | `max`, `size` — wraps multiple `UAvatar` |
28
+ | `UIcon` | `name`, `size` |
29
+ | `UCard` | `variant` — slots: `#header`, `#default`, `#footer` |
30
+ | `UAlert` | `title`, `description`, `icon`, `color`, `variant`, `close` |
31
+ | `UBanner` | `title`, `icon`, `close` — sticky top banner |
32
+ | `UChip` | `color`, `size`, `position` — notification dot on children |
33
+ | `UKbd` | `value` — keyboard key display |
34
+ | `USeparator` | `label`, `icon`, `orientation`, `type` |
35
+ | `USkeleton` | `class` — loading placeholder |
36
+ | `UProgress` | `value`, `max`, `color`, `size` |
37
+ | `UCalendar` | `v-model`, `range` (boolean), `multiple` (boolean) |
38
+ | `UCollapsible` | `v-model:open` — animated expand/collapse |
39
+ | `UFieldGroup` | Groups form inputs horizontally/vertically |
40
+
41
+ ## Form
42
+
43
+ Comprehensive form components for user input.
44
+
45
+ | Component | Key props |
46
+ |---|---|
47
+ | `UInput` | `v-model`, `type`, `placeholder`, `icon`, `loading` |
48
+ | `UTextarea` | `v-model`, `rows`, `autoresize`, `maxrows` |
49
+ | `USelect` | `v-model`, `items` (flat `T[]` or grouped `T[][]`), `placeholder` |
50
+ | `USelectMenu` | `v-model`, `items` (flat `T[]` or grouped `T[][]`), `searchable`, `multiple` |
51
+ | `UInputMenu` | `v-model`, `items` (flat `T[]` or grouped `T[][]`), `searchable` — autocomplete |
52
+ | `UInputNumber` | `v-model`, `min`, `max`, `step` |
53
+ | `UInputDate` | `v-model`, `range` (boolean for range selection), `locale` |
54
+ | `UInputTime` | `v-model`, `hour-cycle` (12/24), `granularity` |
55
+ | `UInputTags` | `v-model`, `max`, `placeholder` |
56
+ | `UPinInput` | `v-model`, `length`, `type`, `mask` |
57
+ | `UCheckbox` | `v-model`, `label`, `description` |
58
+ | `UCheckboxGroup` | `v-model`, `items`, `orientation` |
59
+ | `URadioGroup` | `v-model`, `items`, `orientation` |
60
+ | `USwitch` | `v-model`, `label`, `on-icon`, `off-icon` |
61
+ | `USlider` | `v-model`, `min`, `max`, `step` |
62
+ | `UColorPicker` | `v-model`, `format` (hex/rgb/hsl/cmyk/lab), `size` |
63
+ | `UFileUpload` | `v-model`, `accept`, `multiple`, `variant` (area/button) |
64
+ | `UForm` | `schema`, `state`, `@submit` — validation wrapper |
65
+ | `UFormField` | `name`, `label`, `description`, `hint`, `required` |
66
+
67
+ ### Form validation
68
+
69
+ Uses Standard Schema — works with Zod, Valibot, Yup, or Joi.
70
+
71
+ ```vue
72
+ <script setup lang="ts">
73
+ import { z } from 'zod'
74
+
75
+ const schema = z.object({
76
+ email: z.string().email('Invalid email'),
77
+ password: z.string().min(8, 'Min 8 characters')
78
+ })
79
+
80
+ type Schema = z.output<typeof schema>
81
+ const state = reactive<Partial<Schema>>({ email: '', password: '' })
82
+ const form = ref()
83
+
84
+ async function onSubmit() {
85
+ await form.value.validate()
86
+ }
87
+ </script>
88
+
89
+ <template>
90
+ <UForm ref="form" :schema="schema" :state="state" @submit="onSubmit">
91
+ <UFormField name="email" label="Email" required>
92
+ <UInput v-model="state.email" type="email" />
93
+ </UFormField>
94
+
95
+ <UFormField name="password" label="Password" required>
96
+ <UInput v-model="state.password" type="password" />
97
+ </UFormField>
98
+
99
+ <UButton type="submit">Submit</UButton>
100
+ </UForm>
101
+ </template>
102
+ ```
103
+
104
+ With Valibot:
105
+
106
+ ```vue
107
+ <script setup lang="ts">
108
+ import * as v from 'valibot'
109
+
110
+ const schema = v.object({
111
+ email: v.pipe(v.string(), v.email('Invalid email')),
112
+ password: v.pipe(v.string(), v.minLength(8, 'Min 8 characters'))
113
+ })
114
+ </script>
115
+ ```
116
+
117
+ ### File upload
118
+
119
+ ```vue
120
+ <script setup>
121
+ const files = ref<File[]>([])
122
+ </script>
123
+
124
+ <template>
125
+ <UFileUpload v-model="files" accept="image/*" multiple>
126
+ <template #actions="{ open }">
127
+ <UButton label="Upload" icon="i-lucide-upload" color="neutral" variant="outline" @click="open()" />
128
+ </template>
129
+ </UFileUpload>
130
+ </template>
131
+ ```
132
+
133
+ ## Data
134
+
135
+ Components for displaying and organizing data.
136
+
137
+ | Component | Key props |
138
+ |---|---|
139
+ | `UTable` | `data`, `columns`, `loading`, `sticky` |
140
+ | `UAccordion` | `items`, `type` (single/multiple), `collapsible` |
141
+ | `UCarousel` | `items`, `orientation`, `arrows`, `dots` |
142
+ | `UTimeline` | `items` — vertical timeline |
143
+ | `UTree` | `items` — hierarchical tree |
144
+ | `UUser` | `name`, `description`, `avatar` — user display |
145
+ | `UEmpty` | `icon`, `title`, `description` — empty state |
146
+ | `UMarquee` | `repeat`, `reverse`, `orientation`, `pauseOnHover` — infinite scroll |
147
+ | `UScrollArea` | Custom scrollbar wrapper |
148
+
149
+ ## Navigation
150
+
151
+ Components for user navigation and wayfinding.
152
+
153
+ | Component | Key props |
154
+ |---|---|
155
+ | `UNavigationMenu` | `items` (flat `T[]` or grouped `T[][]`), `orientation` (horizontal/vertical) |
156
+ | `UBreadcrumb` | `items` |
157
+ | `UTabs` | `items`, `orientation`, `variant` |
158
+ | `UStepper` | `items`, `orientation`, `color` |
159
+ | `UPagination` | `v-model`, `total`, `items-per-page` |
160
+ | `ULink` | `to`, `active`, `inactive` — styled NuxtLink |
161
+ | `UCommandPalette` | `v-model:open`, `groups` (`{ id, label, items }[]`), `placeholder` |
162
+
163
+ ## Overlay
164
+
165
+ Floating UI elements that appear above the main content. **All require `<UApp>` wrapper.**
166
+
167
+ | Component | Key props |
168
+ |---|---|
169
+ | `UModal` | `v-model:open`, `title`, `description`, `fullscreen`, `scrollable` |
170
+ | `USlideover` | `v-model:open`, `title`, `side` (left/right/top/bottom) |
171
+ | `UDrawer` | `v-model:open`, `title`, `handle` |
172
+ | `UPopover` | `arrow`, `content: { side, align }`, `openDelay`, `closeDelay` |
173
+ | `UTooltip` | `text`, `content: { side }`, `delayDuration` |
174
+ | `UDropdownMenu` | `items` (flat `T[]` or grouped `T[][]` with separators, supports nested `children`) |
175
+ | `UContextMenu` | `items` (flat `T[]` or grouped `T[][]`) — right-click menu |
176
+ | `UToast` | Used via `useToast()` composable |
177
+
178
+ ### Modal
179
+
180
+ ```vue
181
+ <UModal v-model:open="isOpen" title="Edit" description="Edit your profile">
182
+ <template #body>Content</template>
183
+ <template #footer>
184
+ <UButton variant="ghost" @click="isOpen = false">Cancel</UButton>
185
+ <UButton @click="save">Save</UButton>
186
+ </template>
187
+ </UModal>
188
+ ```
189
+
190
+ Slots: `#content`, `#header`, `#body`, `#footer`
191
+
192
+ ### Slideover
193
+
194
+ ```vue
195
+ <USlideover v-model:open="isOpen" title="Settings" side="right">
196
+ <template #body>Content</template>
197
+ </USlideover>
198
+ ```
199
+
200
+ ### Drawer
201
+
202
+ ```vue
203
+ <UDrawer v-model:open="isOpen" title="Options" handle>
204
+ <template #body>Content</template>
205
+ </UDrawer>
206
+ ```
207
+
208
+ ### DropdownMenu
209
+
210
+ Items accept a flat array or a nested array (each sub-array is rendered as a group separated by dividers):
211
+
212
+ ```vue
213
+ <!-- Flat array -->
214
+ <UDropdownMenu :items="[
215
+ { label: 'Edit', icon: 'i-lucide-pencil', onSelect: () => edit() },
216
+ { type: 'separator' },
217
+ { label: 'Delete', icon: 'i-lucide-trash', color: 'error' }
218
+ ]">
219
+ <UButton icon="i-lucide-ellipsis-vertical" variant="ghost" />
220
+ </UDropdownMenu>
221
+
222
+ <!-- Nested array (groups with automatic separators) -->
223
+ <UDropdownMenu :items="[
224
+ [{ label: 'Edit', icon: 'i-lucide-pencil' }, { label: 'Duplicate', icon: 'i-lucide-copy' }],
225
+ [{ label: 'Delete', icon: 'i-lucide-trash', color: 'error' }]
226
+ ]">
227
+ <UButton icon="i-lucide-ellipsis-vertical" variant="ghost" />
228
+ </UDropdownMenu>
229
+ ```
230
+
231
+ ### Toast
232
+
233
+ ```ts
234
+ const toast = useToast()
235
+
236
+ toast.add({
237
+ title: 'Success',
238
+ description: 'Changes saved',
239
+ color: 'success',
240
+ icon: 'i-lucide-check-circle',
241
+ duration: 5000,
242
+ actions: [{ label: 'Undo', onClick: () => undo() }]
243
+ })
244
+ ```
245
+
246
+ ### Programmatic overlays
247
+
248
+ ```ts
249
+ const overlay = useOverlay()
250
+
251
+ // create() returns a reusable instance
252
+ const confirmDialog = overlay.create(ConfirmDialog)
253
+
254
+ // open() returns an object with .result (a Promise)
255
+ const { result } = confirmDialog.open({
256
+ title: 'Delete?',
257
+ message: 'This cannot be undone.'
258
+ })
259
+
260
+ if (await result) {
261
+ // User confirmed
262
+ }
263
+
264
+ // Inside the overlay component, emit close with a value:
265
+ // emit('close', true) or emit('close', false)
266
+ ```
267
+
268
+ ### CommandPalette
269
+
270
+ ```vue
271
+ <script setup>
272
+ const groups = [{
273
+ id: 'actions',
274
+ label: 'Actions',
275
+ items: [
276
+ { label: 'New file', icon: 'i-lucide-file-plus', onSelect: () => {} },
277
+ { label: 'Settings', to: '/settings' }
278
+ ]
279
+ }]
280
+
281
+ defineShortcuts({ meta_k: () => { isOpen.value = true } })
282
+ </script>
283
+
284
+ <UCommandPalette v-model:open="isOpen" :groups="groups" placeholder="Search..." />
285
+ ```
286
+
287
+ ## Page
288
+
289
+ Pre-built sections for marketing and content pages.
290
+
291
+ | Component | Purpose |
292
+ |---|---|
293
+ | `UPage` | Multi-column grid (`#left`, `#default`, `#right`) |
294
+ | `UPageAside` | Sticky sidebar wrapper (visible from `lg`) |
295
+ | `UPageHero` | Hero section with title, description, links, media |
296
+ | `UPageSection` | Content section with headline, features grid |
297
+ | `UPageCTA` | Call to action block |
298
+ | `UPageHeader` | Page title and description |
299
+ | `UPageBody` | Main content area with prose styling |
300
+ | `UPageFeature` | Individual feature item |
301
+ | `UPageGrid` | Grid layout for cards |
302
+ | `UPageColumns` | Multi-column layout |
303
+ | `UPageCard` | Content card for grids |
304
+ | `UPageLogos` | Logo wall |
305
+ | `UPageAnchors` | Anchor links (simpler TOC) |
306
+ | `UPageLinks` | Related resource links |
307
+ | `UPageList` | List items |
308
+ | `UBlogPosts` | Responsive grid of blog posts (`orientation`) |
309
+ | `UBlogPost` | Individual blog post card |
310
+ | `UChangelogVersions` | Changelog version list |
311
+ | `UChangelogVersion` | Individual changelog entry |
312
+ | `UPricingPlans` | Pricing plan cards |
313
+ | `UPricingTable` | Feature comparison table |
314
+
315
+ ## Dashboard
316
+
317
+ Specialized components for admin interfaces with resizable panels and sidebars.
318
+
319
+ | Component | Purpose |
320
+ |---|---|
321
+ | `UDashboardGroup` | Root wrapper — manages sidebar state |
322
+ | `UDashboardSidebar` | Resizable/collapsible sidebar (`#header`, `#default`, `#footer`) |
323
+ | `UDashboardPanel` | Content panel (`#header`, `#body`, `#footer`) |
324
+ | `UDashboardNavbar` | Panel navbar (`#left`, `#default`, `#right`) |
325
+ | `UDashboardToolbar` | Toolbar for filters/actions |
326
+ | `UDashboardSearch` | Command palette for dashboards |
327
+ | `UDashboardSearchButton` | Search trigger button |
328
+ | `UDashboardSidebarToggle` | Mobile sidebar toggle |
329
+ | `UDashboardSidebarCollapse` | Desktop collapse button |
330
+ | `UDashboardResizeHandle` | Custom resize handle |
331
+
332
+ ## Chat
333
+
334
+ Components for conversational AI interfaces, powered by [Vercel AI SDK](https://ai-sdk.dev/).
335
+
336
+ | Component | Purpose |
337
+ |---|---|
338
+ | `UChatMessages` | Scrollable message list with auto-scroll |
339
+ | `UChatMessage` | Individual message display |
340
+ | `UChatPrompt` | Enhanced textarea for prompts |
341
+ | `UChatPromptSubmit` | Submit button with status handling |
342
+ | `UChatPalette` | Chat layout for overlays |
343
+
344
+ ## Editor
345
+
346
+ Rich text editor powered by [TipTap](https://tiptap.dev/).
347
+
348
+ | Component | Purpose |
349
+ |---|---|
350
+ | `UEditor` | Editor (`v-model`, `content-type`: json/html/markdown) |
351
+ | `UEditorToolbar` | Toolbar (`layout`: fixed/bubble/floating) |
352
+ | `UEditorDragHandle` | Block drag-and-drop |
353
+ | `UEditorSuggestionMenu` | Slash command menu |
354
+ | `UEditorMentionMenu` | @ mention menu |
355
+ | `UEditorEmojiMenu` | Emoji picker |
356
+
357
+ ## Content
358
+
359
+ Components integrating with `@nuxt/content`.
360
+
361
+ | Component | Purpose |
362
+ |---|---|
363
+ | `UContentNavigation` | Sidebar navigation tree |
364
+ | `UContentToc` | Table of contents |
365
+ | `UContentSurround` | Prev/next links |
366
+ | `UContentSearch` | Search command palette |
367
+ | `UContentSearchButton` | Search trigger button |
368
+
369
+ ## Color Mode
370
+
371
+ | Component | Purpose |
372
+ |---|---|
373
+ | `UColorModeButton` | Toggle light/dark button |
374
+ | `UColorModeSwitch` | Toggle light/dark switch |
375
+ | `UColorModeSelect` | Dropdown selector |
376
+ | `UColorModeAvatar` | Avatar with different src per mode |
377
+ | `UColorModeImage` | Image with different src per mode |
@@ -0,0 +1,127 @@
1
+ # Composables
2
+
3
+ ## useToast
4
+
5
+ Show notifications. Requires `<UApp>` wrapper.
6
+
7
+ ```ts
8
+ const toast = useToast()
9
+
10
+ toast.add({
11
+ title: 'Success',
12
+ description: 'Item saved',
13
+ color: 'success', // primary, success, error, warning, info
14
+ icon: 'i-lucide-check-circle',
15
+ duration: 5000, // 0 = never dismiss
16
+ actions: [{ label: 'Undo', onClick: () => {} }]
17
+ })
18
+
19
+ toast.remove('toast-id')
20
+ toast.clear()
21
+ ```
22
+
23
+ ## useOverlay
24
+
25
+ Programmatically create modals, slideovers, drawers.
26
+
27
+ ```ts
28
+ const overlay = useOverlay()
29
+
30
+ // create() returns a reusable instance with open(), close(), patch()
31
+ const modal = overlay.create(MyComponent)
32
+
33
+ // open() accepts props and returns an object with .result (a Promise)
34
+ const { result } = modal.open({ title: 'Confirm' })
35
+
36
+ if (await result) {
37
+ // User confirmed
38
+ }
39
+
40
+ // Inside the overlay component, emit close with a value:
41
+ // emit('close', true) or emit('close', false)
42
+
43
+ // You can also close from outside:
44
+ modal.close(false)
45
+ ```
46
+
47
+ ## defineShortcuts
48
+
49
+ Define keyboard shortcuts.
50
+
51
+ ```ts
52
+ defineShortcuts({
53
+ meta_k: () => openSearch(), // Cmd+K (Mac) / Ctrl+K (Win)
54
+ meta_shift_p: () => openPalette(), // Cmd+Shift+P
55
+ escape: () => close(),
56
+ ctrl_s: () => save(),
57
+
58
+ // With condition
59
+ meta_enter: {
60
+ handler: () => submit(),
61
+ whenever: [isFormValid]
62
+ }
63
+ })
64
+ ```
65
+
66
+ | Key | Meaning |
67
+ |---|---|
68
+ | `meta` | Cmd (Mac) / Ctrl (Windows) |
69
+ | `ctrl` | Ctrl key |
70
+ | `alt` | Alt / Option key |
71
+ | `shift` | Shift key |
72
+ | `_` | Key separator |
73
+
74
+ ## defineLocale / extendLocale
75
+
76
+ i18n locale definition.
77
+
78
+ ```ts
79
+ import { fr } from '@nuxt/ui/locale'
80
+
81
+ // Use a built-in locale (50+ available)
82
+ // <UApp :locale="fr">
83
+
84
+ // Define custom locale
85
+ const locale = defineLocale({
86
+ name: 'Español',
87
+ code: 'es',
88
+ dir: 'ltr',
89
+ messages: {
90
+ select: { placeholder: 'Seleccionar...' }
91
+ }
92
+ })
93
+
94
+ // Extend existing locale
95
+ import { en } from '@nuxt/ui/locale'
96
+
97
+ const customEn = extendLocale(en, {
98
+ messages: { commandPalette: { placeholder: 'Search a component...' } }
99
+ })
100
+ ```
101
+
102
+ ```vue
103
+ <UApp :locale="fr"><NuxtPage /></UApp>
104
+ ```
105
+
106
+ ## extractShortcuts
107
+
108
+ Extract shortcut keys from a list of items (e.g., dropdown menu items) into a shortcuts map for `defineShortcuts`.
109
+
110
+ ```ts
111
+ const items = [
112
+ { label: 'New file', kbds: ['meta', 'n'], onSelect: () => newFile() },
113
+ { label: 'Save', kbds: ['meta', 's'], onSelect: () => save() }
114
+ ]
115
+
116
+ defineShortcuts(extractShortcuts(items))
117
+ ```
118
+
119
+ ## Quick reference
120
+
121
+ | Composable | Purpose |
122
+ |---|---|
123
+ | `useToast` | Show notifications |
124
+ | `useOverlay` | Programmatic modals/slideovers |
125
+ | `defineShortcuts` | Keyboard shortcuts |
126
+ | `defineLocale` / `extendLocale` | i18n locale |
127
+ | `extractShortcuts` | Parse shortcut definitions |