skillfullstack 0.0.0-stage → 1.0.1

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 (775) hide show
  1. package/.skillsRegistry/catalog.json +231 -0
  2. package/AGENTS.md +89 -0
  3. package/README.md +210 -2
  4. package/bin/index.js +508 -0
  5. package/package.json +57 -4
  6. package/skills/backend/apiEngineering/SKILL.md +102 -0
  7. package/skills/backend/apiEngineering/evals/evalApiEngineering.py +81 -0
  8. package/skills/backend/apiEngineering/evals/fixtures/invalid/sampleInvalidOpenApi.json +40 -0
  9. package/skills/backend/apiEngineering/evals/fixtures/valid/sampleValidOpenApi.json +47 -0
  10. package/skills/backend/apiEngineering/policies/compatibility.md +42 -0
  11. package/skills/backend/apiEngineering/policies/mandatory.md +48 -0
  12. package/skills/backend/apiEngineering/policies/performance.md +39 -0
  13. package/skills/backend/apiEngineering/policies/security.md +36 -0
  14. package/skills/backend/apiEngineering/references/apiObservability.md +39 -0
  15. package/skills/backend/apiEngineering/references/apiReference.md +3 -0
  16. package/skills/backend/apiEngineering/references/apiSecurityOwasp.md +47 -0
  17. package/skills/backend/apiEngineering/references/contractCompatibility.md +26 -0
  18. package/skills/backend/apiEngineering/references/databaseTransactions.md +40 -0
  19. package/skills/backend/apiEngineering/references/distributedReliability.md +26 -0
  20. package/skills/backend/apiEngineering/references/multiTenancy.md +27 -0
  21. package/skills/backend/apiEngineering/references/openApi32Standards.md +58 -0
  22. package/skills/backend/apiEngineering/references/paginationVersioning.md +57 -0
  23. package/skills/backend/apiEngineering/references/responseStandards.md +94 -0
  24. package/skills/backend/apiEngineering/scripts/auditApiContract.py +123 -0
  25. package/skills/backend/apiEngineering/scripts/checkBreakingChanges.py +77 -0
  26. package/skills/backend/apiEngineering/scripts/generateResponseEnvelope.py +88 -0
  27. package/skills/backend/apiEngineering/templates/apiChecklist.md +27 -0
  28. package/skills/backend/apiEngineering/templates/openapi.yaml +125 -0
  29. package/skills/backend/apiEngineering/templates/problemDetails.json +44 -0
  30. package/skills/backend/databaseArchitecture/SKILL.md +118 -0
  31. package/skills/backend/databaseArchitecture/evals/evalDatabaseArchitecture.py +85 -0
  32. package/skills/backend/databaseArchitecture/evals/fixtures/dangerousMigration.sql +4 -0
  33. package/skills/backend/databaseArchitecture/evals/fixtures/invalidSchema.sql +23 -0
  34. package/skills/backend/databaseArchitecture/evals/fixtures/safeMigration.sql +3 -0
  35. package/skills/backend/databaseArchitecture/evals/fixtures/validSchema.sql +37 -0
  36. package/skills/backend/databaseArchitecture/policies/integrity.md +25 -0
  37. package/skills/backend/databaseArchitecture/policies/mandatory.md +32 -0
  38. package/skills/backend/databaseArchitecture/policies/migration.md +22 -0
  39. package/skills/backend/databaseArchitecture/policies/normalization.md +25 -0
  40. package/skills/backend/databaseArchitecture/policies/performance.md +26 -0
  41. package/skills/backend/databaseArchitecture/policies/recovery.md +23 -0
  42. package/skills/backend/databaseArchitecture/policies/security.md +26 -0
  43. package/skills/backend/databaseArchitecture/policies/tableCreationChecklist.md +70 -0
  44. package/skills/backend/databaseArchitecture/references/analyticsWarehousing.md +32 -0
  45. package/skills/backend/databaseArchitecture/references/apiReference.md +3 -0
  46. package/skills/backend/databaseArchitecture/references/backupDisasterRecovery.md +27 -0
  47. package/skills/backend/databaseArchitecture/references/dataModelingLifecycle.md +30 -0
  48. package/skills/backend/databaseArchitecture/references/databaseTaxonomy.md +32 -0
  49. package/skills/backend/databaseArchitecture/references/indexingOptimization.md +32 -0
  50. package/skills/backend/databaseArchitecture/references/normalizationTheory.md +61 -0
  51. package/skills/backend/databaseArchitecture/references/scalabilitySharding.md +37 -0
  52. package/skills/backend/databaseArchitecture/references/transactionConcurrency.md +39 -0
  53. package/skills/backend/databaseArchitecture/scripts/analyzeMigration.py +99 -0
  54. package/skills/backend/databaseArchitecture/scripts/auditDatabaseSchema.py +177 -0
  55. package/skills/backend/databaseArchitecture/scripts/inspectDatabaseIndexes.py +149 -0
  56. package/skills/backend/databaseArchitecture/templates/adrTemplate.md +32 -0
  57. package/skills/backend/databaseArchitecture/templates/databaseChecklist.md +29 -0
  58. package/skills/backend/databaseArchitecture/templates/migrationPlan.md +40 -0
  59. package/skills/backend/durableBackgroundJobs/SKILL.md +112 -0
  60. package/skills/backend/durableBackgroundJobs/evals/durableJobVerification.json +14 -0
  61. package/skills/backend/durableBackgroundJobs/references/apiReference.md +3 -0
  62. package/skills/backend/durableBackgroundJobs/references/durableStepPatterns.md +6 -0
  63. package/skills/backend/durableBackgroundJobs/references/idempotencyKeys.md +5 -0
  64. package/skills/backend/durableBackgroundJobs/scripts/testWorkflowDispatch.py +24 -0
  65. package/skills/backend/golangStandard/SKILL.md +155 -0
  66. package/skills/backend/golangStandard/evals/goVerification.json +14 -0
  67. package/skills/backend/golangStandard/references/apiReference.md +3 -0
  68. package/skills/backend/golangStandard/references/layoutGuide.md +26 -0
  69. package/skills/backend/golangStandard/references/slogPatterns.md +26 -0
  70. package/skills/backend/golangStandard/scripts/scaffoldGoModule.py +105 -0
  71. package/skills/backend/pythonStandard/SKILL.md +138 -0
  72. package/skills/backend/pythonStandard/evals/pythonVerification.json +14 -0
  73. package/skills/backend/pythonStandard/references/apiReference.md +3 -0
  74. package/skills/backend/pythonStandard/references/pydanticPatterns.md +16 -0
  75. package/skills/backend/pythonStandard/references/pyprojectSpecs.md +37 -0
  76. package/skills/backend/pythonStandard/scripts/scaffoldUvProject.py +79 -0
  77. package/skills/backend/upstash/SKILL.md +98 -0
  78. package/skills/backend/upstash/evals/upstashVerification.json +14 -0
  79. package/skills/backend/upstash/references/apiReference.md +3 -0
  80. package/skills/backend/upstash/references/qstashFlowControl.md +34 -0
  81. package/skills/backend/upstash/references/ratelimitPatterns.md +53 -0
  82. package/skills/backend/upstash/references/workflowPatterns.md +35 -0
  83. package/skills/backend/upstash/scripts/testRedisConnection.py +36 -0
  84. package/skills/cicdDevops/cicdPipeline/SKILL.md +148 -0
  85. package/skills/cicdDevops/cicdPipeline/evals/evalCicd.py +37 -0
  86. package/skills/cicdDevops/cicdPipeline/references/apiReference.md +3 -0
  87. package/skills/cicdDevops/cicdPipeline/references/cicdDeploymentPatterns.md +27 -0
  88. package/skills/cicdDevops/cicdPipeline/scripts/auditDockerfileSecurity.py +56 -0
  89. package/skills/dataAi/mcpServerDevelopment/SKILL.md +123 -0
  90. package/skills/dataAi/mcpServerDevelopment/evals/mcpVerification.json +14 -0
  91. package/skills/dataAi/mcpServerDevelopment/references/apiReference.md +3 -0
  92. package/skills/dataAi/mcpServerDevelopment/references/mcpClientConfigs.md +38 -0
  93. package/skills/dataAi/mcpServerDevelopment/references/toolSchemaDesign.md +6 -0
  94. package/skills/dataAi/mcpServerDevelopment/scripts/runFastMcpBoilerplate.py +36 -0
  95. package/skills/dataAi/ragPipelineProduction/SKILL.md +113 -0
  96. package/skills/dataAi/ragPipelineProduction/evals/ragVerification.json +14 -0
  97. package/skills/dataAi/ragPipelineProduction/references/apiReference.md +3 -0
  98. package/skills/dataAi/ragPipelineProduction/references/chunkingStrategies.md +10 -0
  99. package/skills/dataAi/ragPipelineProduction/references/rrfAlgorithm.md +13 -0
  100. package/skills/dataAi/ragPipelineProduction/scripts/runHybridRrfSearch.py +33 -0
  101. package/skills/devopsCloud/cloudflare/SKILL.md +282 -0
  102. package/skills/devopsCloud/cloudflare/assets/README.md +48 -0
  103. package/skills/devopsCloud/cloudflare/assets/ai/agents-sdk.md +118 -0
  104. package/skills/devopsCloud/cloudflare/assets/ai/ai-gateway.md +105 -0
  105. package/skills/devopsCloud/cloudflare/assets/ai/ai-search.md +129 -0
  106. package/skills/devopsCloud/cloudflare/assets/ai/workers-ai.md +127 -0
  107. package/skills/devopsCloud/cloudflare/assets/cli/c3.md +292 -0
  108. package/skills/devopsCloud/cloudflare/assets/cli/cf-cli.md +90 -0
  109. package/skills/devopsCloud/cloudflare/assets/cli/wrangler.md +43 -0
  110. package/skills/devopsCloud/cloudflare/assets/compute/cron-triggers.md +486 -0
  111. package/skills/devopsCloud/cloudflare/assets/compute/service-bindings.md +251 -0
  112. package/skills/devopsCloud/cloudflare/assets/compute/smart-placement.md +435 -0
  113. package/skills/devopsCloud/cloudflare/assets/compute/static-assets.md +220 -0
  114. package/skills/devopsCloud/cloudflare/assets/compute/workers.md +129 -0
  115. package/skills/devopsCloud/cloudflare/assets/database-storage/d1.md +105 -0
  116. package/skills/devopsCloud/cloudflare/assets/database-storage/durable-objects.md +122 -0
  117. package/skills/devopsCloud/cloudflare/assets/database-storage/hyperdrive.md +210 -0
  118. package/skills/devopsCloud/cloudflare/assets/database-storage/kv.md +198 -0
  119. package/skills/devopsCloud/cloudflare/assets/database-storage/queues.md +105 -0
  120. package/skills/devopsCloud/cloudflare/assets/database-storage/r2.md +105 -0
  121. package/skills/devopsCloud/cloudflare/assets/database-storage/vectorize.md +97 -0
  122. package/skills/devopsCloud/cloudflare/assets/database-storage/workflows.md +141 -0
  123. package/skills/devopsCloud/cloudflare/assets/llms.txt +143 -0
  124. package/skills/devopsCloud/cloudflare/assets/networking-security/cache-cdn.md +109 -0
  125. package/skills/devopsCloud/cloudflare/assets/networking-security/dns.md +71 -0
  126. package/skills/devopsCloud/cloudflare/assets/networking-security/rate-limiting.md +130 -0
  127. package/skills/devopsCloud/cloudflare/assets/networking-security/tunnels.md +57 -0
  128. package/skills/devopsCloud/cloudflare/assets/networking-security/waf.md +143 -0
  129. package/skills/devopsCloud/cloudflare/assets/troubleshooting/1xxx-errors.md +209 -0
  130. package/skills/devopsCloud/cloudflare/assets/troubleshooting/5xx-errors.md +111 -0
  131. package/skills/devopsCloud/cloudflare/assets/troubleshooting/http-status-codes.md +38 -0
  132. package/skills/devopsCloud/cloudflare/evals/evals.json +75 -0
  133. package/skills/devopsCloud/cloudflare/references/ai-gateway/README.md +27 -0
  134. package/skills/devopsCloud/cloudflare/references/ai-gateway/configuration.md +18 -0
  135. package/skills/devopsCloud/cloudflare/references/ai-gateway/dynamic-routing.md +15 -0
  136. package/skills/devopsCloud/cloudflare/references/ai-gateway/features.md +22 -0
  137. package/skills/devopsCloud/cloudflare/references/ai-gateway/sdk-integration.md +19 -0
  138. package/skills/devopsCloud/cloudflare/references/ai-gateway/troubleshooting.md +16 -0
  139. package/skills/devopsCloud/cloudflare/references/ai-search/README.md +25 -0
  140. package/skills/devopsCloud/cloudflare/references/ai-search/api.md +13 -0
  141. package/skills/devopsCloud/cloudflare/references/ai-search/configuration.md +16 -0
  142. package/skills/devopsCloud/cloudflare/references/ai-search/gotchas.md +13 -0
  143. package/skills/devopsCloud/cloudflare/references/ai-search/patterns.md +15 -0
  144. package/skills/devopsCloud/cloudflare/references/bindings/README.md +16 -0
  145. package/skills/devopsCloud/cloudflare/references/bindings/api.md +19 -0
  146. package/skills/devopsCloud/cloudflare/references/bindings/configuration.md +20 -0
  147. package/skills/devopsCloud/cloudflare/references/bindings/gotchas.md +18 -0
  148. package/skills/devopsCloud/cloudflare/references/bindings/patterns.md +20 -0
  149. package/skills/devopsCloud/cloudflare/references/browser-rendering/README.md +18 -0
  150. package/skills/devopsCloud/cloudflare/references/browser-rendering/api.md +12 -0
  151. package/skills/devopsCloud/cloudflare/references/browser-rendering/configuration.md +12 -0
  152. package/skills/devopsCloud/cloudflare/references/browser-rendering/gotchas.md +15 -0
  153. package/skills/devopsCloud/cloudflare/references/browser-rendering/patterns.md +12 -0
  154. package/skills/devopsCloud/cloudflare/references/cliComparison.md +93 -0
  155. package/skills/devopsCloud/cloudflare/references/containers/README.md +23 -0
  156. package/skills/devopsCloud/cloudflare/references/containers/api.md +13 -0
  157. package/skills/devopsCloud/cloudflare/references/containers/configuration.md +15 -0
  158. package/skills/devopsCloud/cloudflare/references/containers/gotchas.md +16 -0
  159. package/skills/devopsCloud/cloudflare/references/containers/patterns.md +18 -0
  160. package/skills/devopsCloud/cloudflare/references/cron-triggers/README.md +20 -0
  161. package/skills/devopsCloud/cloudflare/references/cron-triggers/api.md +16 -0
  162. package/skills/devopsCloud/cloudflare/references/cron-triggers/configuration.md +16 -0
  163. package/skills/devopsCloud/cloudflare/references/cron-triggers/gotchas.md +17 -0
  164. package/skills/devopsCloud/cloudflare/references/cron-triggers/patterns.md +18 -0
  165. package/skills/devopsCloud/cloudflare/references/d1/README.md +15 -0
  166. package/skills/devopsCloud/cloudflare/references/d1/api.md +18 -0
  167. package/skills/devopsCloud/cloudflare/references/d1/configuration.md +18 -0
  168. package/skills/devopsCloud/cloudflare/references/d1/gotchas.md +18 -0
  169. package/skills/devopsCloud/cloudflare/references/d1/patterns.md +21 -0
  170. package/skills/devopsCloud/cloudflare/references/frameworkCompatibility.md +110 -0
  171. package/skills/devopsCloud/cloudflare/references/hyperdrive/README.md +28 -0
  172. package/skills/devopsCloud/cloudflare/references/hyperdrive/api.md +26 -0
  173. package/skills/devopsCloud/cloudflare/references/hyperdrive/configuration.md +34 -0
  174. package/skills/devopsCloud/cloudflare/references/hyperdrive/gotchas.md +20 -0
  175. package/skills/devopsCloud/cloudflare/references/hyperdrive/patterns.md +15 -0
  176. package/skills/devopsCloud/cloudflare/references/images/README.md +12 -0
  177. package/skills/devopsCloud/cloudflare/references/images/api.md +13 -0
  178. package/skills/devopsCloud/cloudflare/references/images/configuration.md +17 -0
  179. package/skills/devopsCloud/cloudflare/references/images/gotchas.md +16 -0
  180. package/skills/devopsCloud/cloudflare/references/images/patterns.md +16 -0
  181. package/skills/devopsCloud/cloudflare/references/kv/README.md +15 -0
  182. package/skills/devopsCloud/cloudflare/references/kv/api.md +18 -0
  183. package/skills/devopsCloud/cloudflare/references/kv/configuration.md +16 -0
  184. package/skills/devopsCloud/cloudflare/references/kv/gotchas.md +17 -0
  185. package/skills/devopsCloud/cloudflare/references/kv/patterns.md +21 -0
  186. package/skills/devopsCloud/cloudflare/references/miniflare/README.md +22 -0
  187. package/skills/devopsCloud/cloudflare/references/miniflare/api.md +16 -0
  188. package/skills/devopsCloud/cloudflare/references/miniflare/configuration.md +16 -0
  189. package/skills/devopsCloud/cloudflare/references/miniflare/gotchas.md +15 -0
  190. package/skills/devopsCloud/cloudflare/references/miniflare/patterns.md +19 -0
  191. package/skills/devopsCloud/cloudflare/references/observability/README.md +27 -0
  192. package/skills/devopsCloud/cloudflare/references/observability/api.md +20 -0
  193. package/skills/devopsCloud/cloudflare/references/observability/configuration.md +23 -0
  194. package/skills/devopsCloud/cloudflare/references/observability/gotchas.md +25 -0
  195. package/skills/devopsCloud/cloudflare/references/observability/patterns.md +14 -0
  196. package/skills/devopsCloud/cloudflare/references/pages/README.md +20 -0
  197. package/skills/devopsCloud/cloudflare/references/pages/api.md +13 -0
  198. package/skills/devopsCloud/cloudflare/references/pages/configuration.md +16 -0
  199. package/skills/devopsCloud/cloudflare/references/pages/gotchas.md +19 -0
  200. package/skills/devopsCloud/cloudflare/references/pages/patterns.md +15 -0
  201. package/skills/devopsCloud/cloudflare/references/pages-functions/README.md +20 -0
  202. package/skills/devopsCloud/cloudflare/references/pages-functions/api.md +13 -0
  203. package/skills/devopsCloud/cloudflare/references/pages-functions/configuration.md +14 -0
  204. package/skills/devopsCloud/cloudflare/references/pages-functions/gotchas.md +17 -0
  205. package/skills/devopsCloud/cloudflare/references/pages-functions/patterns.md +16 -0
  206. package/skills/devopsCloud/cloudflare/references/productSelectionMatrix.md +54 -0
  207. package/skills/devopsCloud/cloudflare/references/queues/README.md +24 -0
  208. package/skills/devopsCloud/cloudflare/references/queues/api.md +16 -0
  209. package/skills/devopsCloud/cloudflare/references/queues/configuration.md +20 -0
  210. package/skills/devopsCloud/cloudflare/references/queues/gotchas.md +18 -0
  211. package/skills/devopsCloud/cloudflare/references/queues/patterns.md +21 -0
  212. package/skills/devopsCloud/cloudflare/references/r2/README.md +26 -0
  213. package/skills/devopsCloud/cloudflare/references/r2/api.md +16 -0
  214. package/skills/devopsCloud/cloudflare/references/r2/configuration.md +19 -0
  215. package/skills/devopsCloud/cloudflare/references/r2/gotchas.md +17 -0
  216. package/skills/devopsCloud/cloudflare/references/r2/patterns.md +18 -0
  217. package/skills/devopsCloud/cloudflare/references/secrets-store/README.md +22 -0
  218. package/skills/devopsCloud/cloudflare/references/secrets-store/api.md +21 -0
  219. package/skills/devopsCloud/cloudflare/references/secrets-store/configuration.md +25 -0
  220. package/skills/devopsCloud/cloudflare/references/secrets-store/gotchas.md +19 -0
  221. package/skills/devopsCloud/cloudflare/references/secrets-store/patterns.md +27 -0
  222. package/skills/devopsCloud/cloudflare/references/skill-feedback.md +41 -0
  223. package/skills/devopsCloud/cloudflare/references/static-assets/README.md +21 -0
  224. package/skills/devopsCloud/cloudflare/references/static-assets/api.md +16 -0
  225. package/skills/devopsCloud/cloudflare/references/static-assets/configuration.md +16 -0
  226. package/skills/devopsCloud/cloudflare/references/static-assets/gotchas.md +18 -0
  227. package/skills/devopsCloud/cloudflare/references/static-assets/patterns.md +17 -0
  228. package/skills/devopsCloud/cloudflare/references/stream/README.md +22 -0
  229. package/skills/devopsCloud/cloudflare/references/stream/api-live.md +18 -0
  230. package/skills/devopsCloud/cloudflare/references/stream/api.md +21 -0
  231. package/skills/devopsCloud/cloudflare/references/stream/configuration.md +18 -0
  232. package/skills/devopsCloud/cloudflare/references/stream/gotchas.md +18 -0
  233. package/skills/devopsCloud/cloudflare/references/stream/patterns.md +22 -0
  234. package/skills/devopsCloud/cloudflare/references/tail-workers/README.md +21 -0
  235. package/skills/devopsCloud/cloudflare/references/tail-workers/api.md +13 -0
  236. package/skills/devopsCloud/cloudflare/references/tail-workers/configuration.md +15 -0
  237. package/skills/devopsCloud/cloudflare/references/tail-workers/gotchas.md +16 -0
  238. package/skills/devopsCloud/cloudflare/references/tail-workers/patterns.md +15 -0
  239. package/skills/devopsCloud/cloudflare/references/tunnel/README.md +20 -0
  240. package/skills/devopsCloud/cloudflare/references/tunnel/api.md +14 -0
  241. package/skills/devopsCloud/cloudflare/references/tunnel/configuration.md +14 -0
  242. package/skills/devopsCloud/cloudflare/references/tunnel/gotchas.md +15 -0
  243. package/skills/devopsCloud/cloudflare/references/tunnel/networking.md +14 -0
  244. package/skills/devopsCloud/cloudflare/references/tunnel/patterns.md +15 -0
  245. package/skills/devopsCloud/cloudflare/references/vectorize/README.md +22 -0
  246. package/skills/devopsCloud/cloudflare/references/vectorize/api.md +18 -0
  247. package/skills/devopsCloud/cloudflare/references/vectorize/configuration.md +19 -0
  248. package/skills/devopsCloud/cloudflare/references/vectorize/gotchas.md +15 -0
  249. package/skills/devopsCloud/cloudflare/references/vectorize/patterns.md +24 -0
  250. package/skills/devopsCloud/cloudflare/references/waf/README.md +21 -0
  251. package/skills/devopsCloud/cloudflare/references/waf/api.md +17 -0
  252. package/skills/devopsCloud/cloudflare/references/waf/configuration.md +18 -0
  253. package/skills/devopsCloud/cloudflare/references/waf/gotchas.md +19 -0
  254. package/skills/devopsCloud/cloudflare/references/waf/patterns.md +17 -0
  255. package/skills/devopsCloud/cloudflare/references/workers-ai/README.md +24 -0
  256. package/skills/devopsCloud/cloudflare/references/workers-ai/api.md +13 -0
  257. package/skills/devopsCloud/cloudflare/references/workers-ai/configuration.md +16 -0
  258. package/skills/devopsCloud/cloudflare/references/workers-ai/gotchas.md +15 -0
  259. package/skills/devopsCloud/cloudflare/references/workers-ai/patterns.md +14 -0
  260. package/skills/devopsCloud/cloudflare/references/workflows/README.md +23 -0
  261. package/skills/devopsCloud/cloudflare/references/workflows/api.md +17 -0
  262. package/skills/devopsCloud/cloudflare/references/workflows/configuration.md +18 -0
  263. package/skills/devopsCloud/cloudflare/references/workflows/gotchas.md +19 -0
  264. package/skills/devopsCloud/cloudflare/references/workflows/patterns.md +30 -0
  265. package/skills/devopsCloud/cloudflare/scripts/auditCloudflareProduction.py +95 -0
  266. package/skills/foundation/promptEvalTesting/SKILL.md +114 -0
  267. package/skills/foundation/promptEvalTesting/evals/promptEvalVerification.json +14 -0
  268. package/skills/foundation/promptEvalTesting/references/apiReference.md +3 -0
  269. package/skills/foundation/promptEvalTesting/references/evalMetricsCatalog.md +7 -0
  270. package/skills/foundation/promptEvalTesting/references/promptfooConfigSpecs.md +16 -0
  271. package/skills/foundation/promptEvalTesting/scripts/runPromptEvalSuite.py +29 -0
  272. package/skills/frontend/astro/SKILL.md +327 -0
  273. package/skills/frontend/astro/assets/README.md +71 -0
  274. package/skills/frontend/astro/assets/add-content-to-your-site/content-collections.md +1061 -0
  275. package/skills/frontend/astro/assets/add-content-to-your-site/data-fetching.md +109 -0
  276. package/skills/frontend/astro/assets/add-content-to-your-site/images.md +719 -0
  277. package/skills/frontend/astro/assets/add-content-to-your-site/markdown.md +725 -0
  278. package/skills/frontend/astro/assets/build-your-ui/components.md +402 -0
  279. package/skills/frontend/astro/assets/build-your-ui/fonts.md +437 -0
  280. package/skills/frontend/astro/assets/build-your-ui/front-end-frameworks.md +245 -0
  281. package/skills/frontend/astro/assets/build-your-ui/layouts.md +267 -0
  282. package/skills/frontend/astro/assets/build-your-ui/scripts-and-event-handling.md +229 -0
  283. package/skills/frontend/astro/assets/build-your-ui/styles-and-css.md +782 -0
  284. package/skills/frontend/astro/assets/build-your-ui/syntax-highlighting.md +269 -0
  285. package/skills/frontend/astro/assets/configuration/build-with-ai.md +389 -0
  286. package/skills/frontend/astro/assets/configuration/configuration-overview.md +122 -0
  287. package/skills/frontend/astro/assets/configuration/dev-toolbar.md +86 -0
  288. package/skills/frontend/astro/assets/configuration/editor-setup.md +166 -0
  289. package/skills/frontend/astro/assets/configuration/environment-variables.md +352 -0
  290. package/skills/frontend/astro/assets/configuration/typescript.md +379 -0
  291. package/skills/frontend/astro/assets/configuration/working-with-integrations.md +606 -0
  292. package/skills/frontend/astro/assets/reference/adapter-reference.md +1242 -0
  293. package/skills/frontend/astro/assets/reference/cli-reference.md +575 -0
  294. package/skills/frontend/astro/assets/reference/configuration-reference.md +3144 -0
  295. package/skills/frontend/astro/assets/reference/content-loader-reference.md +1682 -0
  296. package/skills/frontend/astro/assets/reference/directives-reference.md +324 -0
  297. package/skills/frontend/astro/assets/reference/image-service-reference.md +346 -0
  298. package/skills/frontend/astro/assets/reference/integrations-reference.md +2813 -0
  299. package/skills/frontend/astro/assets/reference/modules/astro-actions.md +604 -0
  300. package/skills/frontend/astro/assets/reference/modules/astro-app.md +460 -0
  301. package/skills/frontend/astro/assets/reference/modules/astro-assets.md +1657 -0
  302. package/skills/frontend/astro/assets/reference/modules/astro-config.md +395 -0
  303. package/skills/frontend/astro/assets/reference/modules/astro-content.md +720 -0
  304. package/skills/frontend/astro/assets/reference/modules/astro-env.md +46 -0
  305. package/skills/frontend/astro/assets/reference/modules/astro-fetch.md +346 -0
  306. package/skills/frontend/astro/assets/reference/modules/astro-hono.md +37 -0
  307. package/skills/frontend/astro/assets/reference/modules/astro-i18n.md +462 -0
  308. package/skills/frontend/astro/assets/reference/modules/astro-middleware.md +292 -0
  309. package/skills/frontend/astro/assets/reference/modules/astro-static-paths.md +74 -0
  310. package/skills/frontend/astro/assets/reference/modules/astro-transitions.md +595 -0
  311. package/skills/frontend/astro/assets/reference/modules/astro-zod.md +120 -0
  312. package/skills/frontend/astro/assets/reference/session-driver-reference.md +205 -0
  313. package/skills/frontend/astro/assets/routing-and-navigation/endpoints.md +251 -0
  314. package/skills/frontend/astro/assets/routing-and-navigation/internationalization.md +374 -0
  315. package/skills/frontend/astro/assets/routing-and-navigation/middleware.md +288 -0
  316. package/skills/frontend/astro/assets/routing-and-navigation/pages.md +205 -0
  317. package/skills/frontend/astro/assets/routing-and-navigation/prefetch.md +273 -0
  318. package/skills/frontend/astro/assets/routing-and-navigation/routing.md +760 -0
  319. package/skills/frontend/astro/assets/routing-and-navigation/view-transitions.md +792 -0
  320. package/skills/frontend/astro/assets/server-rendering/actions.md +770 -0
  321. package/skills/frontend/astro/assets/server-rendering/caching.md +255 -0
  322. package/skills/frontend/astro/assets/server-rendering/on-demand-rendering.md +289 -0
  323. package/skills/frontend/astro/assets/server-rendering/server-islands.md +126 -0
  324. package/skills/frontend/astro/assets/server-rendering/sessions.md +270 -0
  325. package/skills/frontend/astro/assets/start-a-new-project/develop-and-build.md +147 -0
  326. package/skills/frontend/astro/assets/start-a-new-project/installation.md +342 -0
  327. package/skills/frontend/astro/assets/start-a-new-project/project-structure.md +137 -0
  328. package/skills/frontend/astro/assets/upgrade-and-troubleshooting/testing.md +412 -0
  329. package/skills/frontend/astro/assets/upgrade-and-troubleshooting/troubleshooting.md +229 -0
  330. package/skills/frontend/astro/assets/upgrade-and-troubleshooting/upgrade-astro.md +205 -0
  331. package/skills/frontend/astro/assets/welcome/courses.md +46 -0
  332. package/skills/frontend/astro/assets/welcome/islands-architecture.md +135 -0
  333. package/skills/frontend/astro/assets/welcome/why-astro.md +90 -0
  334. package/skills/frontend/astro/evals/evals.json +66 -0
  335. package/skills/frontend/astro/references/contentCollections.md +164 -0
  336. package/skills/frontend/astro/references/islandsArchitecture.md +128 -0
  337. package/skills/frontend/astro/references/serverIslandsAndActions.md +187 -0
  338. package/skills/frontend/astro/scripts/auditAstroProduction.py +78 -0
  339. package/skills/frontend/generativeUi/SKILL.md +128 -0
  340. package/skills/frontend/generativeUi/evals/generativeUiVerification.json +14 -0
  341. package/skills/frontend/generativeUi/references/apiReference.md +3 -0
  342. package/skills/frontend/generativeUi/references/clientToolComponentMapping.md +8 -0
  343. package/skills/frontend/generativeUi/references/dataStreamProtocol.md +10 -0
  344. package/skills/frontend/generativeUi/scripts/generateUiComponentStub.py +46 -0
  345. package/skills/frontend/nextjs/SKILL.md +138 -0
  346. package/skills/frontend/nextjs/assets/README.md +67 -0
  347. package/skills/frontend/nextjs/assets/api-reference/cli/create-next-app.md +210 -0
  348. package/skills/frontend/nextjs/assets/api-reference/cli/next.md +484 -0
  349. package/skills/frontend/nextjs/assets/api-reference/components/font.md +952 -0
  350. package/skills/frontend/nextjs/assets/api-reference/components/form.md +387 -0
  351. package/skills/frontend/nextjs/assets/api-reference/components/image.md +1372 -0
  352. package/skills/frontend/nextjs/assets/api-reference/components/link.md +954 -0
  353. package/skills/frontend/nextjs/assets/api-reference/components/script.md +421 -0
  354. package/skills/frontend/nextjs/assets/api-reference/directives/use-cache-private.md +211 -0
  355. package/skills/frontend/nextjs/assets/api-reference/directives/use-cache-remote.md +652 -0
  356. package/skills/frontend/nextjs/assets/api-reference/directives/use-cache.md +848 -0
  357. package/skills/frontend/nextjs/assets/api-reference/directives/use-client.md +149 -0
  358. package/skills/frontend/nextjs/assets/api-reference/directives/use-server.md +234 -0
  359. package/skills/frontend/nextjs/assets/api-reference/edge-runtime.md +188 -0
  360. package/skills/frontend/nextjs/assets/api-reference/file-conventions/default.md +80 -0
  361. package/skills/frontend/nextjs/assets/api-reference/file-conventions/dynamic-routes.md +417 -0
  362. package/skills/frontend/nextjs/assets/api-reference/file-conventions/error.md +361 -0
  363. package/skills/frontend/nextjs/assets/api-reference/file-conventions/forbidden.md +75 -0
  364. package/skills/frontend/nextjs/assets/api-reference/file-conventions/instrumentation-client.md +308 -0
  365. package/skills/frontend/nextjs/assets/api-reference/file-conventions/instrumentation.md +177 -0
  366. package/skills/frontend/nextjs/assets/api-reference/file-conventions/intercepting-routes.md +78 -0
  367. package/skills/frontend/nextjs/assets/api-reference/file-conventions/layout.md +803 -0
  368. package/skills/frontend/nextjs/assets/api-reference/file-conventions/loading.md +209 -0
  369. package/skills/frontend/nextjs/assets/api-reference/file-conventions/mdx-components.md +84 -0
  370. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/app-icons.md +302 -0
  371. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/manifest.md +90 -0
  372. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/opengraph-image.md +580 -0
  373. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/robots.md +234 -0
  374. package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/sitemap.md +459 -0
  375. package/skills/frontend/nextjs/assets/api-reference/file-conventions/not-found.md +278 -0
  376. package/skills/frontend/nextjs/assets/api-reference/file-conventions/page.md +283 -0
  377. package/skills/frontend/nextjs/assets/api-reference/file-conventions/parallel-routes.md +517 -0
  378. package/skills/frontend/nextjs/assets/api-reference/file-conventions/proxy.md +857 -0
  379. package/skills/frontend/nextjs/assets/api-reference/file-conventions/public-folder.md +47 -0
  380. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-groups.md +40 -0
  381. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/dynamicParams.md +40 -0
  382. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/ensureStatic.md +195 -0
  383. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/instant.md +204 -0
  384. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/maxDuration.md +42 -0
  385. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/preferredRegion.md +55 -0
  386. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/prefetch.md +113 -0
  387. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/runtime.md +43 -0
  388. package/skills/frontend/nextjs/assets/api-reference/file-conventions/route.md +772 -0
  389. package/skills/frontend/nextjs/assets/api-reference/file-conventions/src-folder.md +42 -0
  390. package/skills/frontend/nextjs/assets/api-reference/file-conventions/template.md +174 -0
  391. package/skills/frontend/nextjs/assets/api-reference/file-conventions/unauthorized.md +143 -0
  392. package/skills/frontend/nextjs/assets/api-reference/functions/after.md +332 -0
  393. package/skills/frontend/nextjs/assets/api-reference/functions/cacheLife.md +642 -0
  394. package/skills/frontend/nextjs/assets/api-reference/functions/cacheTag.md +272 -0
  395. package/skills/frontend/nextjs/assets/api-reference/functions/catchError.md +267 -0
  396. package/skills/frontend/nextjs/assets/api-reference/functions/connection.md +114 -0
  397. package/skills/frontend/nextjs/assets/api-reference/functions/cookies.md +349 -0
  398. package/skills/frontend/nextjs/assets/api-reference/functions/draft-mode.md +173 -0
  399. package/skills/frontend/nextjs/assets/api-reference/functions/fetch.md +141 -0
  400. package/skills/frontend/nextjs/assets/api-reference/functions/forbidden.md +327 -0
  401. package/skills/frontend/nextjs/assets/api-reference/functions/generate-image-metadata.md +311 -0
  402. package/skills/frontend/nextjs/assets/api-reference/functions/generate-metadata.md +1510 -0
  403. package/skills/frontend/nextjs/assets/api-reference/functions/generate-sitemaps.md +102 -0
  404. package/skills/frontend/nextjs/assets/api-reference/functions/generate-static-params.md +606 -0
  405. package/skills/frontend/nextjs/assets/api-reference/functions/generate-viewport.md +347 -0
  406. package/skills/frontend/nextjs/assets/api-reference/functions/headers.md +92 -0
  407. package/skills/frontend/nextjs/assets/api-reference/functions/image-response.md +225 -0
  408. package/skills/frontend/nextjs/assets/api-reference/functions/io.md +131 -0
  409. package/skills/frontend/nextjs/assets/api-reference/functions/navigation.md +220 -0
  410. package/skills/frontend/nextjs/assets/api-reference/functions/next-request.md +116 -0
  411. package/skills/frontend/nextjs/assets/api-reference/functions/next-response.md +219 -0
  412. package/skills/frontend/nextjs/assets/api-reference/functions/next-root-params.md +479 -0
  413. package/skills/frontend/nextjs/assets/api-reference/functions/not-found.md +269 -0
  414. package/skills/frontend/nextjs/assets/api-reference/functions/permanentRedirect.md +92 -0
  415. package/skills/frontend/nextjs/assets/api-reference/functions/prefetch.md +202 -0
  416. package/skills/frontend/nextjs/assets/api-reference/functions/redirect.md +255 -0
  417. package/skills/frontend/nextjs/assets/api-reference/functions/refresh.md +91 -0
  418. package/skills/frontend/nextjs/assets/api-reference/functions/revalidatePath.md +248 -0
  419. package/skills/frontend/nextjs/assets/api-reference/functions/revalidateTag.md +175 -0
  420. package/skills/frontend/nextjs/assets/api-reference/functions/unauthorized.md +389 -0
  421. package/skills/frontend/nextjs/assets/api-reference/functions/unstable_cache.md +131 -0
  422. package/skills/frontend/nextjs/assets/api-reference/functions/unstable_noStore.md +61 -0
  423. package/skills/frontend/nextjs/assets/api-reference/functions/unstable_rethrow.md +79 -0
  424. package/skills/frontend/nextjs/assets/api-reference/functions/updateTag.md +173 -0
  425. package/skills/frontend/nextjs/assets/api-reference/functions/use-link-status.md +268 -0
  426. package/skills/frontend/nextjs/assets/api-reference/functions/use-offline.md +222 -0
  427. package/skills/frontend/nextjs/assets/api-reference/functions/use-params.md +102 -0
  428. package/skills/frontend/nextjs/assets/api-reference/functions/use-pathname.md +189 -0
  429. package/skills/frontend/nextjs/assets/api-reference/functions/use-report-web-vitals.md +175 -0
  430. package/skills/frontend/nextjs/assets/api-reference/functions/use-router.md +214 -0
  431. package/skills/frontend/nextjs/assets/api-reference/functions/use-search-params.md +416 -0
  432. package/skills/frontend/nextjs/assets/api-reference/functions/use-selected-layout-segment.md +214 -0
  433. package/skills/frontend/nextjs/assets/api-reference/functions/use-selected-layout-segments.md +116 -0
  434. package/skills/frontend/nextjs/assets/api-reference/functions/use-server-inserted-html.md +145 -0
  435. package/skills/frontend/nextjs/assets/api-reference/functions/userAgent.md +95 -0
  436. package/skills/frontend/nextjs/assets/api-reference/turbopack.md +552 -0
  437. package/skills/frontend/nextjs/assets/architecture/accessibility.md +47 -0
  438. package/skills/frontend/nextjs/assets/architecture/fast-refresh.md +122 -0
  439. package/skills/frontend/nextjs/assets/architecture/nextjs-compiler.md +376 -0
  440. package/skills/frontend/nextjs/assets/architecture/supported-browsers.md +146 -0
  441. package/skills/frontend/nextjs/assets/community/contribution-guide.md +459 -0
  442. package/skills/frontend/nextjs/assets/community/rspack.md +25 -0
  443. package/skills/frontend/nextjs/assets/getting-started/caching.md +626 -0
  444. package/skills/frontend/nextjs/assets/getting-started/css.md +336 -0
  445. package/skills/frontend/nextjs/assets/getting-started/deploying.md +115 -0
  446. package/skills/frontend/nextjs/assets/getting-started/error-handling.md +485 -0
  447. package/skills/frontend/nextjs/assets/getting-started/fetching-data.md +743 -0
  448. package/skills/frontend/nextjs/assets/getting-started/fonts.md +232 -0
  449. package/skills/frontend/nextjs/assets/getting-started/images.md +272 -0
  450. package/skills/frontend/nextjs/assets/getting-started/installation.md +446 -0
  451. package/skills/frontend/nextjs/assets/getting-started/layouts-and-pages.md +386 -0
  452. package/skills/frontend/nextjs/assets/getting-started/linking-and-navigating.md +475 -0
  453. package/skills/frontend/nextjs/assets/getting-started/metadata-and-og-images.md +370 -0
  454. package/skills/frontend/nextjs/assets/getting-started/mutating-data.md +679 -0
  455. package/skills/frontend/nextjs/assets/getting-started/project-structure.md +290 -0
  456. package/skills/frontend/nextjs/assets/getting-started/proxy.md +107 -0
  457. package/skills/frontend/nextjs/assets/getting-started/revalidating.md +241 -0
  458. package/skills/frontend/nextjs/assets/getting-started/route-handlers.md +233 -0
  459. package/skills/frontend/nextjs/assets/getting-started/server-and-client-components.md +683 -0
  460. package/skills/frontend/nextjs/assets/getting-started/upgrading.md +137 -0
  461. package/skills/frontend/nextjs/assets/glossary.md +315 -0
  462. package/skills/frontend/nextjs/evals/nextjsVerification.json +14 -0
  463. package/skills/frontend/nextjs/references/apiReference.md +3 -0
  464. package/skills/frontend/nextjs/references/dataAccessLayer.md +39 -0
  465. package/skills/frontend/nextjs/references/nextjsFeatureMap.md +276 -0
  466. package/skills/frontend/nextjs/references/productionChecklist.md +49 -0
  467. package/skills/frontend/nextjs/references/securityHeadersCsp.md +44 -0
  468. package/skills/frontend/nextjs/scripts/auditProductionReadiness.py +85 -0
  469. package/skills/frontend/shadcn-ui/SKILL.md +102 -0
  470. package/skills/frontend/shadcn-ui/assets/README.md +82 -0
  471. package/skills/frontend/shadcn-ui/assets/advanced/javascript.md +44 -0
  472. package/skills/frontend/shadcn-ui/assets/advanced/monorepo.md +254 -0
  473. package/skills/frontend/shadcn-ui/assets/advanced/react-19.md +166 -0
  474. package/skills/frontend/shadcn-ui/assets/advanced/tailwind-v4.md +333 -0
  475. package/skills/frontend/shadcn-ui/assets/ai-elements/chain-of-thought.md +519 -0
  476. package/skills/frontend/shadcn-ui/assets/ai-elements/chat.md +581 -0
  477. package/skills/frontend/shadcn-ui/assets/ai-elements/checkpoint.md +243 -0
  478. package/skills/frontend/shadcn-ui/assets/ai-elements/confirmation.md +382 -0
  479. package/skills/frontend/shadcn-ui/assets/ai-elements/context.md +188 -0
  480. package/skills/frontend/shadcn-ui/assets/ai-elements/file-tree.md +248 -0
  481. package/skills/frontend/shadcn-ui/assets/ai-elements/index.md +307 -0
  482. package/skills/frontend/shadcn-ui/assets/ai-elements/inline-citation.md +219 -0
  483. package/skills/frontend/shadcn-ui/assets/ai-elements/message.md +298 -0
  484. package/skills/frontend/shadcn-ui/assets/ai-elements/model-selector.md +368 -0
  485. package/skills/frontend/shadcn-ui/assets/ai-elements/plan.md +398 -0
  486. package/skills/frontend/shadcn-ui/assets/ai-elements/prompt-input.md +403 -0
  487. package/skills/frontend/shadcn-ui/assets/ai-elements/queue.md +517 -0
  488. package/skills/frontend/shadcn-ui/assets/ai-elements/reasoning.md +349 -0
  489. package/skills/frontend/shadcn-ui/assets/ai-elements/sources.md +303 -0
  490. package/skills/frontend/shadcn-ui/assets/ai-elements/stack-trace.md +514 -0
  491. package/skills/frontend/shadcn-ui/assets/ai-elements/subagent.md +551 -0
  492. package/skills/frontend/shadcn-ui/assets/ai-elements/suggestion.md +246 -0
  493. package/skills/frontend/shadcn-ui/assets/ai-elements/task.md +380 -0
  494. package/skills/frontend/shadcn-ui/assets/ai-elements/terminal.md +463 -0
  495. package/skills/frontend/shadcn-ui/assets/ai-elements/test-results.md +641 -0
  496. package/skills/frontend/shadcn-ui/assets/ai-elements/tool.md +915 -0
  497. package/skills/frontend/shadcn-ui/assets/components/accordion.md +490 -0
  498. package/skills/frontend/shadcn-ui/assets/components/alert-dialog.md +520 -0
  499. package/skills/frontend/shadcn-ui/assets/components/alert.md +351 -0
  500. package/skills/frontend/shadcn-ui/assets/components/aspect-ratio.md +206 -0
  501. package/skills/frontend/shadcn-ui/assets/components/attachment.md +715 -0
  502. package/skills/frontend/shadcn-ui/assets/components/avatar.md +581 -0
  503. package/skills/frontend/shadcn-ui/assets/components/badge.md +276 -0
  504. package/skills/frontend/shadcn-ui/assets/components/breadcrumb.md +556 -0
  505. package/skills/frontend/shadcn-ui/assets/components/bubble.md +706 -0
  506. package/skills/frontend/shadcn-ui/assets/components/button-group.md +969 -0
  507. package/skills/frontend/shadcn-ui/assets/components/button.md +523 -0
  508. package/skills/frontend/shadcn-ui/assets/components/calendar.md +959 -0
  509. package/skills/frontend/shadcn-ui/assets/components/card.md +684 -0
  510. package/skills/frontend/shadcn-ui/assets/components/carousel.md +643 -0
  511. package/skills/frontend/shadcn-ui/assets/components/chart.md +1295 -0
  512. package/skills/frontend/shadcn-ui/assets/components/checkbox.md +553 -0
  513. package/skills/frontend/shadcn-ui/assets/components/code-block.md +2041 -0
  514. package/skills/frontend/shadcn-ui/assets/components/collapsible.md +504 -0
  515. package/skills/frontend/shadcn-ui/assets/components/combobox.md +1102 -0
  516. package/skills/frontend/shadcn-ui/assets/components/command.md +682 -0
  517. package/skills/frontend/shadcn-ui/assets/components/context-menu.md +949 -0
  518. package/skills/frontend/shadcn-ui/assets/components/data-table.md +1667 -0
  519. package/skills/frontend/shadcn-ui/assets/components/date-picker.md +698 -0
  520. package/skills/frontend/shadcn-ui/assets/components/dialog.md +454 -0
  521. package/skills/frontend/shadcn-ui/assets/components/direction.md +205 -0
  522. package/skills/frontend/shadcn-ui/assets/components/drawer.md +806 -0
  523. package/skills/frontend/shadcn-ui/assets/components/dropdown-menu.md +1315 -0
  524. package/skills/frontend/shadcn-ui/assets/components/empty.md +562 -0
  525. package/skills/frontend/shadcn-ui/assets/components/field.md +1321 -0
  526. package/skills/frontend/shadcn-ui/assets/components/hover-card.md +342 -0
  527. package/skills/frontend/shadcn-ui/assets/components/index.md +82 -0
  528. package/skills/frontend/shadcn-ui/assets/components/input-group.md +980 -0
  529. package/skills/frontend/shadcn-ui/assets/components/input-otp.md +551 -0
  530. package/skills/frontend/shadcn-ui/assets/components/input.md +555 -0
  531. package/skills/frontend/shadcn-ui/assets/components/item.md +937 -0
  532. package/skills/frontend/shadcn-ui/assets/components/kbd.md +290 -0
  533. package/skills/frontend/shadcn-ui/assets/components/label.md +327 -0
  534. package/skills/frontend/shadcn-ui/assets/components/marker.md +445 -0
  535. package/skills/frontend/shadcn-ui/assets/components/menubar.md +804 -0
  536. package/skills/frontend/shadcn-ui/assets/components/message-scroller.md +2770 -0
  537. package/skills/frontend/shadcn-ui/assets/components/message.md +618 -0
  538. package/skills/frontend/shadcn-ui/assets/components/native-select.md +321 -0
  539. package/skills/frontend/shadcn-ui/assets/components/navigation-menu.md +568 -0
  540. package/skills/frontend/shadcn-ui/assets/components/pagination.md +425 -0
  541. package/skills/frontend/shadcn-ui/assets/components/popover.md +402 -0
  542. package/skills/frontend/shadcn-ui/assets/components/progress.md +240 -0
  543. package/skills/frontend/shadcn-ui/assets/components/questionnaire.md +2055 -0
  544. package/skills/frontend/shadcn-ui/assets/components/radio-group.md +440 -0
  545. package/skills/frontend/shadcn-ui/assets/components/resizable.md +302 -0
  546. package/skills/frontend/shadcn-ui/assets/components/scroll-area.md +226 -0
  547. package/skills/frontend/shadcn-ui/assets/components/select.md +647 -0
  548. package/skills/frontend/shadcn-ui/assets/components/separator.md +235 -0
  549. package/skills/frontend/shadcn-ui/assets/components/sheet.md +354 -0
  550. package/skills/frontend/shadcn-ui/assets/components/sidebar.md +1156 -0
  551. package/skills/frontend/shadcn-ui/assets/components/skeleton.md +217 -0
  552. package/skills/frontend/shadcn-ui/assets/components/slider.md +253 -0
  553. package/skills/frontend/shadcn-ui/assets/components/spinner.md +352 -0
  554. package/skills/frontend/shadcn-ui/assets/components/switch.md +296 -0
  555. package/skills/frontend/shadcn-ui/assets/components/table.md +572 -0
  556. package/skills/frontend/shadcn-ui/assets/components/tabs.md +425 -0
  557. package/skills/frontend/shadcn-ui/assets/components/textarea.md +218 -0
  558. package/skills/frontend/shadcn-ui/assets/components/toast.md +260 -0
  559. package/skills/frontend/shadcn-ui/assets/components/toggle-group.md +419 -0
  560. package/skills/frontend/shadcn-ui/assets/components/toggle.md +220 -0
  561. package/skills/frontend/shadcn-ui/assets/components/tooltip.md +332 -0
  562. package/skills/frontend/shadcn-ui/assets/components/trace.md +1890 -0
  563. package/skills/frontend/shadcn-ui/assets/components/typography.md +561 -0
  564. package/skills/frontend/shadcn-ui/assets/dark-mode/next.md +108 -0
  565. package/skills/frontend/shadcn-ui/assets/dark-mode/overview.md +75 -0
  566. package/skills/frontend/shadcn-ui/assets/dark-mode/vite.md +144 -0
  567. package/skills/frontend/shadcn-ui/assets/forms/next.md +716 -0
  568. package/skills/frontend/shadcn-ui/assets/forms/overview.md +60 -0
  569. package/skills/frontend/shadcn-ui/assets/forms/react-hook-form.md +2055 -0
  570. package/skills/frontend/shadcn-ui/assets/forms/tanstack-form.md +2236 -0
  571. package/skills/frontend/shadcn-ui/assets/installation/astro.md +252 -0
  572. package/skills/frontend/shadcn-ui/assets/installation/manual.md +255 -0
  573. package/skills/frontend/shadcn-ui/assets/installation/next.md +256 -0
  574. package/skills/frontend/shadcn-ui/assets/installation/react-router.md +226 -0
  575. package/skills/frontend/shadcn-ui/assets/installation/remix.md +52 -0
  576. package/skills/frontend/shadcn-ui/assets/installation/vite.md +314 -0
  577. package/skills/frontend/shadcn-ui/assets/mcp/mcp.md +338 -0
  578. package/skills/frontend/shadcn-ui/assets/overview/changelog.md +6 -0
  579. package/skills/frontend/shadcn-ui/assets/overview/cli.md +738 -0
  580. package/skills/frontend/shadcn-ui/assets/overview/components-json.md +379 -0
  581. package/skills/frontend/shadcn-ui/assets/overview/directory.md +74 -0
  582. package/skills/frontend/shadcn-ui/assets/overview/introduction.md +77 -0
  583. package/skills/frontend/shadcn-ui/assets/overview/skills.md +71 -0
  584. package/skills/frontend/shadcn-ui/assets/overview/theming.md +304 -0
  585. package/skills/frontend/shadcn-ui/assets/overview/typeset.md +242 -0
  586. package/skills/frontend/shadcn-ui/assets/registry/getting-started.md +648 -0
  587. package/skills/frontend/shadcn-ui/assets/registry/overview.md +90 -0
  588. package/skills/frontend/shadcn-ui/assets/registry/registry-item-json.md +483 -0
  589. package/skills/frontend/shadcn-ui/assets/registry/registry-json.md +178 -0
  590. package/skills/frontend/shadcn-ui/evals/componentVerification.json +19 -0
  591. package/skills/frontend/shadcn-ui/references/aiComponentsCatalog.md +51 -0
  592. package/skills/frontend/shadcn-ui/references/apiReference.md +3 -0
  593. package/skills/frontend/shadcn-ui/references/blocksCatalog.md +32 -0
  594. package/skills/frontend/shadcn-ui/references/cliCommands.md +47 -0
  595. package/skills/frontend/shadcn-ui/references/componentMarkdownSources.md +48 -0
  596. package/skills/frontend/shadcn-ui/scripts/fetchComponentDocs.py +43 -0
  597. package/skills/frontend/tsxReactStandard/SKILL.md +150 -0
  598. package/skills/frontend/tsxReactStandard/evals/tsxVerification.json +14 -0
  599. package/skills/frontend/tsxReactStandard/references/apiReference.md +3 -0
  600. package/skills/frontend/tsxReactStandard/references/discriminatedUnions.md +31 -0
  601. package/skills/frontend/tsxReactStandard/references/tsconfigStrict.md +36 -0
  602. package/skills/frontend/tsxReactStandard/scripts/validateTsxTypes.py +44 -0
  603. package/skills/gitVersionControl/gitWorkflow/SKILL.md +128 -0
  604. package/skills/gitVersionControl/gitWorkflow/assets/README.md +23 -0
  605. package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-environment.md +87 -0
  606. package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-formatting.md +156 -0
  607. package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-reference.md +2363 -0
  608. package/skills/gitVersionControl/gitWorkflow/assets/using-git/about-git.md +156 -0
  609. package/skills/gitVersionControl/gitWorkflow/assets/using-git/about-remote-repositories.md +65 -0
  610. package/skills/gitVersionControl/gitWorkflow/assets/using-git/associating-text-editors-with-git.md +93 -0
  611. package/skills/gitVersionControl/gitWorkflow/assets/using-git/caching-your-github-credentials.md +115 -0
  612. package/skills/gitVersionControl/gitWorkflow/assets/using-git/getting-changes-from-a-remote-repository.md +76 -0
  613. package/skills/gitVersionControl/gitWorkflow/assets/using-git/ignoring-files.md +51 -0
  614. package/skills/gitVersionControl/gitWorkflow/assets/using-git/managing-remote-repositories.md +231 -0
  615. package/skills/gitVersionControl/gitWorkflow/assets/using-git/pushing-commits-to-a-remote-repository.md +119 -0
  616. package/skills/gitVersionControl/gitWorkflow/evals/evalGitWorkflow.py +43 -0
  617. package/skills/gitVersionControl/gitWorkflow/references/apiReference.md +3 -0
  618. package/skills/gitVersionControl/gitWorkflow/references/branchingModels.md +32 -0
  619. package/skills/gitVersionControl/gitWorkflow/scripts/diagnoseGitGraph.py +68 -0
  620. package/skills/github/assets/README.md +39 -0
  621. package/skills/github/assets/cli/gh-environment.md +87 -0
  622. package/skills/github/assets/cli/gh-formatting.md +156 -0
  623. package/skills/github/assets/cli/gh-reference.md +2363 -0
  624. package/skills/github/assets/docs-api/github-docs-api.md +60 -0
  625. package/skills/github/assets/rest-api/actions-secrets.md +1272 -0
  626. package/skills/github/assets/rest-api/actions-variables.md +1247 -0
  627. package/skills/github/assets/rest-api/actions-workflow-runs.md +1697 -0
  628. package/skills/github/assets/rest-api/actions-workflows.md +348 -0
  629. package/skills/github/assets/rest-api/authenticating.md +174 -0
  630. package/skills/github/assets/rest-api/branches.md +727 -0
  631. package/skills/github/assets/rest-api/checks-runs.md +1013 -0
  632. package/skills/github/assets/rest-api/checks-suites.md +1142 -0
  633. package/skills/github/assets/rest-api/code-scanning.md +2957 -0
  634. package/skills/github/assets/rest-api/collaborators.md +547 -0
  635. package/skills/github/assets/rest-api/commits.md +957 -0
  636. package/skills/github/assets/rest-api/dependabot-alerts.md +895 -0
  637. package/skills/github/assets/rest-api/orgs.md +1172 -0
  638. package/skills/github/assets/rest-api/overview.md +875 -0
  639. package/skills/github/assets/rest-api/pull-reviews.md +722 -0
  640. package/skills/github/assets/rest-api/pulls.md +1605 -0
  641. package/skills/github/assets/rest-api/quickstart.md +344 -0
  642. package/skills/github/assets/rest-api/releases.md +650 -0
  643. package/skills/github/assets/rest-api/repos.md +2957 -0
  644. package/skills/github/assets/rest-api/rules.md +1507 -0
  645. package/skills/github/assets/rest-api/secret-scanning.md +947 -0
  646. package/skills/github/assets/rest-api/teams.md +1690 -0
  647. package/skills/github/githubAction/SKILL.md +159 -0
  648. package/skills/github/githubAction/assets/README.md +38 -0
  649. package/skills/github/githubAction/assets/reference/contexts.md +918 -0
  650. package/skills/github/githubAction/assets/reference/dependency-caching.md +393 -0
  651. package/skills/github/githubAction/assets/reference/events-that-trigger-workflows.md +1348 -0
  652. package/skills/github/githubAction/assets/reference/expressions.md +441 -0
  653. package/skills/github/githubAction/assets/reference/metadata-syntax.md +803 -0
  654. package/skills/github/githubAction/assets/reference/variables.md +149 -0
  655. package/skills/github/githubAction/assets/reference/workflow-cancellation.md +22 -0
  656. package/skills/github/githubAction/assets/reference/workflow-commands.md +1056 -0
  657. package/skills/github/githubAction/assets/reference/workflow-syntax.md +1721 -0
  658. package/skills/github/githubAction/assets/rest-api/secrets.md +1272 -0
  659. package/skills/github/githubAction/assets/rest-api/workflow-runs.md +1697 -0
  660. package/skills/github/githubAction/assets/rest-api/workflows.md +348 -0
  661. package/skills/github/githubAction/assets/starter-workflows/automation/stale.yml +27 -0
  662. package/skills/github/githubAction/assets/starter-workflows/ci/blank.yml +36 -0
  663. package/skills/github/githubAction/assets/starter-workflows/ci/docker-image.yml +18 -0
  664. package/skills/github/githubAction/assets/starter-workflows/ci/go.yml +28 -0
  665. package/skills/github/githubAction/assets/starter-workflows/ci/maven.yml +35 -0
  666. package/skills/github/githubAction/assets/starter-workflows/ci/node.js.yml +31 -0
  667. package/skills/github/githubAction/assets/starter-workflows/ci/python-app.yml +39 -0
  668. package/skills/github/githubAction/assets/starter-workflows/ci/rust.yml +22 -0
  669. package/skills/github/githubAction/assets/starter-workflows/code-scanning/codeql.yml +97 -0
  670. package/skills/github/githubAction/evals/actionVerification.json +14 -0
  671. package/skills/github/githubAction/references/apiReference.md +3 -0
  672. package/skills/github/githubAction/references/workflowPatterns.md +81 -0
  673. package/skills/github/githubAction/scripts/validateWorkflowYaml.py +53 -0
  674. package/skills/github/githubQuality/SKILL.md +136 -0
  675. package/skills/github/githubQuality/assets/README.md +24 -0
  676. package/skills/github/githubQuality/assets/pull-requests/about-code-owners.md +178 -0
  677. package/skills/github/githubQuality/assets/pull-requests/about-merge-methods.md +48 -0
  678. package/skills/github/githubQuality/assets/pull-requests/creating-a-pull-request.md +170 -0
  679. package/skills/github/githubQuality/assets/pull-requests/giving-reviews.md +48 -0
  680. package/skills/github/githubQuality/assets/pull-requests/managing-a-merge-queue.md +134 -0
  681. package/skills/github/githubQuality/assets/pull-requests/merging-a-pull-request.md +101 -0
  682. package/skills/github/githubQuality/assets/pull-requests/resolving-reviews.md +59 -0
  683. package/skills/github/githubQuality/assets/pull-requests/status-checks.md +135 -0
  684. package/skills/github/githubQuality/assets/rest-api/checks-runs.md +1013 -0
  685. package/skills/github/githubQuality/assets/rest-api/checks-suites.md +1142 -0
  686. package/skills/github/githubQuality/assets/rest-api/commits.md +957 -0
  687. package/skills/github/githubQuality/assets/rest-api/pulls.md +1605 -0
  688. package/skills/github/githubQuality/assets/rest-api/reviews.md +722 -0
  689. package/skills/github/githubQuality/evals/qualityVerification.json +14 -0
  690. package/skills/github/githubQuality/references/apiReference.md +3 -0
  691. package/skills/github/githubQuality/references/codeownersExample.md +26 -0
  692. package/skills/github/githubQuality/references/prTemplate.md +20 -0
  693. package/skills/github/githubQuality/scripts/auditPrQuality.py +52 -0
  694. package/skills/github/githubSecurity/SKILL.md +170 -0
  695. package/skills/github/githubSecurity/assets/README.md +32 -0
  696. package/skills/github/githubSecurity/assets/code-scanning/code-scanning-alerts.md +133 -0
  697. package/skills/github/githubSecurity/assets/code-scanning/code-scanning.md +67 -0
  698. package/skills/github/githubSecurity/assets/code-scanning/codeql-code-scanning.md +79 -0
  699. package/skills/github/githubSecurity/assets/code-scanning/configure-code-scanning.md +121 -0
  700. package/skills/github/githubSecurity/assets/dependabot/about-the-dependabot-yml-file.md +74 -0
  701. package/skills/github/githubSecurity/assets/dependabot/dependabot-alerts.md +133 -0
  702. package/skills/github/githubSecurity/assets/dependabot/dependabot-security-updates.md +95 -0
  703. package/skills/github/githubSecurity/assets/dependabot/dependabot-version-updates.md +80 -0
  704. package/skills/github/githubSecurity/assets/rest-api/code-scanning.md +2957 -0
  705. package/skills/github/githubSecurity/assets/rest-api/dependabot-alerts.md +895 -0
  706. package/skills/github/githubSecurity/assets/rest-api/secret-scanning.md +947 -0
  707. package/skills/github/githubSecurity/assets/secret-scanning/enable-secret-scanning.md +59 -0
  708. package/skills/github/githubSecurity/assets/secret-scanning/secret-scanning.md +105 -0
  709. package/skills/github/githubSecurity/assets/security-advisories/github-advisory-database.md +148 -0
  710. package/skills/github/githubSecurity/evals/securityVerification.json +14 -0
  711. package/skills/github/githubSecurity/references/apiReference.md +3 -0
  712. package/skills/github/githubSecurity/references/codeqlAnalysis.yml +42 -0
  713. package/skills/github/githubSecurity/references/dependabotConfig.yml +27 -0
  714. package/skills/github/githubSecurity/scripts/auditRepoSecurity.py +47 -0
  715. package/skills/github/githubSetup/SKILL.md +137 -0
  716. package/skills/github/githubSetup/assets/README.md +40 -0
  717. package/skills/github/githubSetup/assets/branches/about-protected-branches.md +198 -0
  718. package/skills/github/githubSetup/assets/branches/changing-the-default-branch.md +49 -0
  719. package/skills/github/githubSetup/assets/branches/deleting-and-restoring-branches.md +44 -0
  720. package/skills/github/githubSetup/assets/branches/managing-a-branch-protection-rule.md +115 -0
  721. package/skills/github/githubSetup/assets/branches/renaming-a-branch.md +74 -0
  722. package/skills/github/githubSetup/assets/branches/viewing-branches-in-your-repository.md +30 -0
  723. package/skills/github/githubSetup/assets/repositories/about-repositories.md +127 -0
  724. package/skills/github/githubSetup/assets/repositories/cloning-a-repository.md +114 -0
  725. package/skills/github/githubSetup/assets/repositories/creating-a-new-repository.md +82 -0
  726. package/skills/github/githubSetup/assets/repositories/creating-a-repository-from-a-template.md +51 -0
  727. package/skills/github/githubSetup/assets/repositories/deleting-a-repository.md +34 -0
  728. package/skills/github/githubSetup/assets/repositories/managing-teams-and-people-with-access.md +69 -0
  729. package/skills/github/githubSetup/assets/repositories/renaming-a-repository.md +47 -0
  730. package/skills/github/githubSetup/assets/repositories/restoring-a-deleted-repository.md +61 -0
  731. package/skills/github/githubSetup/assets/repositories/setting-repository-visibility.md +137 -0
  732. package/skills/github/githubSetup/assets/rest-api/branches.md +727 -0
  733. package/skills/github/githubSetup/assets/rest-api/quickstart.md +344 -0
  734. package/skills/github/githubSetup/assets/rest-api/repos.md +2957 -0
  735. package/skills/github/githubSetup/assets/rulesets/about-rulesets.md +72 -0
  736. package/skills/github/githubSetup/assets/rulesets/available-rules-for-rulesets.md +383 -0
  737. package/skills/github/githubSetup/assets/rulesets/converting-branch-protections-to-rulesets.md +92 -0
  738. package/skills/github/githubSetup/assets/rulesets/creating-rulesets-for-a-repository.md +108 -0
  739. package/skills/github/githubSetup/assets/rulesets/managing-rulesets-for-a-repository.md +149 -0
  740. package/skills/github/githubSetup/assets/rulesets/troubleshooting-rules.md +122 -0
  741. package/skills/github/githubSetup/evals/setupVerification.json +14 -0
  742. package/skills/github/githubSetup/references/apiReference.md +3 -0
  743. package/skills/github/githubSetup/references/repoSettingsBlueprint.md +13 -0
  744. package/skills/github/githubSetup/references/rulesetTemplates.json +42 -0
  745. package/skills/github/githubSetup/scripts/configureRepoBaseline.py +46 -0
  746. package/skills/github/githubTeam/SKILL.md +115 -0
  747. package/skills/github/githubTeam/assets/README.md +21 -0
  748. package/skills/github/githubTeam/assets/organizations/about-organizations.md +69 -0
  749. package/skills/github/githubTeam/assets/organizations/repository-roles-for-an-organization.md +94 -0
  750. package/skills/github/githubTeam/assets/rest-api/collaborators.md +547 -0
  751. package/skills/github/githubTeam/assets/rest-api/orgs.md +1172 -0
  752. package/skills/github/githubTeam/assets/rest-api/teams.md +1690 -0
  753. package/skills/github/githubTeam/assets/teams/about-teams.md +82 -0
  754. package/skills/github/githubTeam/assets/teams/adding-members-to-a-team.md +55 -0
  755. package/skills/github/githubTeam/evals/teamVerification.json +14 -0
  756. package/skills/github/githubTeam/references/apiReference.md +3 -0
  757. package/skills/github/githubTeam/references/permissionMatrix.md +17 -0
  758. package/skills/github/githubTeam/references/reviewAssignment.md +17 -0
  759. package/skills/github/githubTeam/scripts/manageTeamSync.py +31 -0
  760. package/skills/securityQa/llmSecurityRedteaming/SKILL.md +86 -0
  761. package/skills/securityQa/llmSecurityRedteaming/evals/securityRedteamVerification.json +14 -0
  762. package/skills/securityQa/llmSecurityRedteaming/references/apiReference.md +3 -0
  763. package/skills/securityQa/llmSecurityRedteaming/references/jailbreakTaxonomy.md +6 -0
  764. package/skills/securityQa/llmSecurityRedteaming/references/owaspLlmTopTen.md +12 -0
  765. package/skills/securityQa/llmSecurityRedteaming/scripts/testPromptInjection.py +34 -0
  766. package/skills/softwareDevelopment/requirementsEngineering/SKILL.md +110 -0
  767. package/skills/softwareDevelopment/requirementsEngineering/evals/evalRequirements.py +33 -0
  768. package/skills/softwareDevelopment/requirementsEngineering/references/apiReference.md +3 -0
  769. package/skills/softwareDevelopment/requirementsEngineering/references/requirementsAnalysisModels.md +34 -0
  770. package/skills/softwareDevelopment/requirementsEngineering/scripts/validateUserStories.py +49 -0
  771. package/skills/testing/testDrivenDevelopment/SKILL.md +122 -0
  772. package/skills/testing/testDrivenDevelopment/evals/evalTdd.py +25 -0
  773. package/skills/testing/testDrivenDevelopment/references/apiReference.md +3 -0
  774. package/skills/testing/testDrivenDevelopment/references/testPyramidDoubles.md +35 -0
  775. package/skills/testing/testDrivenDevelopment/scripts/auditTestPyramid.py +58 -0
@@ -0,0 +1,1156 @@
1
+ ---
2
+ title: Sidebar
3
+ description: A composable, themeable and customizable sidebar component.
4
+ base: base
5
+ component: true
6
+ ---
7
+
8
+ import { ExternalLinkIcon } from "lucide-react"
9
+
10
+ <figure className="flex flex-col gap-4">
11
+ ```tsx
12
+ "use client"
13
+
14
+ import * as React from "react"
15
+ import {
16
+ AudioWaveform,
17
+ BadgeCheck,
18
+ Bell,
19
+ BookOpen,
20
+ Bot,
21
+ ChevronRight,
22
+ ChevronsUpDown,
23
+ Command,
24
+ CreditCard,
25
+ Folder,
26
+ Forward,
27
+ Frame,
28
+ GalleryVerticalEnd,
29
+ LogOut,
30
+ Map,
31
+ MoreHorizontal,
32
+ PieChart,
33
+ Plus,
34
+ Settings2,
35
+ Sparkles,
36
+ SquareTerminal,
37
+ Trash2,
38
+ } from "lucide-react"
39
+
40
+ import {
41
+ Avatar,
42
+ AvatarFallback,
43
+ AvatarImage,
44
+ } from "@/components/ui/avatar"
45
+ import {
46
+ Collapsible,
47
+ CollapsibleContent,
48
+ CollapsibleTrigger,
49
+ } from "@/components/ui/collapsible"
50
+ import {
51
+ DropdownMenu,
52
+ DropdownMenuContent,
53
+ DropdownMenuGroup,
54
+ DropdownMenuItem,
55
+ DropdownMenuLabel,
56
+ DropdownMenuSeparator,
57
+ DropdownMenuShortcut,
58
+ DropdownMenuTrigger,
59
+ } from "@/components/ui/dropdown-menu"
60
+ import {
61
+ Sidebar,
62
+ SidebarContent,
63
+ SidebarFooter,
64
+ SidebarGroup,
65
+ SidebarGroupLabel,
66
+ SidebarHeader,
67
+ SidebarInset,
68
+ SidebarMenu,
69
+ SidebarMenuAction,
70
+ SidebarMenuButton,
71
+ SidebarMenuItem,
72
+ SidebarMenuSub,
73
+ SidebarMenuSubButton,
74
+ SidebarMenuSubItem,
75
+ SidebarProvider,
76
+ SidebarRail,
77
+ SidebarTrigger,
78
+ useSidebar,
79
+ } from "@/components/ui/sidebar"
80
+
81
+ // This is sample data.
82
+ const data = {
83
+ user: {
84
+ name: "shadcn",
85
+ email: "m@example.com",
86
+ avatar: "/avatars/shadcn.jpg",
87
+ },
88
+ teams: [
89
+ {
90
+ name: "Acme Inc",
91
+ logo: GalleryVerticalEnd,
92
+ plan: "Enterprise",
93
+ },
94
+ {
95
+ name: "Acme Corp.",
96
+ logo: AudioWaveform,
97
+ plan: "Startup",
98
+ },
99
+ {
100
+ name: "Evil Corp.",
101
+ logo: Command,
102
+ plan: "Free",
103
+ },
104
+ ],
105
+ navMain: [
106
+ {
107
+ title: "Playground",
108
+ url: "#",
109
+ icon: SquareTerminal,
110
+ isActive: true,
111
+ items: [
112
+ {
113
+ title: "History",
114
+ url: "#",
115
+ },
116
+ {
117
+ title: "Starred",
118
+ url: "#",
119
+ },
120
+ {
121
+ title: "Settings",
122
+ url: "#",
123
+ },
124
+ ],
125
+ },
126
+ {
127
+ title: "Models",
128
+ url: "#",
129
+ icon: Bot,
130
+ items: [
131
+ {
132
+ title: "Genesis",
133
+ url: "#",
134
+ },
135
+ {
136
+ title: "Explorer",
137
+ url: "#",
138
+ },
139
+ {
140
+ title: "Quantum",
141
+ url: "#",
142
+ },
143
+ ],
144
+ },
145
+ {
146
+ title: "Documentation",
147
+ url: "#",
148
+ icon: BookOpen,
149
+ items: [
150
+ {
151
+ title: "Introduction",
152
+ url: "#",
153
+ },
154
+ {
155
+ title: "Get Started",
156
+ url: "#",
157
+ },
158
+ {
159
+ title: "Tutorials",
160
+ url: "#",
161
+ },
162
+ {
163
+ title: "Changelog",
164
+ url: "#",
165
+ },
166
+ ],
167
+ },
168
+ {
169
+ title: "Settings",
170
+ url: "#",
171
+ icon: Settings2,
172
+ items: [
173
+ {
174
+ title: "General",
175
+ url: "#",
176
+ },
177
+ {
178
+ title: "Team",
179
+ url: "#",
180
+ },
181
+ {
182
+ title: "Billing",
183
+ url: "#",
184
+ },
185
+ {
186
+ title: "Limits",
187
+ url: "#",
188
+ },
189
+ ],
190
+ },
191
+ ],
192
+ projects: [
193
+ {
194
+ name: "Design Engineering",
195
+ url: "#",
196
+ icon: Frame,
197
+ },
198
+ {
199
+ name: "Sales & Marketing",
200
+ url: "#",
201
+ icon: PieChart,
202
+ },
203
+ {
204
+ name: "Travel",
205
+ url: "#",
206
+ icon: Map,
207
+ },
208
+ ],
209
+ }
210
+
211
+ function TeamSwitcher({
212
+ teams,
213
+ }: {
214
+ teams: {
215
+ name: string
216
+ logo: React.ElementType
217
+ plan: string
218
+ }[]
219
+ }) {
220
+ const { isMobile } = useSidebar()
221
+ const [activeTeam, setActiveTeam] = React.useState(teams[0])
222
+
223
+ if (!activeTeam) {
224
+ return null
225
+ }
226
+
227
+ return (
228
+ <SidebarMenu>
229
+ <SidebarMenuItem>
230
+ <DropdownMenu>
231
+ <DropdownMenuTrigger
232
+ render={
233
+ <SidebarMenuButton
234
+ size="lg"
235
+ className="data-[state=open]:bg-sidebar-accent data-[state=open]:text-sidebar-accent-foreground"
236
+ />
237
+ }
238
+ >
239
+ <div className="flex aspect-square size-8 items-center justify-center rounded-lg bg-sidebar-primary text-sidebar-primary-foreground">
240
+ <activeTeam.logo className="size-4" />
241
+ </div>
242
+ <div className="grid flex-1 text-left text-sm leading-tight">
243
+ <span className="truncate font-medium">{activeTeam.name}</span>
244
+ <span className="truncate text-xs">{activeTeam.plan}</span>
245
+ </div>
246
+ <ChevronsUpDown className="ml-auto" />
247
+ </DropdownMenuTrigger>
248
+ <DropdownMenuContent
249
+ className="w-(--radix-dropdown-menu-trigger-width) min-w-56 rounded-lg"
250
+ align="start"
251
+ side={isMobile ? "bottom" : "right"}
252
+ sideOffset={4}
253
+ >
254
+ <DropdownMenuGroup>
255
+ <DropdownMenuLabel className="text-xs text-muted-foreground">
256
+ Teams
257
+ </DropdownMenuLabel>
258
+ {teams.map((team, index) => (
259
+ <DropdownMenuItem
260
+ key={team.name}
261
+ onClick={() => setActiveTeam(team)}
262
+ className="gap-2 p-2"
263
+ >
264
+ <div className="flex size-6 items-center justify-center rounded-md border">
265
+ <team.logo className="size-3.5 shrink-0" />
266
+ </div>
267
+ {team.name}
268
+ <DropdownMenuShortcut>⌘{index + 1}</DropdownMenuShortcut>
269
+ </DropdownMenuItem>
270
+ ))}
271
+ </DropdownMenuGroup>
272
+ <DropdownMenuSeparator />
273
+ <DropdownMenuGroup>
274
+ <DropdownMenuItem className="gap-2 p-2">
275
+ <div className="flex size-6 items-center justify-center rounded-md border bg-transparent">
276
+ <Plus className="size-4" />
277
+ </div>
278
+ <div className="font-medium text-muted-foreground">
279
+ Add team
280
+ </div>
281
+ </DropdownMenuItem>
282
+ </DropdownMenuGroup>
283
+ </DropdownMenuContent>
284
+ </DropdownMenu>
285
+ </SidebarMenuItem>
286
+ </SidebarMenu>
287
+ )
288
+ }
289
+
290
+ function NavMain({
291
+ items,
292
+ }: {
293
+ items: {
294
+ title: string
295
+ url: string
296
+ icon?: React.ElementType
297
+ isActive?: boolean
298
+ items?: {
299
+ title: string
300
+ url: string
301
+ }[]
302
+ }[]
303
+ }) {
304
+ return (
305
+ <SidebarGroup>
306
+ <SidebarGroupLabel>Platform</SidebarGroupLabel>
307
+ <SidebarMenu>
308
+ {items.map((item) => (
309
+ <Collapsible
310
+ key={item.title}
311
+ defaultOpen={item.isActive}
312
+ className="group/collapsible"
313
+ >
314
+ <SidebarMenuItem>
315
+ <CollapsibleTrigger
316
+ render={<SidebarMenuButton tooltip={item.title} />}
317
+ >
318
+ {item.icon && <item.icon />}
319
+ <span>{item.title}</span>
320
+ <ChevronRight className="ml-auto transition-transform duration-200 group-data-[state=open]/collapsible:rotate-90" />
321
+ </CollapsibleTrigger>
322
+ <CollapsibleContent>
323
+ <SidebarMenuSub>
324
+ {item.items?.map((subItem) => (
325
+ <SidebarMenuSubItem key={subItem.title}>
326
+ <SidebarMenuSubButton render={<a href={subItem.url} />}>
327
+ <span>{subItem.title}</span>
328
+ </SidebarMenuSubButton>
329
+ </SidebarMenuSubItem>
330
+ ))}
331
+ </SidebarMenuSub>
332
+ </CollapsibleContent>
333
+ </SidebarMenuItem>
334
+ </Collapsible>
335
+ ))}
336
+ </SidebarMenu>
337
+ </SidebarGroup>
338
+ )
339
+ }
340
+
341
+ function NavProjects({
342
+ projects,
343
+ }: {
344
+ projects: {
345
+ name: string
346
+ url: string
347
+ icon: React.ElementType
348
+ }[]
349
+ }) {
350
+ const { isMobile } = useSidebar()
351
+
352
+ return (
353
+ <SidebarGroup className="group-data-[collapsible=icon]:hidden">
354
+ <SidebarGroupLabel>Projects</SidebarGroupLabel>
355
+ <SidebarMenu>
356
+ {projects.map((item) => (
357
+ <SidebarMenuItem key={item.name}>
358
+ <SidebarMenuButton render={<a href={item.url} />}>
359
+ <item.icon />
360
+ <span>{item.name}</span>
361
+ </SidebarMenuButton>
362
+ <DropdownMenu>
363
+ <DropdownMenuTrigger render={<SidebarMenuAction showOnHover />}>
364
+ <MoreHorizontal />
365
+ <span className="sr-only">More</span>
366
+ </DropdownMenuTrigger>
367
+ <DropdownMenuContent
368
+ className="w-48 rounded-lg"
369
+ side={isMobile ? "bottom" : "right"}
370
+ align={isMobile ? "end" : "start"}
371
+ >
372
+ <DropdownMenuItem>
373
+ <Folder className="text-muted-foreground" />
374
+ <span>View Project</span>
375
+ </DropdownMenuItem>
376
+ <DropdownMenuItem>
377
+ <Forward className="text-muted-foreground" />
378
+ <span>Share Project</span>
379
+ </DropdownMenuItem>
380
+ <DropdownMenuSeparator />
381
+ <DropdownMenuItem>
382
+ <Trash2 className="text-muted-foreground" />
383
+ <span>Delete Project</span>
384
+ </DropdownMenuItem>
385
+ </DropdownMenuContent>
386
+ </DropdownMenu>
387
+ </SidebarMenuItem>
388
+ ))}
389
+ <SidebarMenuItem>
390
+ <SidebarMenuButton className="text-sidebar-foreground/70">
391
+ <MoreHorizontal className="text-sidebar-foreground/70" />
392
+ <span>More</span>
393
+ </SidebarMenuButton>
394
+ </SidebarMenuItem>
395
+ </SidebarMenu>
396
+ </SidebarGroup>
397
+ )
398
+ }
399
+
400
+ function NavUser({
401
+ user,
402
+ }: {
403
+ user: {
404
+ name: string
405
+ email: string
406
+ avatar: string
407
+ }
408
+ }) {
409
+ const { isMobile } = useSidebar()
410
+
411
+ return (
412
+ <SidebarMenu>
413
+ <SidebarMenuItem>
414
+ <DropdownMenu>
415
+ <DropdownMenuTrigger
416
+ render={
417
+ <SidebarMenuButton
418
+ size="lg"
419
+ className="data-[state=open]:bg-sidebar-accent data-[state=open]:text-sidebar-accent-foreground"
420
+ />
421
+ }
422
+ >
423
+ <Avatar className="h-8 w-8 rounded-lg">
424
+ <AvatarImage src={user.avatar} alt={user.name} />
425
+ <AvatarFallback className="rounded-lg">CN</AvatarFallback>
426
+ </Avatar>
427
+ <div className="grid flex-1 text-left text-sm leading-tight">
428
+ <span className="truncate font-medium">{user.name}</span>
429
+ <span className="truncate text-xs">{user.email}</span>
430
+ </div>
431
+ <ChevronsUpDown className="ml-auto size-4" />
432
+ </DropdownMenuTrigger>
433
+ <DropdownMenuContent
434
+ className="w-(--radix-dropdown-menu-trigger-width) min-w-56 rounded-lg"
435
+ side={isMobile ? "bottom" : "right"}
436
+ align="end"
437
+ sideOffset={4}
438
+ >
439
+ <DropdownMenuGroup>
440
+ <DropdownMenuLabel className="p-0 font-normal">
441
+ <div className="flex items-center gap-2 px-1 py-1.5 text-left text-sm">
442
+ <Avatar className="h-8 w-8 rounded-lg">
443
+ <AvatarImage src={user.avatar} alt={user.name} />
444
+ <AvatarFallback className="rounded-lg">CN</AvatarFallback>
445
+ </Avatar>
446
+ <div className="grid flex-1 text-left text-sm leading-tight">
447
+ <span className="truncate font-medium">{user.name}</span>
448
+ <span className="truncate text-xs">{user.email}</span>
449
+ </div>
450
+ </div>
451
+ </DropdownMenuLabel>
452
+ </DropdownMenuGroup>
453
+ <DropdownMenuSeparator />
454
+ <DropdownMenuGroup>
455
+ <DropdownMenuItem>
456
+ <Sparkles />
457
+ Upgrade to Pro
458
+ </DropdownMenuItem>
459
+ </DropdownMenuGroup>
460
+ <DropdownMenuSeparator />
461
+ <DropdownMenuGroup>
462
+ <DropdownMenuItem>
463
+ <BadgeCheck />
464
+ Account
465
+ </DropdownMenuItem>
466
+ <DropdownMenuItem>
467
+ <CreditCard />
468
+ Billing
469
+ </DropdownMenuItem>
470
+ <DropdownMenuItem>
471
+ <Bell />
472
+ Notifications
473
+ </DropdownMenuItem>
474
+ </DropdownMenuGroup>
475
+ <DropdownMenuSeparator />
476
+ <DropdownMenuGroup>
477
+ <DropdownMenuItem>
478
+ <LogOut />
479
+ Log out
480
+ </DropdownMenuItem>
481
+ </DropdownMenuGroup>
482
+ </DropdownMenuContent>
483
+ </DropdownMenu>
484
+ </SidebarMenuItem>
485
+ </SidebarMenu>
486
+ )
487
+ }
488
+
489
+ export function AppSidebar({
490
+ ...props
491
+ }: React.ComponentProps<typeof Sidebar>) {
492
+ return (
493
+ <SidebarProvider>
494
+ <Sidebar collapsible="icon" {...props}>
495
+ <SidebarHeader>
496
+ <TeamSwitcher teams={data.teams} />
497
+ </SidebarHeader>
498
+ <SidebarContent>
499
+ <NavMain items={data.navMain} />
500
+ <NavProjects projects={data.projects} />
501
+ </SidebarContent>
502
+ <SidebarFooter>
503
+ <NavUser user={data.user} />
504
+ </SidebarFooter>
505
+ <SidebarRail />
506
+ </Sidebar>
507
+ <SidebarInset>
508
+ <header className="flex h-16 shrink-0 items-center gap-2 transition-[width,height] ease-linear group-has-data-[collapsible=icon]/sidebar-wrapper:h-12">
509
+ <div className="flex items-center gap-2 px-4">
510
+ <SidebarTrigger className="-ml-1" />
511
+ </div>
512
+ </header>
513
+ </SidebarInset>
514
+ </SidebarProvider>
515
+ )
516
+ }
517
+
518
+ ```
519
+ <figcaption className="text-center text-sm text-gray-500">
520
+ A sidebar that collapses to icons.
521
+ </figcaption>
522
+ </figure>
523
+
524
+ Sidebars are one of the most complex components to build. They are central
525
+ to any application and often contain a lot of moving parts.
526
+
527
+ We now have a solid foundation to build on top of. Composable. Themeable.
528
+ Customizable.
529
+
530
+ [Browse the Blocks Library](/blocks).
531
+
532
+ ## Installation
533
+
534
+ <CodeTabs>
535
+
536
+ <TabsList>
537
+ <TabsTrigger value="cli">Command</TabsTrigger>
538
+ <TabsTrigger value="manual">Manual</TabsTrigger>
539
+ </TabsList>
540
+ <TabsContent value="cli">
541
+
542
+ ```bash
543
+ npx shadcn@latest add sidebar
544
+ ```
545
+
546
+ </TabsContent>
547
+
548
+ <TabsContent value="manual">
549
+
550
+ <ComponentSource
551
+ name="sidebar"
552
+ title="components/ui/sidebar.tsx"
553
+ styleName="base-nova"
554
+ />
555
+
556
+ </TabsContent>
557
+
558
+ </CodeTabs>
559
+
560
+ ## Usage
561
+
562
+ ```tsx showLineNumbers title="app/layout.tsx"
563
+ import { SidebarProvider, SidebarTrigger } from "@/components/ui/sidebar"
564
+ import { AppSidebar } from "@/components/app-sidebar"
565
+
566
+ export default function Layout({ children }: { children: React.ReactNode }) {
567
+ return (
568
+ <SidebarProvider>
569
+ <AppSidebar />
570
+ <main>
571
+ <SidebarTrigger />
572
+ {children}
573
+ </main>
574
+ </SidebarProvider>
575
+ )
576
+ }
577
+ ```
578
+
579
+ ```tsx showLineNumbers title="components/app-sidebar.tsx"
580
+ import {
581
+ Sidebar,
582
+ SidebarContent,
583
+ SidebarFooter,
584
+ SidebarGroup,
585
+ SidebarHeader,
586
+ } from "@/components/ui/sidebar"
587
+
588
+ export function AppSidebar() {
589
+ return (
590
+ <Sidebar>
591
+ <SidebarHeader />
592
+ <SidebarContent>
593
+ <SidebarGroup />
594
+ <SidebarGroup />
595
+ </SidebarContent>
596
+ <SidebarFooter />
597
+ </Sidebar>
598
+ )
599
+ }
600
+ ```
601
+
602
+ ## Composition
603
+
604
+ Use the following composition to build a `Sidebar` layout:
605
+
606
+ ```text
607
+ SidebarProvider
608
+ ├── Sidebar
609
+ │ ├── SidebarHeader
610
+ │ ├── SidebarContent
611
+ │ │ ├── SidebarGroup
612
+ │ │ │ ├── SidebarGroupLabel
613
+ │ │ │ ├── SidebarGroupAction
614
+ │ │ │ ├── SidebarGroupContent
615
+ │ │ │ └── SidebarMenu
616
+ │ │ │ ├── SidebarMenuItem
617
+ │ │ │ │ ├── SidebarMenuButton
618
+ │ │ │ │ ├── SidebarMenuAction
619
+ │ │ │ │ └── SidebarMenuBadge
620
+ │ │ │ └── SidebarMenuItem
621
+ │ │ │ ├── SidebarMenuButton
622
+ │ │ │ └── SidebarMenuSub
623
+ │ │ │ ├── SidebarMenuSubItem
624
+ │ │ │ └── SidebarMenuSubItem
625
+ │ │ └── SidebarGroup
626
+ │ │ └── SidebarMenu
627
+ │ │ ├── SidebarMenuItem
628
+ │ │ └── SidebarMenuItem
629
+ │ ├── SidebarFooter
630
+ │ └── SidebarRail
631
+ ├── SidebarInset
632
+ └── SidebarTrigger
633
+ ```
634
+
635
+ ## Structure
636
+
637
+ - **SidebarProvider** — Handles collapsible state and provides sidebar context to child components.
638
+ - **Sidebar** — The main collapsible sidebar panel.
639
+ - **SidebarHeader** — Sticky at the top; use for branding, titles, or workspace switchers.
640
+ - **SidebarFooter** — Sticky at the bottom; use for user menus, settings, or actions.
641
+ - **SidebarContent** — Scrollable region between the header and footer.
642
+ - **SidebarGroup** — Groups related navigation with optional label, action, and content areas.
643
+ - **SidebarMenu** / **SidebarMenuItem** — Menu structure for links, badges, actions, and nested submenus.
644
+ - **SidebarRail** — Resize handle for adjusting sidebar width when applicable.
645
+ - **SidebarInset** — Wraps main content when using the `inset` variant.
646
+ - **SidebarTrigger** — Control that toggles the sidebar open or collapsed.
647
+
648
+ <Image
649
+ src="/images/sidebar-structure.png"
650
+ width="716"
651
+ height="420"
652
+ alt="Sidebar Structure"
653
+ className="mt-6 w-full overflow-hidden rounded-2xl border dark:hidden"
654
+ />
655
+ <Image
656
+ src="/images/sidebar-structure-dark.png"
657
+ width="716"
658
+ height="420"
659
+ alt="Sidebar Structure"
660
+ className="mt-6 hidden w-full overflow-hidden rounded-2xl border dark:block"
661
+ />
662
+
663
+ ## SidebarProvider
664
+
665
+ The `SidebarProvider` component is used to provide the sidebar context to the `Sidebar` component. You should always wrap your application in a `SidebarProvider` component.
666
+
667
+ ### Props
668
+
669
+ | Name | Type | Description |
670
+ | -------------- | ------------------------- | -------------------------------------------- |
671
+ | `defaultOpen` | `boolean` | Default open state of the sidebar. |
672
+ | `open` | `boolean` | Open state of the sidebar (controlled). |
673
+ | `onOpenChange` | `(open: boolean) => void` | Sets open state of the sidebar (controlled). |
674
+
675
+ ### Width
676
+
677
+ If you have a single sidebar in your application, you can use the `SIDEBAR_WIDTH` and `SIDEBAR_WIDTH_MOBILE` variables in `sidebar.tsx` to set the width of the sidebar.
678
+
679
+ ```tsx showLineNumbers title="components/ui/sidebar.tsx"
680
+ const SIDEBAR_WIDTH = "16rem"
681
+ const SIDEBAR_WIDTH_MOBILE = "18rem"
682
+ ```
683
+
684
+ For multiple sidebars in your application, you can use the `--sidebar-width` and `--sidebar-width-mobile` CSS variables in the `style` prop.
685
+
686
+ ```tsx showLineNumbers
687
+ <SidebarProvider
688
+ style={
689
+ {
690
+ "--sidebar-width": "20rem",
691
+ "--sidebar-width-mobile": "20rem",
692
+ } as React.CSSProperties
693
+ }
694
+ >
695
+ <Sidebar />
696
+ </SidebarProvider>
697
+ ```
698
+
699
+ ### Keyboard Shortcut
700
+
701
+ To trigger the sidebar, you use the `cmd+b` keyboard shortcut on Mac and `ctrl+b` on Windows.
702
+
703
+ ```tsx showLineNumbers title="components/ui/sidebar.tsx"
704
+ const SIDEBAR_KEYBOARD_SHORTCUT = "b"
705
+ ```
706
+
707
+ ## Sidebar
708
+
709
+ The main `Sidebar` component used to render a collapsible sidebar.
710
+
711
+ ### Props
712
+
713
+ | Property | Type | Description |
714
+ | ------------- | --------------------------------- | --------------------------------- |
715
+ | `side` | `left` or `right` | The side of the sidebar. |
716
+ | `variant` | `sidebar`, `floating`, or `inset` | The variant of the sidebar. |
717
+ | `collapsible` | `offcanvas`, `icon`, or `none` | Collapsible state of the sidebar. |
718
+
719
+ | Prop | Description |
720
+ | ----------- | ------------------------------------------------------------ |
721
+ | `offcanvas` | A collapsible sidebar that slides in from the left or right. |
722
+ | `icon` | A sidebar that collapses to icons. |
723
+ | `none` | A non-collapsible sidebar. |
724
+
725
+ <Callout>
726
+ **Note:** If you use the `inset` variant, remember to wrap your main content
727
+ in a `SidebarInset` component.
728
+ </Callout>
729
+
730
+ ```tsx showLineNumbers
731
+ <SidebarProvider>
732
+ <Sidebar variant="inset" />
733
+ <SidebarInset>
734
+ <main>{children}</main>
735
+ </SidebarInset>
736
+ </SidebarProvider>
737
+ ```
738
+
739
+ ## useSidebar
740
+
741
+ The `useSidebar` hook is used to control the sidebar.
742
+
743
+ ```tsx showLineNumbers
744
+ import { useSidebar } from "@/components/ui/sidebar"
745
+
746
+ export function AppSidebar() {
747
+ const {
748
+ state,
749
+ open,
750
+ setOpen,
751
+ openMobile,
752
+ setOpenMobile,
753
+ isMobile,
754
+ toggleSidebar,
755
+ } = useSidebar()
756
+ }
757
+ ```
758
+
759
+ | Property | Type | Description |
760
+ | --------------- | ------------------------- | --------------------------------------------- |
761
+ | `state` | `expanded` or `collapsed` | The current state of the sidebar. |
762
+ | `open` | `boolean` | Whether the sidebar is open. |
763
+ | `setOpen` | `(open: boolean) => void` | Sets the open state of the sidebar. |
764
+ | `openMobile` | `boolean` | Whether the sidebar is open on mobile. |
765
+ | `setOpenMobile` | `(open: boolean) => void` | Sets the open state of the sidebar on mobile. |
766
+ | `isMobile` | `boolean` | Whether the sidebar is on mobile. |
767
+ | `toggleSidebar` | `() => void` | Toggles the sidebar. Desktop and mobile. |
768
+
769
+ ## SidebarHeader
770
+
771
+ Use the `SidebarHeader` component to add a sticky header to the sidebar.
772
+
773
+ ```tsx showLineNumbers title="components/app-sidebar.tsx"
774
+ <Sidebar>
775
+ <SidebarHeader>
776
+ <SidebarMenu>
777
+ <SidebarMenuItem>
778
+ <DropdownMenu>
779
+ <DropdownMenuTrigger render={<SidebarMenuButton />}>
780
+ Select Workspace
781
+ <ChevronDown className="ml-auto" />
782
+ </DropdownMenuTrigger>
783
+ <DropdownMenuContent>
784
+ <DropdownMenuItem>
785
+ <span>Acme Inc</span>
786
+ </DropdownMenuItem>
787
+ </DropdownMenuContent>
788
+ </DropdownMenu>
789
+ </SidebarMenuItem>
790
+ </SidebarMenu>
791
+ </SidebarHeader>
792
+ </Sidebar>
793
+ ```
794
+
795
+ ## SidebarFooter
796
+
797
+ Use the `SidebarFooter` component to add a sticky footer to the sidebar.
798
+
799
+ ```tsx showLineNumbers
800
+ <Sidebar>
801
+ <SidebarFooter>
802
+ <SidebarMenu>
803
+ <SidebarMenuItem>
804
+ <SidebarMenuButton>
805
+ <User2 /> Username
806
+ </SidebarMenuButton>
807
+ </SidebarMenuItem>
808
+ </SidebarMenu>
809
+ </SidebarFooter>
810
+ </Sidebar>
811
+ ```
812
+
813
+ ## SidebarContent
814
+
815
+ The `SidebarContent` component is used to wrap the content of the sidebar. This is where you add your `SidebarGroup` components. It is scrollable.
816
+
817
+ ```tsx showLineNumbers
818
+ <Sidebar>
819
+ <SidebarContent>
820
+ <SidebarGroup />
821
+ <SidebarGroup />
822
+ </SidebarContent>
823
+ </Sidebar>
824
+ ```
825
+
826
+ ## SidebarGroup
827
+
828
+ Use the `SidebarGroup` component to create a section within the sidebar.
829
+
830
+ A `SidebarGroup` has a `SidebarGroupLabel`, a `SidebarGroupContent` and an optional `SidebarGroupAction`.
831
+
832
+ ```tsx showLineNumbers
833
+ <SidebarGroup>
834
+ <SidebarGroupLabel>Application</SidebarGroupLabel>
835
+ <SidebarGroupAction>
836
+ <Plus /> <span className="sr-only">Add Project</span>
837
+ </SidebarGroupAction>
838
+ <SidebarGroupContent></SidebarGroupContent>
839
+ </SidebarGroup>
840
+ ```
841
+
842
+ To make a `SidebarGroup` collapsible, wrap it in a `Collapsible`.
843
+
844
+ ```tsx showLineNumbers
845
+ <Collapsible defaultOpen className="group/collapsible">
846
+ <SidebarGroup>
847
+ <SidebarGroupLabel render={<CollapsibleTrigger />}>
848
+ Help
849
+ <ChevronDown className="ml-auto transition-transform group-data-open/collapsible:rotate-180" />
850
+ </SidebarGroupLabel>
851
+ <CollapsibleContent>
852
+ <SidebarGroupContent />
853
+ </CollapsibleContent>
854
+ </SidebarGroup>
855
+ </Collapsible>
856
+ ```
857
+
858
+ ## SidebarMenu
859
+
860
+ The `SidebarMenu` component is used for building a menu within a `SidebarGroup`.
861
+
862
+ <Image
863
+ src="/images/sidebar-menu.png"
864
+ width="716"
865
+ height="420"
866
+ alt="Sidebar Menu"
867
+ className="mt-6 w-full overflow-hidden rounded-2xl border dark:hidden"
868
+ />
869
+ <Image
870
+ src="/images/sidebar-menu-dark.png"
871
+ width="716"
872
+ height="420"
873
+ alt="Sidebar Menu"
874
+ className="mt-6 hidden w-full overflow-hidden rounded-2xl border dark:block"
875
+ />
876
+
877
+ ```tsx showLineNumbers
878
+ <SidebarMenu>
879
+ {projects.map((project) => (
880
+ <SidebarMenuItem key={project.name}>
881
+ <SidebarMenuButton render={<a href={project.url} />}>
882
+ <project.icon />
883
+ <span>{project.name}</span>
884
+ </SidebarMenuButton>
885
+ </SidebarMenuItem>
886
+ ))}
887
+ </SidebarMenu>
888
+ ```
889
+
890
+ ## SidebarMenuButton
891
+
892
+ The `SidebarMenuButton` component is used to render a menu button within a `SidebarMenuItem`.
893
+
894
+ By default, the `SidebarMenuButton` renders a button but you can use the `render` prop to render a different component such as a `Link` or an `a` tag.
895
+
896
+ Use the `isActive` prop to mark a menu item as active.
897
+
898
+ ```tsx showLineNumbers
899
+ <SidebarMenuButton render={<a href="#" />} isActive>
900
+ Home
901
+ </SidebarMenuButton>
902
+ ```
903
+
904
+ ## SidebarMenuAction
905
+
906
+ The `SidebarMenuAction` component is used to render a menu action within a `SidebarMenuItem`.
907
+
908
+ ```tsx showLineNumbers
909
+ <SidebarMenuItem>
910
+ <SidebarMenuButton render={<a href="#" />}>
911
+ <Home />
912
+ <span>Home</span>
913
+ </SidebarMenuButton>
914
+ <SidebarMenuAction>
915
+ <Plus /> <span className="sr-only">Add Project</span>
916
+ </SidebarMenuAction>
917
+ </SidebarMenuItem>
918
+ ```
919
+
920
+ ## SidebarMenuSub
921
+
922
+ The `SidebarMenuSub` component is used to render a submenu within a `SidebarMenu`.
923
+
924
+ ```tsx showLineNumbers
925
+ <SidebarMenuItem>
926
+ <SidebarMenuButton />
927
+ <SidebarMenuSub>
928
+ <SidebarMenuSubItem>
929
+ <SidebarMenuSubButton />
930
+ </SidebarMenuSubItem>
931
+ </SidebarMenuSub>
932
+ </SidebarMenuItem>
933
+ ```
934
+
935
+ ## SidebarMenuBadge
936
+
937
+ The `SidebarMenuBadge` component is used to render a badge within a `SidebarMenuItem`.
938
+
939
+ ```tsx showLineNumbers
940
+ <SidebarMenuItem>
941
+ <SidebarMenuButton />
942
+ <SidebarMenuBadge>24</SidebarMenuBadge>
943
+ </SidebarMenuItem>
944
+ ```
945
+
946
+ ## SidebarMenuSkeleton
947
+
948
+ The `SidebarMenuSkeleton` component is used to render a skeleton for a `SidebarMenu`.
949
+
950
+ ```tsx showLineNumbers
951
+ <SidebarMenu>
952
+ {Array.from({ length: 5 }).map((_, index) => (
953
+ <SidebarMenuItem key={index}>
954
+ <SidebarMenuSkeleton />
955
+ </SidebarMenuItem>
956
+ ))}
957
+ </SidebarMenu>
958
+ ```
959
+
960
+ ## SidebarTrigger
961
+
962
+ Use the `SidebarTrigger` component to render a button that toggles the sidebar.
963
+
964
+ ```tsx showLineNumbers
965
+ import { useSidebar } from "@/components/ui/sidebar"
966
+
967
+ export function CustomTrigger() {
968
+ const { toggleSidebar } = useSidebar()
969
+
970
+ return <button onClick={toggleSidebar}>Toggle Sidebar</button>
971
+ }
972
+ ```
973
+
974
+ ## SidebarRail
975
+
976
+ The `SidebarRail` component is used to render a rail within a `Sidebar`. This rail can be used to toggle the sidebar.
977
+
978
+ ```tsx showLineNumbers
979
+ <Sidebar>
980
+ <SidebarHeader />
981
+ <SidebarContent>
982
+ <SidebarGroup />
983
+ </SidebarContent>
984
+ <SidebarFooter />
985
+ <SidebarRail />
986
+ </Sidebar>
987
+ ```
988
+
989
+ ## Controlled Sidebar
990
+
991
+ Use the `open` and `onOpenChange` props to control the sidebar.
992
+
993
+ ```tsx showLineNumbers
994
+ export function AppSidebar() {
995
+ const [open, setOpen] = React.useState(false)
996
+
997
+ return (
998
+ <SidebarProvider open={open} onOpenChange={setOpen}>
999
+ <Sidebar />
1000
+ </SidebarProvider>
1001
+ )
1002
+ }
1003
+ ```
1004
+
1005
+ ## Theming
1006
+
1007
+ We use the following CSS variables to theme the sidebar.
1008
+
1009
+ ```css
1010
+ :root {
1011
+ --sidebar: oklch(0.985 0 0);
1012
+ --sidebar-foreground: oklch(0.145 0 0);
1013
+ --sidebar-primary: oklch(0.205 0 0);
1014
+ --sidebar-primary-foreground: oklch(0.985 0 0);
1015
+ --sidebar-accent: oklch(0.97 0 0);
1016
+ --sidebar-accent-foreground: oklch(0.205 0 0);
1017
+ --sidebar-border: oklch(0.922 0 0);
1018
+ --sidebar-ring: oklch(0.708 0 0);
1019
+ }
1020
+
1021
+ .dark {
1022
+ --sidebar: oklch(0.205 0 0);
1023
+ --sidebar-foreground: oklch(0.985 0 0);
1024
+ --sidebar-primary: oklch(0.488 0.243 264.376);
1025
+ --sidebar-primary-foreground: oklch(0.985 0 0);
1026
+ --sidebar-accent: oklch(0.269 0 0);
1027
+ --sidebar-accent-foreground: oklch(0.985 0 0);
1028
+ --sidebar-border: oklch(1 0 0 / 10%);
1029
+ --sidebar-ring: oklch(0.439 0 0);
1030
+ }
1031
+ ```
1032
+
1033
+ ## Styling
1034
+
1035
+ Here are some tips for styling the sidebar based on different states.
1036
+
1037
+ ```tsx
1038
+ <Sidebar collapsible="icon">
1039
+ <SidebarContent>
1040
+ <SidebarGroup className="group-data-[collapsible=icon]:hidden" />
1041
+ </SidebarContent>
1042
+ </Sidebar>
1043
+ ```
1044
+
1045
+ ```tsx
1046
+ <SidebarMenuItem>
1047
+ <SidebarMenuButton />
1048
+ <SidebarMenuAction className="peer-data-[active=true]/menu-button:opacity-100" />
1049
+ </SidebarMenuItem>
1050
+ ```
1051
+
1052
+ ## RTL
1053
+
1054
+ To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
1055
+
1056
+ {/* prettier-ignore */}
1057
+ <Button asChild size="sm" className="mt-6">
1058
+ <a href="/view/base-nova/sidebar-rtl" target="_blank">View RTL Sidebar <ExternalLinkIcon /></a>
1059
+ </Button>
1060
+
1061
+ ## Changelog
1062
+
1063
+ ### RTL Support
1064
+
1065
+ If you're upgrading from a previous version of the `Sidebar` component, you'll need to apply the following updates to add RTL support:
1066
+
1067
+ <Steps>
1068
+
1069
+ <Step>Add `dir` prop to Sidebar component.</Step>
1070
+
1071
+ Add `dir` to the destructured props and pass it to `SheetContent` for mobile:
1072
+
1073
+ ```diff
1074
+ function Sidebar({
1075
+ side = "left",
1076
+ variant = "sidebar",
1077
+ collapsible = "offcanvas",
1078
+ className,
1079
+ children,
1080
+ + dir,
1081
+ ...props
1082
+ }: React.ComponentProps<"div"> & {
1083
+ side?: "left" | "right"
1084
+ variant?: "sidebar" | "floating" | "inset"
1085
+ collapsible?: "offcanvas" | "icon" | "none"
1086
+ }) {
1087
+ ```
1088
+
1089
+ Then pass it to `SheetContent` in the mobile view:
1090
+
1091
+ ```diff
1092
+ <Sheet open={openMobile} onOpenChange={setOpenMobile} {...props}>
1093
+ <SheetContent
1094
+ + dir={dir}
1095
+ data-sidebar="sidebar"
1096
+ data-slot="sidebar"
1097
+ data-mobile="true"
1098
+ ```
1099
+
1100
+ <Step>Add `data-side` attribute to sidebar container.</Step>
1101
+
1102
+ Add `data-side={side}` to the sidebar container element:
1103
+
1104
+ ```diff
1105
+ <div
1106
+ data-slot="sidebar-container"
1107
+ + data-side={side}
1108
+ className={cn(
1109
+ ```
1110
+
1111
+ <Step>Update sidebar container positioning classes.</Step>
1112
+
1113
+ Replace JavaScript ternary conditional classes with CSS data attribute selectors:
1114
+
1115
+ ```diff
1116
+ className={cn(
1117
+ - "fixed inset-y-0 z-10 hidden h-svh w-(--sidebar-width) transition-[left,right,width] duration-200 ease-linear md:flex",
1118
+ - side === "left"
1119
+ - ? "left-0 group-data-[collapsible=offcanvas]:left-[calc(var(--sidebar-width)*-1)]"
1120
+ - : "right-0 group-data-[collapsible=offcanvas]:right-[calc(var(--sidebar-width)*-1)]",
1121
+ + "fixed inset-y-0 z-10 hidden h-svh w-(--sidebar-width) transition-[left,right,width] duration-200 ease-linear md:flex data-[side=left]:left-0 data-[side=right]:right-0 data-[side=left]:group-data-[collapsible=offcanvas]:left-[calc(var(--sidebar-width)*-1)] data-[side=right]:group-data-[collapsible=offcanvas]:right-[calc(var(--sidebar-width)*-1)]",
1122
+ ```
1123
+
1124
+ <Step>Update SidebarRail positioning classes.</Step>
1125
+
1126
+ Update the `SidebarRail` component to use physical positioning for the rail:
1127
+
1128
+ ```diff
1129
+ className={cn(
1130
+ - "hover:after:bg-sidebar-border absolute inset-y-0 z-20 hidden w-4 -translate-x-1/2 transition-all ease-linear group-data-[side=left]:-end-4 group-data-[side=right]:start-0 after:absolute after:inset-y-0 after:start-1/2 after:w-[2px] sm:flex",
1131
+ + "hover:after:bg-sidebar-border absolute inset-y-0 z-20 hidden w-4 ltr:-translate-x-1/2 rtl:-translate-x-1/2 transition-all ease-linear group-data-[side=left]:-right-4 group-data-[side=right]:left-0 after:absolute after:inset-y-0 after:start-1/2 after:w-[2px] sm:flex",
1132
+ ```
1133
+
1134
+ <Step>Add RTL flip to SidebarTrigger icon.</Step>
1135
+
1136
+ Add `className="rtl:rotate-180"` to the icon in `SidebarTrigger` to flip it in RTL mode:
1137
+
1138
+ ```diff
1139
+ <Button ...>
1140
+ - <PanelLeftIcon />
1141
+ + <PanelLeftIcon className="rtl:rotate-180" />
1142
+ <span className="sr-only">Toggle Sidebar</span>
1143
+ </Button>
1144
+ ```
1145
+
1146
+ </Steps>
1147
+
1148
+ After applying these changes, you can use the `dir` prop to set the direction:
1149
+
1150
+ ```tsx
1151
+ <Sidebar dir="rtl" side="right">
1152
+ {/* ... */}
1153
+ </Sidebar>
1154
+ ```
1155
+
1156
+ The sidebar will correctly position itself and handle interactions in both LTR and RTL layouts.