skillfullstack 0.0.0-stage → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.skillsRegistry/catalog.json +231 -0
- package/AGENTS.md +89 -0
- package/README.md +210 -2
- package/bin/index.js +508 -0
- package/package.json +57 -4
- package/skills/backend/apiEngineering/SKILL.md +102 -0
- package/skills/backend/apiEngineering/evals/evalApiEngineering.py +81 -0
- package/skills/backend/apiEngineering/evals/fixtures/invalid/sampleInvalidOpenApi.json +40 -0
- package/skills/backend/apiEngineering/evals/fixtures/valid/sampleValidOpenApi.json +47 -0
- package/skills/backend/apiEngineering/policies/compatibility.md +42 -0
- package/skills/backend/apiEngineering/policies/mandatory.md +48 -0
- package/skills/backend/apiEngineering/policies/performance.md +39 -0
- package/skills/backend/apiEngineering/policies/security.md +36 -0
- package/skills/backend/apiEngineering/references/apiObservability.md +39 -0
- package/skills/backend/apiEngineering/references/apiReference.md +3 -0
- package/skills/backend/apiEngineering/references/apiSecurityOwasp.md +47 -0
- package/skills/backend/apiEngineering/references/contractCompatibility.md +26 -0
- package/skills/backend/apiEngineering/references/databaseTransactions.md +40 -0
- package/skills/backend/apiEngineering/references/distributedReliability.md +26 -0
- package/skills/backend/apiEngineering/references/multiTenancy.md +27 -0
- package/skills/backend/apiEngineering/references/openApi32Standards.md +58 -0
- package/skills/backend/apiEngineering/references/paginationVersioning.md +57 -0
- package/skills/backend/apiEngineering/references/responseStandards.md +94 -0
- package/skills/backend/apiEngineering/scripts/auditApiContract.py +123 -0
- package/skills/backend/apiEngineering/scripts/checkBreakingChanges.py +77 -0
- package/skills/backend/apiEngineering/scripts/generateResponseEnvelope.py +88 -0
- package/skills/backend/apiEngineering/templates/apiChecklist.md +27 -0
- package/skills/backend/apiEngineering/templates/openapi.yaml +125 -0
- package/skills/backend/apiEngineering/templates/problemDetails.json +44 -0
- package/skills/backend/databaseArchitecture/SKILL.md +118 -0
- package/skills/backend/databaseArchitecture/evals/evalDatabaseArchitecture.py +85 -0
- package/skills/backend/databaseArchitecture/evals/fixtures/dangerousMigration.sql +4 -0
- package/skills/backend/databaseArchitecture/evals/fixtures/invalidSchema.sql +23 -0
- package/skills/backend/databaseArchitecture/evals/fixtures/safeMigration.sql +3 -0
- package/skills/backend/databaseArchitecture/evals/fixtures/validSchema.sql +37 -0
- package/skills/backend/databaseArchitecture/policies/integrity.md +25 -0
- package/skills/backend/databaseArchitecture/policies/mandatory.md +32 -0
- package/skills/backend/databaseArchitecture/policies/migration.md +22 -0
- package/skills/backend/databaseArchitecture/policies/normalization.md +25 -0
- package/skills/backend/databaseArchitecture/policies/performance.md +26 -0
- package/skills/backend/databaseArchitecture/policies/recovery.md +23 -0
- package/skills/backend/databaseArchitecture/policies/security.md +26 -0
- package/skills/backend/databaseArchitecture/policies/tableCreationChecklist.md +70 -0
- package/skills/backend/databaseArchitecture/references/analyticsWarehousing.md +32 -0
- package/skills/backend/databaseArchitecture/references/apiReference.md +3 -0
- package/skills/backend/databaseArchitecture/references/backupDisasterRecovery.md +27 -0
- package/skills/backend/databaseArchitecture/references/dataModelingLifecycle.md +30 -0
- package/skills/backend/databaseArchitecture/references/databaseTaxonomy.md +32 -0
- package/skills/backend/databaseArchitecture/references/indexingOptimization.md +32 -0
- package/skills/backend/databaseArchitecture/references/normalizationTheory.md +61 -0
- package/skills/backend/databaseArchitecture/references/scalabilitySharding.md +37 -0
- package/skills/backend/databaseArchitecture/references/transactionConcurrency.md +39 -0
- package/skills/backend/databaseArchitecture/scripts/analyzeMigration.py +99 -0
- package/skills/backend/databaseArchitecture/scripts/auditDatabaseSchema.py +177 -0
- package/skills/backend/databaseArchitecture/scripts/inspectDatabaseIndexes.py +149 -0
- package/skills/backend/databaseArchitecture/templates/adrTemplate.md +32 -0
- package/skills/backend/databaseArchitecture/templates/databaseChecklist.md +29 -0
- package/skills/backend/databaseArchitecture/templates/migrationPlan.md +40 -0
- package/skills/backend/durableBackgroundJobs/SKILL.md +112 -0
- package/skills/backend/durableBackgroundJobs/evals/durableJobVerification.json +14 -0
- package/skills/backend/durableBackgroundJobs/references/apiReference.md +3 -0
- package/skills/backend/durableBackgroundJobs/references/durableStepPatterns.md +6 -0
- package/skills/backend/durableBackgroundJobs/references/idempotencyKeys.md +5 -0
- package/skills/backend/durableBackgroundJobs/scripts/testWorkflowDispatch.py +24 -0
- package/skills/backend/golangStandard/SKILL.md +155 -0
- package/skills/backend/golangStandard/evals/goVerification.json +14 -0
- package/skills/backend/golangStandard/references/apiReference.md +3 -0
- package/skills/backend/golangStandard/references/layoutGuide.md +26 -0
- package/skills/backend/golangStandard/references/slogPatterns.md +26 -0
- package/skills/backend/golangStandard/scripts/scaffoldGoModule.py +105 -0
- package/skills/backend/pythonStandard/SKILL.md +138 -0
- package/skills/backend/pythonStandard/evals/pythonVerification.json +14 -0
- package/skills/backend/pythonStandard/references/apiReference.md +3 -0
- package/skills/backend/pythonStandard/references/pydanticPatterns.md +16 -0
- package/skills/backend/pythonStandard/references/pyprojectSpecs.md +37 -0
- package/skills/backend/pythonStandard/scripts/scaffoldUvProject.py +79 -0
- package/skills/backend/upstash/SKILL.md +98 -0
- package/skills/backend/upstash/evals/upstashVerification.json +14 -0
- package/skills/backend/upstash/references/apiReference.md +3 -0
- package/skills/backend/upstash/references/qstashFlowControl.md +34 -0
- package/skills/backend/upstash/references/ratelimitPatterns.md +53 -0
- package/skills/backend/upstash/references/workflowPatterns.md +35 -0
- package/skills/backend/upstash/scripts/testRedisConnection.py +36 -0
- package/skills/cicdDevops/cicdPipeline/SKILL.md +148 -0
- package/skills/cicdDevops/cicdPipeline/evals/evalCicd.py +37 -0
- package/skills/cicdDevops/cicdPipeline/references/apiReference.md +3 -0
- package/skills/cicdDevops/cicdPipeline/references/cicdDeploymentPatterns.md +27 -0
- package/skills/cicdDevops/cicdPipeline/scripts/auditDockerfileSecurity.py +56 -0
- package/skills/dataAi/mcpServerDevelopment/SKILL.md +123 -0
- package/skills/dataAi/mcpServerDevelopment/evals/mcpVerification.json +14 -0
- package/skills/dataAi/mcpServerDevelopment/references/apiReference.md +3 -0
- package/skills/dataAi/mcpServerDevelopment/references/mcpClientConfigs.md +38 -0
- package/skills/dataAi/mcpServerDevelopment/references/toolSchemaDesign.md +6 -0
- package/skills/dataAi/mcpServerDevelopment/scripts/runFastMcpBoilerplate.py +36 -0
- package/skills/dataAi/ragPipelineProduction/SKILL.md +113 -0
- package/skills/dataAi/ragPipelineProduction/evals/ragVerification.json +14 -0
- package/skills/dataAi/ragPipelineProduction/references/apiReference.md +3 -0
- package/skills/dataAi/ragPipelineProduction/references/chunkingStrategies.md +10 -0
- package/skills/dataAi/ragPipelineProduction/references/rrfAlgorithm.md +13 -0
- package/skills/dataAi/ragPipelineProduction/scripts/runHybridRrfSearch.py +33 -0
- package/skills/devopsCloud/cloudflare/SKILL.md +282 -0
- package/skills/devopsCloud/cloudflare/assets/README.md +48 -0
- package/skills/devopsCloud/cloudflare/assets/ai/agents-sdk.md +118 -0
- package/skills/devopsCloud/cloudflare/assets/ai/ai-gateway.md +105 -0
- package/skills/devopsCloud/cloudflare/assets/ai/ai-search.md +129 -0
- package/skills/devopsCloud/cloudflare/assets/ai/workers-ai.md +127 -0
- package/skills/devopsCloud/cloudflare/assets/cli/c3.md +292 -0
- package/skills/devopsCloud/cloudflare/assets/cli/cf-cli.md +90 -0
- package/skills/devopsCloud/cloudflare/assets/cli/wrangler.md +43 -0
- package/skills/devopsCloud/cloudflare/assets/compute/cron-triggers.md +486 -0
- package/skills/devopsCloud/cloudflare/assets/compute/service-bindings.md +251 -0
- package/skills/devopsCloud/cloudflare/assets/compute/smart-placement.md +435 -0
- package/skills/devopsCloud/cloudflare/assets/compute/static-assets.md +220 -0
- package/skills/devopsCloud/cloudflare/assets/compute/workers.md +129 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/d1.md +105 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/durable-objects.md +122 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/hyperdrive.md +210 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/kv.md +198 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/queues.md +105 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/r2.md +105 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/vectorize.md +97 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/workflows.md +141 -0
- package/skills/devopsCloud/cloudflare/assets/llms.txt +143 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/cache-cdn.md +109 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/dns.md +71 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/rate-limiting.md +130 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/tunnels.md +57 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/waf.md +143 -0
- package/skills/devopsCloud/cloudflare/assets/troubleshooting/1xxx-errors.md +209 -0
- package/skills/devopsCloud/cloudflare/assets/troubleshooting/5xx-errors.md +111 -0
- package/skills/devopsCloud/cloudflare/assets/troubleshooting/http-status-codes.md +38 -0
- package/skills/devopsCloud/cloudflare/evals/evals.json +75 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/README.md +27 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/dynamic-routing.md +15 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/features.md +22 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/sdk-integration.md +19 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/troubleshooting.md +16 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/README.md +25 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/gotchas.md +13 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/bindings/README.md +16 -0
- package/skills/devopsCloud/cloudflare/references/bindings/api.md +19 -0
- package/skills/devopsCloud/cloudflare/references/bindings/configuration.md +20 -0
- package/skills/devopsCloud/cloudflare/references/bindings/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/bindings/patterns.md +20 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/README.md +18 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/api.md +12 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/configuration.md +12 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/patterns.md +12 -0
- package/skills/devopsCloud/cloudflare/references/cliComparison.md +93 -0
- package/skills/devopsCloud/cloudflare/references/containers/README.md +23 -0
- package/skills/devopsCloud/cloudflare/references/containers/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/containers/configuration.md +15 -0
- package/skills/devopsCloud/cloudflare/references/containers/gotchas.md +16 -0
- package/skills/devopsCloud/cloudflare/references/containers/patterns.md +18 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/README.md +20 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/gotchas.md +17 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/patterns.md +18 -0
- package/skills/devopsCloud/cloudflare/references/d1/README.md +15 -0
- package/skills/devopsCloud/cloudflare/references/d1/api.md +18 -0
- package/skills/devopsCloud/cloudflare/references/d1/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/d1/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/d1/patterns.md +21 -0
- package/skills/devopsCloud/cloudflare/references/frameworkCompatibility.md +110 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/README.md +28 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/api.md +26 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/configuration.md +34 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/gotchas.md +20 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/images/README.md +12 -0
- package/skills/devopsCloud/cloudflare/references/images/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/images/configuration.md +17 -0
- package/skills/devopsCloud/cloudflare/references/images/gotchas.md +16 -0
- package/skills/devopsCloud/cloudflare/references/images/patterns.md +16 -0
- package/skills/devopsCloud/cloudflare/references/kv/README.md +15 -0
- package/skills/devopsCloud/cloudflare/references/kv/api.md +18 -0
- package/skills/devopsCloud/cloudflare/references/kv/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/kv/gotchas.md +17 -0
- package/skills/devopsCloud/cloudflare/references/kv/patterns.md +21 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/README.md +22 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/patterns.md +19 -0
- package/skills/devopsCloud/cloudflare/references/observability/README.md +27 -0
- package/skills/devopsCloud/cloudflare/references/observability/api.md +20 -0
- package/skills/devopsCloud/cloudflare/references/observability/configuration.md +23 -0
- package/skills/devopsCloud/cloudflare/references/observability/gotchas.md +25 -0
- package/skills/devopsCloud/cloudflare/references/observability/patterns.md +14 -0
- package/skills/devopsCloud/cloudflare/references/pages/README.md +20 -0
- package/skills/devopsCloud/cloudflare/references/pages/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/pages/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/pages/gotchas.md +19 -0
- package/skills/devopsCloud/cloudflare/references/pages/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/README.md +20 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/configuration.md +14 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/gotchas.md +17 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/patterns.md +16 -0
- package/skills/devopsCloud/cloudflare/references/productSelectionMatrix.md +54 -0
- package/skills/devopsCloud/cloudflare/references/queues/README.md +24 -0
- package/skills/devopsCloud/cloudflare/references/queues/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/queues/configuration.md +20 -0
- package/skills/devopsCloud/cloudflare/references/queues/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/queues/patterns.md +21 -0
- package/skills/devopsCloud/cloudflare/references/r2/README.md +26 -0
- package/skills/devopsCloud/cloudflare/references/r2/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/r2/configuration.md +19 -0
- package/skills/devopsCloud/cloudflare/references/r2/gotchas.md +17 -0
- package/skills/devopsCloud/cloudflare/references/r2/patterns.md +18 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/README.md +22 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/api.md +21 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/configuration.md +25 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/gotchas.md +19 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/patterns.md +27 -0
- package/skills/devopsCloud/cloudflare/references/skill-feedback.md +41 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/README.md +21 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/patterns.md +17 -0
- package/skills/devopsCloud/cloudflare/references/stream/README.md +22 -0
- package/skills/devopsCloud/cloudflare/references/stream/api-live.md +18 -0
- package/skills/devopsCloud/cloudflare/references/stream/api.md +21 -0
- package/skills/devopsCloud/cloudflare/references/stream/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/stream/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/stream/patterns.md +22 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/README.md +21 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/configuration.md +15 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/gotchas.md +16 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/README.md +20 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/api.md +14 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/configuration.md +14 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/networking.md +14 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/README.md +22 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/api.md +18 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/configuration.md +19 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/patterns.md +24 -0
- package/skills/devopsCloud/cloudflare/references/waf/README.md +21 -0
- package/skills/devopsCloud/cloudflare/references/waf/api.md +17 -0
- package/skills/devopsCloud/cloudflare/references/waf/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/waf/gotchas.md +19 -0
- package/skills/devopsCloud/cloudflare/references/waf/patterns.md +17 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/README.md +24 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/patterns.md +14 -0
- package/skills/devopsCloud/cloudflare/references/workflows/README.md +23 -0
- package/skills/devopsCloud/cloudflare/references/workflows/api.md +17 -0
- package/skills/devopsCloud/cloudflare/references/workflows/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/workflows/gotchas.md +19 -0
- package/skills/devopsCloud/cloudflare/references/workflows/patterns.md +30 -0
- package/skills/devopsCloud/cloudflare/scripts/auditCloudflareProduction.py +95 -0
- package/skills/foundation/promptEvalTesting/SKILL.md +114 -0
- package/skills/foundation/promptEvalTesting/evals/promptEvalVerification.json +14 -0
- package/skills/foundation/promptEvalTesting/references/apiReference.md +3 -0
- package/skills/foundation/promptEvalTesting/references/evalMetricsCatalog.md +7 -0
- package/skills/foundation/promptEvalTesting/references/promptfooConfigSpecs.md +16 -0
- package/skills/foundation/promptEvalTesting/scripts/runPromptEvalSuite.py +29 -0
- package/skills/frontend/astro/SKILL.md +327 -0
- package/skills/frontend/astro/assets/README.md +71 -0
- package/skills/frontend/astro/assets/add-content-to-your-site/content-collections.md +1061 -0
- package/skills/frontend/astro/assets/add-content-to-your-site/data-fetching.md +109 -0
- package/skills/frontend/astro/assets/add-content-to-your-site/images.md +719 -0
- package/skills/frontend/astro/assets/add-content-to-your-site/markdown.md +725 -0
- package/skills/frontend/astro/assets/build-your-ui/components.md +402 -0
- package/skills/frontend/astro/assets/build-your-ui/fonts.md +437 -0
- package/skills/frontend/astro/assets/build-your-ui/front-end-frameworks.md +245 -0
- package/skills/frontend/astro/assets/build-your-ui/layouts.md +267 -0
- package/skills/frontend/astro/assets/build-your-ui/scripts-and-event-handling.md +229 -0
- package/skills/frontend/astro/assets/build-your-ui/styles-and-css.md +782 -0
- package/skills/frontend/astro/assets/build-your-ui/syntax-highlighting.md +269 -0
- package/skills/frontend/astro/assets/configuration/build-with-ai.md +389 -0
- package/skills/frontend/astro/assets/configuration/configuration-overview.md +122 -0
- package/skills/frontend/astro/assets/configuration/dev-toolbar.md +86 -0
- package/skills/frontend/astro/assets/configuration/editor-setup.md +166 -0
- package/skills/frontend/astro/assets/configuration/environment-variables.md +352 -0
- package/skills/frontend/astro/assets/configuration/typescript.md +379 -0
- package/skills/frontend/astro/assets/configuration/working-with-integrations.md +606 -0
- package/skills/frontend/astro/assets/reference/adapter-reference.md +1242 -0
- package/skills/frontend/astro/assets/reference/cli-reference.md +575 -0
- package/skills/frontend/astro/assets/reference/configuration-reference.md +3144 -0
- package/skills/frontend/astro/assets/reference/content-loader-reference.md +1682 -0
- package/skills/frontend/astro/assets/reference/directives-reference.md +324 -0
- package/skills/frontend/astro/assets/reference/image-service-reference.md +346 -0
- package/skills/frontend/astro/assets/reference/integrations-reference.md +2813 -0
- package/skills/frontend/astro/assets/reference/modules/astro-actions.md +604 -0
- package/skills/frontend/astro/assets/reference/modules/astro-app.md +460 -0
- package/skills/frontend/astro/assets/reference/modules/astro-assets.md +1657 -0
- package/skills/frontend/astro/assets/reference/modules/astro-config.md +395 -0
- package/skills/frontend/astro/assets/reference/modules/astro-content.md +720 -0
- package/skills/frontend/astro/assets/reference/modules/astro-env.md +46 -0
- package/skills/frontend/astro/assets/reference/modules/astro-fetch.md +346 -0
- package/skills/frontend/astro/assets/reference/modules/astro-hono.md +37 -0
- package/skills/frontend/astro/assets/reference/modules/astro-i18n.md +462 -0
- package/skills/frontend/astro/assets/reference/modules/astro-middleware.md +292 -0
- package/skills/frontend/astro/assets/reference/modules/astro-static-paths.md +74 -0
- package/skills/frontend/astro/assets/reference/modules/astro-transitions.md +595 -0
- package/skills/frontend/astro/assets/reference/modules/astro-zod.md +120 -0
- package/skills/frontend/astro/assets/reference/session-driver-reference.md +205 -0
- package/skills/frontend/astro/assets/routing-and-navigation/endpoints.md +251 -0
- package/skills/frontend/astro/assets/routing-and-navigation/internationalization.md +374 -0
- package/skills/frontend/astro/assets/routing-and-navigation/middleware.md +288 -0
- package/skills/frontend/astro/assets/routing-and-navigation/pages.md +205 -0
- package/skills/frontend/astro/assets/routing-and-navigation/prefetch.md +273 -0
- package/skills/frontend/astro/assets/routing-and-navigation/routing.md +760 -0
- package/skills/frontend/astro/assets/routing-and-navigation/view-transitions.md +792 -0
- package/skills/frontend/astro/assets/server-rendering/actions.md +770 -0
- package/skills/frontend/astro/assets/server-rendering/caching.md +255 -0
- package/skills/frontend/astro/assets/server-rendering/on-demand-rendering.md +289 -0
- package/skills/frontend/astro/assets/server-rendering/server-islands.md +126 -0
- package/skills/frontend/astro/assets/server-rendering/sessions.md +270 -0
- package/skills/frontend/astro/assets/start-a-new-project/develop-and-build.md +147 -0
- package/skills/frontend/astro/assets/start-a-new-project/installation.md +342 -0
- package/skills/frontend/astro/assets/start-a-new-project/project-structure.md +137 -0
- package/skills/frontend/astro/assets/upgrade-and-troubleshooting/testing.md +412 -0
- package/skills/frontend/astro/assets/upgrade-and-troubleshooting/troubleshooting.md +229 -0
- package/skills/frontend/astro/assets/upgrade-and-troubleshooting/upgrade-astro.md +205 -0
- package/skills/frontend/astro/assets/welcome/courses.md +46 -0
- package/skills/frontend/astro/assets/welcome/islands-architecture.md +135 -0
- package/skills/frontend/astro/assets/welcome/why-astro.md +90 -0
- package/skills/frontend/astro/evals/evals.json +66 -0
- package/skills/frontend/astro/references/contentCollections.md +164 -0
- package/skills/frontend/astro/references/islandsArchitecture.md +128 -0
- package/skills/frontend/astro/references/serverIslandsAndActions.md +187 -0
- package/skills/frontend/astro/scripts/auditAstroProduction.py +78 -0
- package/skills/frontend/generativeUi/SKILL.md +128 -0
- package/skills/frontend/generativeUi/evals/generativeUiVerification.json +14 -0
- package/skills/frontend/generativeUi/references/apiReference.md +3 -0
- package/skills/frontend/generativeUi/references/clientToolComponentMapping.md +8 -0
- package/skills/frontend/generativeUi/references/dataStreamProtocol.md +10 -0
- package/skills/frontend/generativeUi/scripts/generateUiComponentStub.py +46 -0
- package/skills/frontend/nextjs/SKILL.md +138 -0
- package/skills/frontend/nextjs/assets/README.md +67 -0
- package/skills/frontend/nextjs/assets/api-reference/cli/create-next-app.md +210 -0
- package/skills/frontend/nextjs/assets/api-reference/cli/next.md +484 -0
- package/skills/frontend/nextjs/assets/api-reference/components/font.md +952 -0
- package/skills/frontend/nextjs/assets/api-reference/components/form.md +387 -0
- package/skills/frontend/nextjs/assets/api-reference/components/image.md +1372 -0
- package/skills/frontend/nextjs/assets/api-reference/components/link.md +954 -0
- package/skills/frontend/nextjs/assets/api-reference/components/script.md +421 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-cache-private.md +211 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-cache-remote.md +652 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-cache.md +848 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-client.md +149 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-server.md +234 -0
- package/skills/frontend/nextjs/assets/api-reference/edge-runtime.md +188 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/default.md +80 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/dynamic-routes.md +417 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/error.md +361 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/forbidden.md +75 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/instrumentation-client.md +308 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/instrumentation.md +177 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/intercepting-routes.md +78 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/layout.md +803 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/loading.md +209 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/mdx-components.md +84 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/app-icons.md +302 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/manifest.md +90 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/opengraph-image.md +580 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/robots.md +234 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/sitemap.md +459 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/not-found.md +278 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/page.md +283 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/parallel-routes.md +517 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/proxy.md +857 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/public-folder.md +47 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-groups.md +40 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/dynamicParams.md +40 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/ensureStatic.md +195 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/instant.md +204 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/maxDuration.md +42 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/preferredRegion.md +55 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/prefetch.md +113 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/runtime.md +43 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route.md +772 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/src-folder.md +42 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/template.md +174 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/unauthorized.md +143 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/after.md +332 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/cacheLife.md +642 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/cacheTag.md +272 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/catchError.md +267 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/connection.md +114 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/cookies.md +349 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/draft-mode.md +173 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/fetch.md +141 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/forbidden.md +327 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-image-metadata.md +311 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-metadata.md +1510 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-sitemaps.md +102 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-static-params.md +606 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-viewport.md +347 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/headers.md +92 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/image-response.md +225 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/io.md +131 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/navigation.md +220 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/next-request.md +116 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/next-response.md +219 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/next-root-params.md +479 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/not-found.md +269 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/permanentRedirect.md +92 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/prefetch.md +202 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/redirect.md +255 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/refresh.md +91 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/revalidatePath.md +248 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/revalidateTag.md +175 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/unauthorized.md +389 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/unstable_cache.md +131 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/unstable_noStore.md +61 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/unstable_rethrow.md +79 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/updateTag.md +173 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-link-status.md +268 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-offline.md +222 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-params.md +102 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-pathname.md +189 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-report-web-vitals.md +175 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-router.md +214 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-search-params.md +416 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-selected-layout-segment.md +214 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-selected-layout-segments.md +116 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-server-inserted-html.md +145 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/userAgent.md +95 -0
- package/skills/frontend/nextjs/assets/api-reference/turbopack.md +552 -0
- package/skills/frontend/nextjs/assets/architecture/accessibility.md +47 -0
- package/skills/frontend/nextjs/assets/architecture/fast-refresh.md +122 -0
- package/skills/frontend/nextjs/assets/architecture/nextjs-compiler.md +376 -0
- package/skills/frontend/nextjs/assets/architecture/supported-browsers.md +146 -0
- package/skills/frontend/nextjs/assets/community/contribution-guide.md +459 -0
- package/skills/frontend/nextjs/assets/community/rspack.md +25 -0
- package/skills/frontend/nextjs/assets/getting-started/caching.md +626 -0
- package/skills/frontend/nextjs/assets/getting-started/css.md +336 -0
- package/skills/frontend/nextjs/assets/getting-started/deploying.md +115 -0
- package/skills/frontend/nextjs/assets/getting-started/error-handling.md +485 -0
- package/skills/frontend/nextjs/assets/getting-started/fetching-data.md +743 -0
- package/skills/frontend/nextjs/assets/getting-started/fonts.md +232 -0
- package/skills/frontend/nextjs/assets/getting-started/images.md +272 -0
- package/skills/frontend/nextjs/assets/getting-started/installation.md +446 -0
- package/skills/frontend/nextjs/assets/getting-started/layouts-and-pages.md +386 -0
- package/skills/frontend/nextjs/assets/getting-started/linking-and-navigating.md +475 -0
- package/skills/frontend/nextjs/assets/getting-started/metadata-and-og-images.md +370 -0
- package/skills/frontend/nextjs/assets/getting-started/mutating-data.md +679 -0
- package/skills/frontend/nextjs/assets/getting-started/project-structure.md +290 -0
- package/skills/frontend/nextjs/assets/getting-started/proxy.md +107 -0
- package/skills/frontend/nextjs/assets/getting-started/revalidating.md +241 -0
- package/skills/frontend/nextjs/assets/getting-started/route-handlers.md +233 -0
- package/skills/frontend/nextjs/assets/getting-started/server-and-client-components.md +683 -0
- package/skills/frontend/nextjs/assets/getting-started/upgrading.md +137 -0
- package/skills/frontend/nextjs/assets/glossary.md +315 -0
- package/skills/frontend/nextjs/evals/nextjsVerification.json +14 -0
- package/skills/frontend/nextjs/references/apiReference.md +3 -0
- package/skills/frontend/nextjs/references/dataAccessLayer.md +39 -0
- package/skills/frontend/nextjs/references/nextjsFeatureMap.md +276 -0
- package/skills/frontend/nextjs/references/productionChecklist.md +49 -0
- package/skills/frontend/nextjs/references/securityHeadersCsp.md +44 -0
- package/skills/frontend/nextjs/scripts/auditProductionReadiness.py +85 -0
- package/skills/frontend/shadcn-ui/SKILL.md +102 -0
- package/skills/frontend/shadcn-ui/assets/README.md +82 -0
- package/skills/frontend/shadcn-ui/assets/advanced/javascript.md +44 -0
- package/skills/frontend/shadcn-ui/assets/advanced/monorepo.md +254 -0
- package/skills/frontend/shadcn-ui/assets/advanced/react-19.md +166 -0
- package/skills/frontend/shadcn-ui/assets/advanced/tailwind-v4.md +333 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/chain-of-thought.md +519 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/chat.md +581 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/checkpoint.md +243 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/confirmation.md +382 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/context.md +188 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/file-tree.md +248 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/index.md +307 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/inline-citation.md +219 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/message.md +298 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/model-selector.md +368 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/plan.md +398 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/prompt-input.md +403 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/queue.md +517 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/reasoning.md +349 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/sources.md +303 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/stack-trace.md +514 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/subagent.md +551 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/suggestion.md +246 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/task.md +380 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/terminal.md +463 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/test-results.md +641 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/tool.md +915 -0
- package/skills/frontend/shadcn-ui/assets/components/accordion.md +490 -0
- package/skills/frontend/shadcn-ui/assets/components/alert-dialog.md +520 -0
- package/skills/frontend/shadcn-ui/assets/components/alert.md +351 -0
- package/skills/frontend/shadcn-ui/assets/components/aspect-ratio.md +206 -0
- package/skills/frontend/shadcn-ui/assets/components/attachment.md +715 -0
- package/skills/frontend/shadcn-ui/assets/components/avatar.md +581 -0
- package/skills/frontend/shadcn-ui/assets/components/badge.md +276 -0
- package/skills/frontend/shadcn-ui/assets/components/breadcrumb.md +556 -0
- package/skills/frontend/shadcn-ui/assets/components/bubble.md +706 -0
- package/skills/frontend/shadcn-ui/assets/components/button-group.md +969 -0
- package/skills/frontend/shadcn-ui/assets/components/button.md +523 -0
- package/skills/frontend/shadcn-ui/assets/components/calendar.md +959 -0
- package/skills/frontend/shadcn-ui/assets/components/card.md +684 -0
- package/skills/frontend/shadcn-ui/assets/components/carousel.md +643 -0
- package/skills/frontend/shadcn-ui/assets/components/chart.md +1295 -0
- package/skills/frontend/shadcn-ui/assets/components/checkbox.md +553 -0
- package/skills/frontend/shadcn-ui/assets/components/code-block.md +2041 -0
- package/skills/frontend/shadcn-ui/assets/components/collapsible.md +504 -0
- package/skills/frontend/shadcn-ui/assets/components/combobox.md +1102 -0
- package/skills/frontend/shadcn-ui/assets/components/command.md +682 -0
- package/skills/frontend/shadcn-ui/assets/components/context-menu.md +949 -0
- package/skills/frontend/shadcn-ui/assets/components/data-table.md +1667 -0
- package/skills/frontend/shadcn-ui/assets/components/date-picker.md +698 -0
- package/skills/frontend/shadcn-ui/assets/components/dialog.md +454 -0
- package/skills/frontend/shadcn-ui/assets/components/direction.md +205 -0
- package/skills/frontend/shadcn-ui/assets/components/drawer.md +806 -0
- package/skills/frontend/shadcn-ui/assets/components/dropdown-menu.md +1315 -0
- package/skills/frontend/shadcn-ui/assets/components/empty.md +562 -0
- package/skills/frontend/shadcn-ui/assets/components/field.md +1321 -0
- package/skills/frontend/shadcn-ui/assets/components/hover-card.md +342 -0
- package/skills/frontend/shadcn-ui/assets/components/index.md +82 -0
- package/skills/frontend/shadcn-ui/assets/components/input-group.md +980 -0
- package/skills/frontend/shadcn-ui/assets/components/input-otp.md +551 -0
- package/skills/frontend/shadcn-ui/assets/components/input.md +555 -0
- package/skills/frontend/shadcn-ui/assets/components/item.md +937 -0
- package/skills/frontend/shadcn-ui/assets/components/kbd.md +290 -0
- package/skills/frontend/shadcn-ui/assets/components/label.md +327 -0
- package/skills/frontend/shadcn-ui/assets/components/marker.md +445 -0
- package/skills/frontend/shadcn-ui/assets/components/menubar.md +804 -0
- package/skills/frontend/shadcn-ui/assets/components/message-scroller.md +2770 -0
- package/skills/frontend/shadcn-ui/assets/components/message.md +618 -0
- package/skills/frontend/shadcn-ui/assets/components/native-select.md +321 -0
- package/skills/frontend/shadcn-ui/assets/components/navigation-menu.md +568 -0
- package/skills/frontend/shadcn-ui/assets/components/pagination.md +425 -0
- package/skills/frontend/shadcn-ui/assets/components/popover.md +402 -0
- package/skills/frontend/shadcn-ui/assets/components/progress.md +240 -0
- package/skills/frontend/shadcn-ui/assets/components/questionnaire.md +2055 -0
- package/skills/frontend/shadcn-ui/assets/components/radio-group.md +440 -0
- package/skills/frontend/shadcn-ui/assets/components/resizable.md +302 -0
- package/skills/frontend/shadcn-ui/assets/components/scroll-area.md +226 -0
- package/skills/frontend/shadcn-ui/assets/components/select.md +647 -0
- package/skills/frontend/shadcn-ui/assets/components/separator.md +235 -0
- package/skills/frontend/shadcn-ui/assets/components/sheet.md +354 -0
- package/skills/frontend/shadcn-ui/assets/components/sidebar.md +1156 -0
- package/skills/frontend/shadcn-ui/assets/components/skeleton.md +217 -0
- package/skills/frontend/shadcn-ui/assets/components/slider.md +253 -0
- package/skills/frontend/shadcn-ui/assets/components/spinner.md +352 -0
- package/skills/frontend/shadcn-ui/assets/components/switch.md +296 -0
- package/skills/frontend/shadcn-ui/assets/components/table.md +572 -0
- package/skills/frontend/shadcn-ui/assets/components/tabs.md +425 -0
- package/skills/frontend/shadcn-ui/assets/components/textarea.md +218 -0
- package/skills/frontend/shadcn-ui/assets/components/toast.md +260 -0
- package/skills/frontend/shadcn-ui/assets/components/toggle-group.md +419 -0
- package/skills/frontend/shadcn-ui/assets/components/toggle.md +220 -0
- package/skills/frontend/shadcn-ui/assets/components/tooltip.md +332 -0
- package/skills/frontend/shadcn-ui/assets/components/trace.md +1890 -0
- package/skills/frontend/shadcn-ui/assets/components/typography.md +561 -0
- package/skills/frontend/shadcn-ui/assets/dark-mode/next.md +108 -0
- package/skills/frontend/shadcn-ui/assets/dark-mode/overview.md +75 -0
- package/skills/frontend/shadcn-ui/assets/dark-mode/vite.md +144 -0
- package/skills/frontend/shadcn-ui/assets/forms/next.md +716 -0
- package/skills/frontend/shadcn-ui/assets/forms/overview.md +60 -0
- package/skills/frontend/shadcn-ui/assets/forms/react-hook-form.md +2055 -0
- package/skills/frontend/shadcn-ui/assets/forms/tanstack-form.md +2236 -0
- package/skills/frontend/shadcn-ui/assets/installation/astro.md +252 -0
- package/skills/frontend/shadcn-ui/assets/installation/manual.md +255 -0
- package/skills/frontend/shadcn-ui/assets/installation/next.md +256 -0
- package/skills/frontend/shadcn-ui/assets/installation/react-router.md +226 -0
- package/skills/frontend/shadcn-ui/assets/installation/remix.md +52 -0
- package/skills/frontend/shadcn-ui/assets/installation/vite.md +314 -0
- package/skills/frontend/shadcn-ui/assets/mcp/mcp.md +338 -0
- package/skills/frontend/shadcn-ui/assets/overview/changelog.md +6 -0
- package/skills/frontend/shadcn-ui/assets/overview/cli.md +738 -0
- package/skills/frontend/shadcn-ui/assets/overview/components-json.md +379 -0
- package/skills/frontend/shadcn-ui/assets/overview/directory.md +74 -0
- package/skills/frontend/shadcn-ui/assets/overview/introduction.md +77 -0
- package/skills/frontend/shadcn-ui/assets/overview/skills.md +71 -0
- package/skills/frontend/shadcn-ui/assets/overview/theming.md +304 -0
- package/skills/frontend/shadcn-ui/assets/overview/typeset.md +242 -0
- package/skills/frontend/shadcn-ui/assets/registry/getting-started.md +648 -0
- package/skills/frontend/shadcn-ui/assets/registry/overview.md +90 -0
- package/skills/frontend/shadcn-ui/assets/registry/registry-item-json.md +483 -0
- package/skills/frontend/shadcn-ui/assets/registry/registry-json.md +178 -0
- package/skills/frontend/shadcn-ui/evals/componentVerification.json +19 -0
- package/skills/frontend/shadcn-ui/references/aiComponentsCatalog.md +51 -0
- package/skills/frontend/shadcn-ui/references/apiReference.md +3 -0
- package/skills/frontend/shadcn-ui/references/blocksCatalog.md +32 -0
- package/skills/frontend/shadcn-ui/references/cliCommands.md +47 -0
- package/skills/frontend/shadcn-ui/references/componentMarkdownSources.md +48 -0
- package/skills/frontend/shadcn-ui/scripts/fetchComponentDocs.py +43 -0
- package/skills/frontend/tsxReactStandard/SKILL.md +150 -0
- package/skills/frontend/tsxReactStandard/evals/tsxVerification.json +14 -0
- package/skills/frontend/tsxReactStandard/references/apiReference.md +3 -0
- package/skills/frontend/tsxReactStandard/references/discriminatedUnions.md +31 -0
- package/skills/frontend/tsxReactStandard/references/tsconfigStrict.md +36 -0
- package/skills/frontend/tsxReactStandard/scripts/validateTsxTypes.py +44 -0
- package/skills/gitVersionControl/gitWorkflow/SKILL.md +128 -0
- package/skills/gitVersionControl/gitWorkflow/assets/README.md +23 -0
- package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-environment.md +87 -0
- package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-formatting.md +156 -0
- package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-reference.md +2363 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/about-git.md +156 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/about-remote-repositories.md +65 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/associating-text-editors-with-git.md +93 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/caching-your-github-credentials.md +115 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/getting-changes-from-a-remote-repository.md +76 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/ignoring-files.md +51 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/managing-remote-repositories.md +231 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/pushing-commits-to-a-remote-repository.md +119 -0
- package/skills/gitVersionControl/gitWorkflow/evals/evalGitWorkflow.py +43 -0
- package/skills/gitVersionControl/gitWorkflow/references/apiReference.md +3 -0
- package/skills/gitVersionControl/gitWorkflow/references/branchingModels.md +32 -0
- package/skills/gitVersionControl/gitWorkflow/scripts/diagnoseGitGraph.py +68 -0
- package/skills/github/assets/README.md +39 -0
- package/skills/github/assets/cli/gh-environment.md +87 -0
- package/skills/github/assets/cli/gh-formatting.md +156 -0
- package/skills/github/assets/cli/gh-reference.md +2363 -0
- package/skills/github/assets/docs-api/github-docs-api.md +60 -0
- package/skills/github/assets/rest-api/actions-secrets.md +1272 -0
- package/skills/github/assets/rest-api/actions-variables.md +1247 -0
- package/skills/github/assets/rest-api/actions-workflow-runs.md +1697 -0
- package/skills/github/assets/rest-api/actions-workflows.md +348 -0
- package/skills/github/assets/rest-api/authenticating.md +174 -0
- package/skills/github/assets/rest-api/branches.md +727 -0
- package/skills/github/assets/rest-api/checks-runs.md +1013 -0
- package/skills/github/assets/rest-api/checks-suites.md +1142 -0
- package/skills/github/assets/rest-api/code-scanning.md +2957 -0
- package/skills/github/assets/rest-api/collaborators.md +547 -0
- package/skills/github/assets/rest-api/commits.md +957 -0
- package/skills/github/assets/rest-api/dependabot-alerts.md +895 -0
- package/skills/github/assets/rest-api/orgs.md +1172 -0
- package/skills/github/assets/rest-api/overview.md +875 -0
- package/skills/github/assets/rest-api/pull-reviews.md +722 -0
- package/skills/github/assets/rest-api/pulls.md +1605 -0
- package/skills/github/assets/rest-api/quickstart.md +344 -0
- package/skills/github/assets/rest-api/releases.md +650 -0
- package/skills/github/assets/rest-api/repos.md +2957 -0
- package/skills/github/assets/rest-api/rules.md +1507 -0
- package/skills/github/assets/rest-api/secret-scanning.md +947 -0
- package/skills/github/assets/rest-api/teams.md +1690 -0
- package/skills/github/githubAction/SKILL.md +159 -0
- package/skills/github/githubAction/assets/README.md +38 -0
- package/skills/github/githubAction/assets/reference/contexts.md +918 -0
- package/skills/github/githubAction/assets/reference/dependency-caching.md +393 -0
- package/skills/github/githubAction/assets/reference/events-that-trigger-workflows.md +1348 -0
- package/skills/github/githubAction/assets/reference/expressions.md +441 -0
- package/skills/github/githubAction/assets/reference/metadata-syntax.md +803 -0
- package/skills/github/githubAction/assets/reference/variables.md +149 -0
- package/skills/github/githubAction/assets/reference/workflow-cancellation.md +22 -0
- package/skills/github/githubAction/assets/reference/workflow-commands.md +1056 -0
- package/skills/github/githubAction/assets/reference/workflow-syntax.md +1721 -0
- package/skills/github/githubAction/assets/rest-api/secrets.md +1272 -0
- package/skills/github/githubAction/assets/rest-api/workflow-runs.md +1697 -0
- package/skills/github/githubAction/assets/rest-api/workflows.md +348 -0
- package/skills/github/githubAction/assets/starter-workflows/automation/stale.yml +27 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/blank.yml +36 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/docker-image.yml +18 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/go.yml +28 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/maven.yml +35 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/node.js.yml +31 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/python-app.yml +39 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/rust.yml +22 -0
- package/skills/github/githubAction/assets/starter-workflows/code-scanning/codeql.yml +97 -0
- package/skills/github/githubAction/evals/actionVerification.json +14 -0
- package/skills/github/githubAction/references/apiReference.md +3 -0
- package/skills/github/githubAction/references/workflowPatterns.md +81 -0
- package/skills/github/githubAction/scripts/validateWorkflowYaml.py +53 -0
- package/skills/github/githubQuality/SKILL.md +136 -0
- package/skills/github/githubQuality/assets/README.md +24 -0
- package/skills/github/githubQuality/assets/pull-requests/about-code-owners.md +178 -0
- package/skills/github/githubQuality/assets/pull-requests/about-merge-methods.md +48 -0
- package/skills/github/githubQuality/assets/pull-requests/creating-a-pull-request.md +170 -0
- package/skills/github/githubQuality/assets/pull-requests/giving-reviews.md +48 -0
- package/skills/github/githubQuality/assets/pull-requests/managing-a-merge-queue.md +134 -0
- package/skills/github/githubQuality/assets/pull-requests/merging-a-pull-request.md +101 -0
- package/skills/github/githubQuality/assets/pull-requests/resolving-reviews.md +59 -0
- package/skills/github/githubQuality/assets/pull-requests/status-checks.md +135 -0
- package/skills/github/githubQuality/assets/rest-api/checks-runs.md +1013 -0
- package/skills/github/githubQuality/assets/rest-api/checks-suites.md +1142 -0
- package/skills/github/githubQuality/assets/rest-api/commits.md +957 -0
- package/skills/github/githubQuality/assets/rest-api/pulls.md +1605 -0
- package/skills/github/githubQuality/assets/rest-api/reviews.md +722 -0
- package/skills/github/githubQuality/evals/qualityVerification.json +14 -0
- package/skills/github/githubQuality/references/apiReference.md +3 -0
- package/skills/github/githubQuality/references/codeownersExample.md +26 -0
- package/skills/github/githubQuality/references/prTemplate.md +20 -0
- package/skills/github/githubQuality/scripts/auditPrQuality.py +52 -0
- package/skills/github/githubSecurity/SKILL.md +170 -0
- package/skills/github/githubSecurity/assets/README.md +32 -0
- package/skills/github/githubSecurity/assets/code-scanning/code-scanning-alerts.md +133 -0
- package/skills/github/githubSecurity/assets/code-scanning/code-scanning.md +67 -0
- package/skills/github/githubSecurity/assets/code-scanning/codeql-code-scanning.md +79 -0
- package/skills/github/githubSecurity/assets/code-scanning/configure-code-scanning.md +121 -0
- package/skills/github/githubSecurity/assets/dependabot/about-the-dependabot-yml-file.md +74 -0
- package/skills/github/githubSecurity/assets/dependabot/dependabot-alerts.md +133 -0
- package/skills/github/githubSecurity/assets/dependabot/dependabot-security-updates.md +95 -0
- package/skills/github/githubSecurity/assets/dependabot/dependabot-version-updates.md +80 -0
- package/skills/github/githubSecurity/assets/rest-api/code-scanning.md +2957 -0
- package/skills/github/githubSecurity/assets/rest-api/dependabot-alerts.md +895 -0
- package/skills/github/githubSecurity/assets/rest-api/secret-scanning.md +947 -0
- package/skills/github/githubSecurity/assets/secret-scanning/enable-secret-scanning.md +59 -0
- package/skills/github/githubSecurity/assets/secret-scanning/secret-scanning.md +105 -0
- package/skills/github/githubSecurity/assets/security-advisories/github-advisory-database.md +148 -0
- package/skills/github/githubSecurity/evals/securityVerification.json +14 -0
- package/skills/github/githubSecurity/references/apiReference.md +3 -0
- package/skills/github/githubSecurity/references/codeqlAnalysis.yml +42 -0
- package/skills/github/githubSecurity/references/dependabotConfig.yml +27 -0
- package/skills/github/githubSecurity/scripts/auditRepoSecurity.py +47 -0
- package/skills/github/githubSetup/SKILL.md +137 -0
- package/skills/github/githubSetup/assets/README.md +40 -0
- package/skills/github/githubSetup/assets/branches/about-protected-branches.md +198 -0
- package/skills/github/githubSetup/assets/branches/changing-the-default-branch.md +49 -0
- package/skills/github/githubSetup/assets/branches/deleting-and-restoring-branches.md +44 -0
- package/skills/github/githubSetup/assets/branches/managing-a-branch-protection-rule.md +115 -0
- package/skills/github/githubSetup/assets/branches/renaming-a-branch.md +74 -0
- package/skills/github/githubSetup/assets/branches/viewing-branches-in-your-repository.md +30 -0
- package/skills/github/githubSetup/assets/repositories/about-repositories.md +127 -0
- package/skills/github/githubSetup/assets/repositories/cloning-a-repository.md +114 -0
- package/skills/github/githubSetup/assets/repositories/creating-a-new-repository.md +82 -0
- package/skills/github/githubSetup/assets/repositories/creating-a-repository-from-a-template.md +51 -0
- package/skills/github/githubSetup/assets/repositories/deleting-a-repository.md +34 -0
- package/skills/github/githubSetup/assets/repositories/managing-teams-and-people-with-access.md +69 -0
- package/skills/github/githubSetup/assets/repositories/renaming-a-repository.md +47 -0
- package/skills/github/githubSetup/assets/repositories/restoring-a-deleted-repository.md +61 -0
- package/skills/github/githubSetup/assets/repositories/setting-repository-visibility.md +137 -0
- package/skills/github/githubSetup/assets/rest-api/branches.md +727 -0
- package/skills/github/githubSetup/assets/rest-api/quickstart.md +344 -0
- package/skills/github/githubSetup/assets/rest-api/repos.md +2957 -0
- package/skills/github/githubSetup/assets/rulesets/about-rulesets.md +72 -0
- package/skills/github/githubSetup/assets/rulesets/available-rules-for-rulesets.md +383 -0
- package/skills/github/githubSetup/assets/rulesets/converting-branch-protections-to-rulesets.md +92 -0
- package/skills/github/githubSetup/assets/rulesets/creating-rulesets-for-a-repository.md +108 -0
- package/skills/github/githubSetup/assets/rulesets/managing-rulesets-for-a-repository.md +149 -0
- package/skills/github/githubSetup/assets/rulesets/troubleshooting-rules.md +122 -0
- package/skills/github/githubSetup/evals/setupVerification.json +14 -0
- package/skills/github/githubSetup/references/apiReference.md +3 -0
- package/skills/github/githubSetup/references/repoSettingsBlueprint.md +13 -0
- package/skills/github/githubSetup/references/rulesetTemplates.json +42 -0
- package/skills/github/githubSetup/scripts/configureRepoBaseline.py +46 -0
- package/skills/github/githubTeam/SKILL.md +115 -0
- package/skills/github/githubTeam/assets/README.md +21 -0
- package/skills/github/githubTeam/assets/organizations/about-organizations.md +69 -0
- package/skills/github/githubTeam/assets/organizations/repository-roles-for-an-organization.md +94 -0
- package/skills/github/githubTeam/assets/rest-api/collaborators.md +547 -0
- package/skills/github/githubTeam/assets/rest-api/orgs.md +1172 -0
- package/skills/github/githubTeam/assets/rest-api/teams.md +1690 -0
- package/skills/github/githubTeam/assets/teams/about-teams.md +82 -0
- package/skills/github/githubTeam/assets/teams/adding-members-to-a-team.md +55 -0
- package/skills/github/githubTeam/evals/teamVerification.json +14 -0
- package/skills/github/githubTeam/references/apiReference.md +3 -0
- package/skills/github/githubTeam/references/permissionMatrix.md +17 -0
- package/skills/github/githubTeam/references/reviewAssignment.md +17 -0
- package/skills/github/githubTeam/scripts/manageTeamSync.py +31 -0
- package/skills/securityQa/llmSecurityRedteaming/SKILL.md +86 -0
- package/skills/securityQa/llmSecurityRedteaming/evals/securityRedteamVerification.json +14 -0
- package/skills/securityQa/llmSecurityRedteaming/references/apiReference.md +3 -0
- package/skills/securityQa/llmSecurityRedteaming/references/jailbreakTaxonomy.md +6 -0
- package/skills/securityQa/llmSecurityRedteaming/references/owaspLlmTopTen.md +12 -0
- package/skills/securityQa/llmSecurityRedteaming/scripts/testPromptInjection.py +34 -0
- package/skills/softwareDevelopment/requirementsEngineering/SKILL.md +110 -0
- package/skills/softwareDevelopment/requirementsEngineering/evals/evalRequirements.py +33 -0
- package/skills/softwareDevelopment/requirementsEngineering/references/apiReference.md +3 -0
- package/skills/softwareDevelopment/requirementsEngineering/references/requirementsAnalysisModels.md +34 -0
- package/skills/softwareDevelopment/requirementsEngineering/scripts/validateUserStories.py +49 -0
- package/skills/testing/testDrivenDevelopment/SKILL.md +122 -0
- package/skills/testing/testDrivenDevelopment/evals/evalTdd.py +25 -0
- package/skills/testing/testDrivenDevelopment/references/apiReference.md +3 -0
- package/skills/testing/testDrivenDevelopment/references/testPyramidDoubles.md +35 -0
- package/skills/testing/testDrivenDevelopment/scripts/auditTestPyramid.py +58 -0
|
@@ -0,0 +1,2041 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Code Block
|
|
3
|
+
description: Displays code, terminal output and diffs with an optional header, line numbers and a copy button.
|
|
4
|
+
base: base
|
|
5
|
+
component: true
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
"use client"
|
|
10
|
+
|
|
11
|
+
import * as React from "react"
|
|
12
|
+
import { DownloadIcon, FileCodeIcon, WrapTextIcon } from "lucide-react"
|
|
13
|
+
|
|
14
|
+
import { useHighlightedCode } from "@/components/hooks/use-highlighted-code"
|
|
15
|
+
import { Button } from "@/components/ui/button"
|
|
16
|
+
import {
|
|
17
|
+
CodeBlock,
|
|
18
|
+
CodeBlockActions,
|
|
19
|
+
CodeBlockContent,
|
|
20
|
+
CodeBlockCopyButton,
|
|
21
|
+
CodeBlockHeader,
|
|
22
|
+
CodeBlockLine,
|
|
23
|
+
CodeBlockTitle,
|
|
24
|
+
} from "@/components/ui/code-block"
|
|
25
|
+
|
|
26
|
+
const code = `import { streamText } from "ai"
|
|
27
|
+
|
|
28
|
+
export async function POST(request: Request) {
|
|
29
|
+
const { messages } = await request.json()
|
|
30
|
+
|
|
31
|
+
const result = streamText({
|
|
32
|
+
model: "anthropic/claude-sonnet-4.5",
|
|
33
|
+
system: "You are a helpful assistant. Answer in one short paragraph.",
|
|
34
|
+
messages,
|
|
35
|
+
})
|
|
36
|
+
|
|
37
|
+
return result.toUIMessageStreamResponse()
|
|
38
|
+
}`
|
|
39
|
+
|
|
40
|
+
function download(value: string, filename: string) {
|
|
41
|
+
const url = URL.createObjectURL(new Blob([value], { type: "text/plain" }))
|
|
42
|
+
const link = document.createElement("a")
|
|
43
|
+
link.href = url
|
|
44
|
+
link.download = filename
|
|
45
|
+
link.click()
|
|
46
|
+
URL.revokeObjectURL(url)
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export function CodeBlockDemo() {
|
|
50
|
+
const [wrap, setWrap] = React.useState(false)
|
|
51
|
+
const lines = useHighlightedCode(code, "ts")
|
|
52
|
+
|
|
53
|
+
return (
|
|
54
|
+
<div className="w-full max-w-lg">
|
|
55
|
+
<CodeBlock>
|
|
56
|
+
<CodeBlockHeader>
|
|
57
|
+
<CodeBlockTitle>
|
|
58
|
+
<FileCodeIcon />
|
|
59
|
+
app/api/chat/route.ts
|
|
60
|
+
</CodeBlockTitle>
|
|
61
|
+
<CodeBlockActions>
|
|
62
|
+
<Button
|
|
63
|
+
variant="ghost"
|
|
64
|
+
size="icon-xs"
|
|
65
|
+
aria-label="Wrap lines"
|
|
66
|
+
aria-pressed={wrap}
|
|
67
|
+
className="aria-pressed:text-foreground"
|
|
68
|
+
onClick={() => setWrap(!wrap)}
|
|
69
|
+
>
|
|
70
|
+
<WrapTextIcon />
|
|
71
|
+
</Button>
|
|
72
|
+
<Button
|
|
73
|
+
variant="ghost"
|
|
74
|
+
size="icon-xs"
|
|
75
|
+
aria-label="Download"
|
|
76
|
+
onClick={() => download(code, "route.ts")}
|
|
77
|
+
>
|
|
78
|
+
<DownloadIcon />
|
|
79
|
+
</Button>
|
|
80
|
+
<CodeBlockCopyButton value={code} />
|
|
81
|
+
</CodeBlockActions>
|
|
82
|
+
</CodeBlockHeader>
|
|
83
|
+
<CodeBlockContent wrap={wrap} lineNumbers>
|
|
84
|
+
{lines.map((line, index) => (
|
|
85
|
+
<CodeBlockLine
|
|
86
|
+
key={index}
|
|
87
|
+
variant={index >= 5 && index <= 9 ? "highlighted" : "default"}
|
|
88
|
+
>
|
|
89
|
+
{line}
|
|
90
|
+
</CodeBlockLine>
|
|
91
|
+
))}
|
|
92
|
+
</CodeBlockContent>
|
|
93
|
+
</CodeBlock>
|
|
94
|
+
</div>
|
|
95
|
+
)
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
`CodeBlock` displays code, terminal output, logs and diffs. It has a header with a title and actions, line numbers, wrapping, diff and highlighted lines, and a small size for tool output in a [Trace](/docs/components/base/trace).
|
|
101
|
+
|
|
102
|
+
Syntax highlighting is optional and lives in a separate hook, so a block that only shows plain output stays small.
|
|
103
|
+
|
|
104
|
+
## Installation
|
|
105
|
+
|
|
106
|
+
<CodeTabs>
|
|
107
|
+
|
|
108
|
+
<TabsList>
|
|
109
|
+
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
110
|
+
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
111
|
+
</TabsList>
|
|
112
|
+
<TabsContent value="cli">
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
npx shadcn@latest add code-block
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
</TabsContent>
|
|
119
|
+
|
|
120
|
+
<TabsContent value="manual">
|
|
121
|
+
|
|
122
|
+
<Steps className="mb-0 pt-2">
|
|
123
|
+
|
|
124
|
+
<Step>Install the following dependencies:</Step>
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
npm install shiki
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
<Step>Install the required shadcn/ui dependencies:</Step>
|
|
131
|
+
|
|
132
|
+
```bash
|
|
133
|
+
npx shadcn@latest add button
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
<Step>Copy and paste the following code into your project.</Step>
|
|
137
|
+
|
|
138
|
+
<ComponentSource
|
|
139
|
+
name="code-block"
|
|
140
|
+
title="components/ui/code-block.tsx"
|
|
141
|
+
styleName="base-rhea"
|
|
142
|
+
/>
|
|
143
|
+
|
|
144
|
+
<ComponentSource
|
|
145
|
+
src="/registry/bases/base/hooks/use-highlighted-code.ts"
|
|
146
|
+
title="hooks/use-highlighted-code.ts"
|
|
147
|
+
styleName="base-rhea"
|
|
148
|
+
/>
|
|
149
|
+
|
|
150
|
+
<ComponentSource
|
|
151
|
+
src="/registry/bases/base/lib/highlighter.tsx"
|
|
152
|
+
title="lib/highlighter.tsx"
|
|
153
|
+
styleName="base-rhea"
|
|
154
|
+
/>
|
|
155
|
+
|
|
156
|
+
<Step>Update the import paths to match your project setup.</Step>
|
|
157
|
+
|
|
158
|
+
</Steps>
|
|
159
|
+
|
|
160
|
+
</TabsContent>
|
|
161
|
+
|
|
162
|
+
</CodeTabs>
|
|
163
|
+
|
|
164
|
+
`code-block` also installs `useHighlightedCode` for [syntax highlighting](#syntax-highlighting).
|
|
165
|
+
|
|
166
|
+
## Usage
|
|
167
|
+
|
|
168
|
+
```tsx showLineNumbers
|
|
169
|
+
import {
|
|
170
|
+
CodeBlock,
|
|
171
|
+
CodeBlockActions,
|
|
172
|
+
CodeBlockContent,
|
|
173
|
+
CodeBlockCopyButton,
|
|
174
|
+
CodeBlockFooter,
|
|
175
|
+
CodeBlockHeader,
|
|
176
|
+
CodeBlockLine,
|
|
177
|
+
CodeBlockTitle,
|
|
178
|
+
} from "@/components/ui/code-block"
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
```tsx showLineNumbers
|
|
182
|
+
<CodeBlock>
|
|
183
|
+
<CodeBlockHeader>
|
|
184
|
+
<CodeBlockTitle>Terminal</CodeBlockTitle>
|
|
185
|
+
<CodeBlockActions>
|
|
186
|
+
<CodeBlockCopyButton value={output} />
|
|
187
|
+
</CodeBlockActions>
|
|
188
|
+
</CodeBlockHeader>
|
|
189
|
+
<CodeBlockContent>{output}</CodeBlockContent>
|
|
190
|
+
</CodeBlock>
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
## Composition
|
|
194
|
+
|
|
195
|
+
```text
|
|
196
|
+
CodeBlock
|
|
197
|
+
├── CodeBlockHeader
|
|
198
|
+
│ ├── CodeBlockTitle
|
|
199
|
+
│ └── CodeBlockActions
|
|
200
|
+
│ └── CodeBlockCopyButton
|
|
201
|
+
├── CodeBlockActions (floating, when there is no header)
|
|
202
|
+
├── CodeBlockContent
|
|
203
|
+
│ └── CodeBlockLine
|
|
204
|
+
└── CodeBlockFooter
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
`CodeBlockContent` takes a string or a list of `CodeBlockLine`. Use lines when you need line variants or highlighted tokens.
|
|
208
|
+
|
|
209
|
+
## Features
|
|
210
|
+
|
|
211
|
+
- **It streams cheaply.** A string child renders as one text node, and the highlighter tokenizes only the new lines as code arrives.
|
|
212
|
+
- **It copies cleanly.** Line numbers and diff markers are left out of a selection, and blank lines survive the copy.
|
|
213
|
+
- **It reads left to right.** The content is always `dir="ltr"`. The header follows the page direction.
|
|
214
|
+
- **It highlights without WASM.** `useHighlightedCode` uses Shiki's JavaScript engine, loads each language on first use and renders ANSI colors in terminal output. On the server, `highlightCode` keeps Shiki out of the client bundle.
|
|
215
|
+
- **It fits where code shows up.** Use it in a message, a Markdown fence, a Trace line, Tabs, a Dialog or a `typeset` container.
|
|
216
|
+
- **It scrolls by keyboard.** The content is focusable, and floating actions show on focus as well as on hover.
|
|
217
|
+
|
|
218
|
+
## Basic
|
|
219
|
+
|
|
220
|
+
Pass a string to `CodeBlockContent`. It renders as one text node, so it stays cheap while output streams.
|
|
221
|
+
|
|
222
|
+
```tsx
|
|
223
|
+
import { CodeBlock, CodeBlockContent } from "@/components/ui/code-block"
|
|
224
|
+
|
|
225
|
+
const output = `$ pnpm build
|
|
226
|
+
> next build
|
|
227
|
+
|
|
228
|
+
✓ Compiled successfully in 4.2s
|
|
229
|
+
✓ Generating static pages (12/12)
|
|
230
|
+
|
|
231
|
+
Route (app) Size First Load JS
|
|
232
|
+
┌ ○ / 1.9 kB 112 kB
|
|
233
|
+
├ ○ /_not-found 993 B 103 kB
|
|
234
|
+
└ ƒ /api/chat 141 B 102 kB`
|
|
235
|
+
|
|
236
|
+
export function CodeBlockBasic() {
|
|
237
|
+
return (
|
|
238
|
+
<div className="w-full max-w-md">
|
|
239
|
+
<CodeBlock>
|
|
240
|
+
<CodeBlockContent>{output}</CodeBlockContent>
|
|
241
|
+
</CodeBlock>
|
|
242
|
+
</div>
|
|
243
|
+
)
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
## Header
|
|
249
|
+
|
|
250
|
+
`CodeBlockHeader` holds a `CodeBlockTitle` and `CodeBlockActions`. `CodeBlockCopyButton` copies its `value`.
|
|
251
|
+
|
|
252
|
+
```tsx
|
|
253
|
+
import { TerminalIcon } from "lucide-react"
|
|
254
|
+
|
|
255
|
+
import {
|
|
256
|
+
CodeBlock,
|
|
257
|
+
CodeBlockActions,
|
|
258
|
+
CodeBlockContent,
|
|
259
|
+
CodeBlockCopyButton,
|
|
260
|
+
CodeBlockHeader,
|
|
261
|
+
CodeBlockTitle,
|
|
262
|
+
} from "@/components/ui/code-block"
|
|
263
|
+
|
|
264
|
+
const command = "pnpm add ai @ai-sdk/react zod"
|
|
265
|
+
|
|
266
|
+
const output = `$ ${command}
|
|
267
|
+
Packages: +14
|
|
268
|
+
Progress: resolved 412, reused 398, downloaded 14, added 14, done
|
|
269
|
+
Done in 2.8s using pnpm v10.18.0`
|
|
270
|
+
|
|
271
|
+
export function CodeBlockHeaderExample() {
|
|
272
|
+
return (
|
|
273
|
+
<div className="w-full max-w-md">
|
|
274
|
+
<CodeBlock>
|
|
275
|
+
<CodeBlockHeader>
|
|
276
|
+
<CodeBlockTitle>
|
|
277
|
+
<TerminalIcon />
|
|
278
|
+
Terminal
|
|
279
|
+
</CodeBlockTitle>
|
|
280
|
+
<CodeBlockActions>
|
|
281
|
+
<CodeBlockCopyButton value={command} />
|
|
282
|
+
</CodeBlockActions>
|
|
283
|
+
</CodeBlockHeader>
|
|
284
|
+
<CodeBlockContent>{output}</CodeBlockContent>
|
|
285
|
+
</CodeBlock>
|
|
286
|
+
</div>
|
|
287
|
+
)
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
A long title truncates. To link the title to a file, wrap `CodeBlockTitle` in an anchor.
|
|
293
|
+
|
|
294
|
+
```tsx showLineNumbers
|
|
295
|
+
<CodeBlockHeader>
|
|
296
|
+
<a href="/files/route.ts">
|
|
297
|
+
<CodeBlockTitle>app/api/chat/route.ts</CodeBlockTitle>
|
|
298
|
+
</a>
|
|
299
|
+
</CodeBlockHeader>
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
## Actions
|
|
303
|
+
|
|
304
|
+
`CodeBlockActions` holds any number of buttons. For a wrap toggle, keep the state yourself and pass it to `wrap`.
|
|
305
|
+
|
|
306
|
+
```tsx
|
|
307
|
+
"use client"
|
|
308
|
+
|
|
309
|
+
import * as React from "react"
|
|
310
|
+
import { DownloadIcon, TerminalIcon, WrapTextIcon } from "lucide-react"
|
|
311
|
+
|
|
312
|
+
import { Button } from "@/components/ui/button"
|
|
313
|
+
import {
|
|
314
|
+
CodeBlock,
|
|
315
|
+
CodeBlockActions,
|
|
316
|
+
CodeBlockContent,
|
|
317
|
+
CodeBlockCopyButton,
|
|
318
|
+
CodeBlockHeader,
|
|
319
|
+
CodeBlockTitle,
|
|
320
|
+
} from "@/components/ui/code-block"
|
|
321
|
+
|
|
322
|
+
const output = `$ pnpm lint
|
|
323
|
+
apps/web/components/message-list.tsx
|
|
324
|
+
18:22 error 'messages' is possibly 'undefined'. Add a guard before calling map @typescript-eslint/no-unsafe-call
|
|
325
|
+
42:7 warning React Hook React.useEffect has a missing dependency: 'scrollToBottom' react-hooks/exhaustive-deps
|
|
326
|
+
|
|
327
|
+
✖ 2 problems (1 error, 1 warning)`
|
|
328
|
+
|
|
329
|
+
function download(value: string, filename: string) {
|
|
330
|
+
const url = URL.createObjectURL(new Blob([value], { type: "text/plain" }))
|
|
331
|
+
const link = document.createElement("a")
|
|
332
|
+
link.href = url
|
|
333
|
+
link.download = filename
|
|
334
|
+
link.click()
|
|
335
|
+
URL.revokeObjectURL(url)
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
export function CodeBlockActionsExample() {
|
|
339
|
+
const [wrap, setWrap] = React.useState(true)
|
|
340
|
+
|
|
341
|
+
return (
|
|
342
|
+
<div className="w-full max-w-md">
|
|
343
|
+
<CodeBlock>
|
|
344
|
+
<CodeBlockHeader>
|
|
345
|
+
<CodeBlockTitle>
|
|
346
|
+
<TerminalIcon />
|
|
347
|
+
Terminal
|
|
348
|
+
</CodeBlockTitle>
|
|
349
|
+
<CodeBlockActions>
|
|
350
|
+
<Button
|
|
351
|
+
variant="ghost"
|
|
352
|
+
size="icon-xs"
|
|
353
|
+
aria-label="Wrap lines"
|
|
354
|
+
aria-pressed={wrap}
|
|
355
|
+
className="aria-pressed:text-foreground"
|
|
356
|
+
onClick={() => setWrap(!wrap)}
|
|
357
|
+
>
|
|
358
|
+
<WrapTextIcon />
|
|
359
|
+
</Button>
|
|
360
|
+
<Button
|
|
361
|
+
variant="ghost"
|
|
362
|
+
size="icon-xs"
|
|
363
|
+
aria-label="Download"
|
|
364
|
+
onClick={() => download(output, "lint.log")}
|
|
365
|
+
>
|
|
366
|
+
<DownloadIcon />
|
|
367
|
+
</Button>
|
|
368
|
+
<CodeBlockCopyButton value={output} />
|
|
369
|
+
</CodeBlockActions>
|
|
370
|
+
</CodeBlockHeader>
|
|
371
|
+
<CodeBlockContent wrap={wrap}>{output}</CodeBlockContent>
|
|
372
|
+
</CodeBlock>
|
|
373
|
+
</div>
|
|
374
|
+
)
|
|
375
|
+
}
|
|
376
|
+
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
```tsx showLineNumbers
|
|
380
|
+
const [wrap, setWrap] = React.useState(false)
|
|
381
|
+
|
|
382
|
+
<CodeBlockActions>
|
|
383
|
+
<Button
|
|
384
|
+
variant="ghost"
|
|
385
|
+
size="icon-xs"
|
|
386
|
+
aria-label="Wrap lines"
|
|
387
|
+
aria-pressed={wrap}
|
|
388
|
+
onClick={() => setWrap(!wrap)}
|
|
389
|
+
>
|
|
390
|
+
<WrapTextIcon />
|
|
391
|
+
</Button>
|
|
392
|
+
<CodeBlockCopyButton value={output} />
|
|
393
|
+
</CodeBlockActions>
|
|
394
|
+
<CodeBlockContent wrap={wrap}>{output}</CodeBlockContent>
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
## Floating Actions
|
|
398
|
+
|
|
399
|
+
Without a header, put `CodeBlockActions` directly inside `CodeBlock`. The actions float at the top end and stay hidden until the block is hovered or focused. They always show on touch screens.
|
|
400
|
+
|
|
401
|
+
```tsx
|
|
402
|
+
import {
|
|
403
|
+
CodeBlock,
|
|
404
|
+
CodeBlockActions,
|
|
405
|
+
CodeBlockContent,
|
|
406
|
+
CodeBlockCopyButton,
|
|
407
|
+
} from "@/components/ui/code-block"
|
|
408
|
+
|
|
409
|
+
const output = `$ pnpm add ai @ai-sdk/react zod
|
|
410
|
+
Progress: resolved 412, reused 398, downloaded 14, added 14, done
|
|
411
|
+
dependencies:
|
|
412
|
+
+ @ai-sdk/react 3.0.12
|
|
413
|
+
+ ai 6.0.12
|
|
414
|
+
+ zod 4.1.12
|
|
415
|
+
Done in 2.8s using pnpm v10.18.0`
|
|
416
|
+
|
|
417
|
+
export function CodeBlockFloatingActions() {
|
|
418
|
+
return (
|
|
419
|
+
<div className="w-full max-w-md">
|
|
420
|
+
<CodeBlock>
|
|
421
|
+
<CodeBlockActions>
|
|
422
|
+
<CodeBlockCopyButton value={output} />
|
|
423
|
+
</CodeBlockActions>
|
|
424
|
+
<CodeBlockContent>{output}</CodeBlockContent>
|
|
425
|
+
</CodeBlock>
|
|
426
|
+
</div>
|
|
427
|
+
)
|
|
428
|
+
}
|
|
429
|
+
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
## Line Numbers
|
|
433
|
+
|
|
434
|
+
Add `lineNumbers` to `CodeBlockContent`. A string child is split into lines, and the numbers are not copied with a selection.
|
|
435
|
+
|
|
436
|
+
```tsx
|
|
437
|
+
import { CodeBlock, CodeBlockContent } from "@/components/ui/code-block"
|
|
438
|
+
|
|
439
|
+
const code = `{
|
|
440
|
+
"name": "chat",
|
|
441
|
+
"private": true,
|
|
442
|
+
"scripts": {
|
|
443
|
+
"dev": "next dev",
|
|
444
|
+
"build": "next build"
|
|
445
|
+
}
|
|
446
|
+
}`
|
|
447
|
+
|
|
448
|
+
export function CodeBlockLineNumbers() {
|
|
449
|
+
return (
|
|
450
|
+
<div className="w-full max-w-md">
|
|
451
|
+
<CodeBlock>
|
|
452
|
+
<CodeBlockContent lineNumbers>{code}</CodeBlockContent>
|
|
453
|
+
</CodeBlock>
|
|
454
|
+
</div>
|
|
455
|
+
)
|
|
456
|
+
}
|
|
457
|
+
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
## Start Line
|
|
461
|
+
|
|
462
|
+
Set `startLine` to number lines from a given line, for a snippet from the middle of a file. The gutter grows to fit the widest number.
|
|
463
|
+
|
|
464
|
+
```tsx
|
|
465
|
+
"use client"
|
|
466
|
+
|
|
467
|
+
import { useHighlightedCode } from "@/components/hooks/use-highlighted-code"
|
|
468
|
+
import {
|
|
469
|
+
CodeBlock,
|
|
470
|
+
CodeBlockContent,
|
|
471
|
+
CodeBlockHeader,
|
|
472
|
+
CodeBlockLine,
|
|
473
|
+
CodeBlockTitle,
|
|
474
|
+
} from "@/components/ui/code-block"
|
|
475
|
+
|
|
476
|
+
const code = ` if (!session) {
|
|
477
|
+
redirect("/login")
|
|
478
|
+
}
|
|
479
|
+
|
|
480
|
+
const projects = await db.project.findMany({
|
|
481
|
+
where: { ownerId: session.user.id },
|
|
482
|
+
orderBy: { updatedAt: "desc" },
|
|
483
|
+
})
|
|
484
|
+
|
|
485
|
+
return <ProjectList projects={projects} />
|
|
486
|
+
}`
|
|
487
|
+
|
|
488
|
+
export function CodeBlockStartLine() {
|
|
489
|
+
const lines = useHighlightedCode(code, "tsx")
|
|
490
|
+
|
|
491
|
+
return (
|
|
492
|
+
<div className="w-full max-w-md">
|
|
493
|
+
<CodeBlock>
|
|
494
|
+
<CodeBlockHeader>
|
|
495
|
+
<CodeBlockTitle>app/dashboard/page.tsx</CodeBlockTitle>
|
|
496
|
+
</CodeBlockHeader>
|
|
497
|
+
<CodeBlockContent lineNumbers startLine={995}>
|
|
498
|
+
{lines.map((line, index) => (
|
|
499
|
+
<CodeBlockLine key={index}>{line}</CodeBlockLine>
|
|
500
|
+
))}
|
|
501
|
+
</CodeBlockContent>
|
|
502
|
+
</CodeBlock>
|
|
503
|
+
</div>
|
|
504
|
+
)
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
```
|
|
508
|
+
|
|
509
|
+
## Wrap
|
|
510
|
+
|
|
511
|
+
Long lines scroll by default. Add `wrap` to wrap them, which suits tool output and error messages. To let the reader toggle it, see [Actions](#actions).
|
|
512
|
+
|
|
513
|
+
```tsx
|
|
514
|
+
import { CodeBlock, CodeBlockContent } from "@/components/ui/code-block"
|
|
515
|
+
|
|
516
|
+
const output = `Error: The model "anthropic/claude-sonnet-4.5" returned an error: Request too large. The prompt is 212,431 tokens and the context window is 200,000 tokens. Remove some messages or summarize the conversation and try again.`
|
|
517
|
+
|
|
518
|
+
export function CodeBlockWrap() {
|
|
519
|
+
return (
|
|
520
|
+
<div className="flex w-full max-w-md flex-col gap-4">
|
|
521
|
+
<CodeBlock>
|
|
522
|
+
<CodeBlockContent>{output}</CodeBlockContent>
|
|
523
|
+
</CodeBlock>
|
|
524
|
+
<CodeBlock>
|
|
525
|
+
<CodeBlockContent wrap>{output}</CodeBlockContent>
|
|
526
|
+
</CodeBlock>
|
|
527
|
+
</div>
|
|
528
|
+
)
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
```
|
|
532
|
+
|
|
533
|
+
## Highlighted Lines
|
|
534
|
+
|
|
535
|
+
Render each line as a `CodeBlockLine` and set `variant="highlighted"` on the lines to call out.
|
|
536
|
+
|
|
537
|
+
```tsx
|
|
538
|
+
import {
|
|
539
|
+
CodeBlock,
|
|
540
|
+
CodeBlockContent,
|
|
541
|
+
CodeBlockLine,
|
|
542
|
+
} from "@/components/ui/code-block"
|
|
543
|
+
|
|
544
|
+
const code = `export {
|
|
545
|
+
experimental: {
|
|
546
|
+
reactCompiler: true,
|
|
547
|
+
viewTransition: true,
|
|
548
|
+
},
|
|
549
|
+
images: {
|
|
550
|
+
remotePatterns: [{ hostname: "avatars.githubusercontent.com" }],
|
|
551
|
+
},
|
|
552
|
+
}`
|
|
553
|
+
|
|
554
|
+
const highlighted = [2, 3]
|
|
555
|
+
|
|
556
|
+
export function CodeBlockHighlightedLines() {
|
|
557
|
+
return (
|
|
558
|
+
<div className="w-full max-w-md">
|
|
559
|
+
<CodeBlock>
|
|
560
|
+
<CodeBlockContent lineNumbers>
|
|
561
|
+
{code.split("\n").map((line, index) => (
|
|
562
|
+
<CodeBlockLine
|
|
563
|
+
key={index}
|
|
564
|
+
variant={highlighted.includes(index) ? "highlighted" : "default"}
|
|
565
|
+
>
|
|
566
|
+
{line}
|
|
567
|
+
</CodeBlockLine>
|
|
568
|
+
))}
|
|
569
|
+
</CodeBlockContent>
|
|
570
|
+
</CodeBlock>
|
|
571
|
+
</div>
|
|
572
|
+
)
|
|
573
|
+
}
|
|
574
|
+
|
|
575
|
+
```
|
|
576
|
+
|
|
577
|
+
## Diff
|
|
578
|
+
|
|
579
|
+
Set `variant="added"` or `variant="removed"` on a `CodeBlockLine`. Each one adds a `+` or `−` marker.
|
|
580
|
+
|
|
581
|
+
```tsx
|
|
582
|
+
import {
|
|
583
|
+
CodeBlock,
|
|
584
|
+
CodeBlockActions,
|
|
585
|
+
CodeBlockContent,
|
|
586
|
+
CodeBlockCopyButton,
|
|
587
|
+
CodeBlockHeader,
|
|
588
|
+
CodeBlockLine,
|
|
589
|
+
CodeBlockTitle,
|
|
590
|
+
} from "@/components/ui/code-block"
|
|
591
|
+
|
|
592
|
+
const patch = ` export function Greeting({ name }: { name: string }) {
|
|
593
|
+
- return <p>Hello, {name}</p>
|
|
594
|
+
+ return <p className="text-sm text-muted-foreground">
|
|
595
|
+
+ Hello, {name}!
|
|
596
|
+
+ </p>
|
|
597
|
+
}`
|
|
598
|
+
|
|
599
|
+
function getVariant(line: string) {
|
|
600
|
+
if (line.startsWith("+")) {
|
|
601
|
+
return "added"
|
|
602
|
+
}
|
|
603
|
+
|
|
604
|
+
if (line.startsWith("-")) {
|
|
605
|
+
return "removed"
|
|
606
|
+
}
|
|
607
|
+
|
|
608
|
+
return "default"
|
|
609
|
+
}
|
|
610
|
+
|
|
611
|
+
export function CodeBlockDiff() {
|
|
612
|
+
return (
|
|
613
|
+
<div className="w-full max-w-md">
|
|
614
|
+
<CodeBlock>
|
|
615
|
+
<CodeBlockHeader>
|
|
616
|
+
<CodeBlockTitle>components/greeting.tsx</CodeBlockTitle>
|
|
617
|
+
<CodeBlockActions>
|
|
618
|
+
<CodeBlockCopyButton value={patch} />
|
|
619
|
+
</CodeBlockActions>
|
|
620
|
+
</CodeBlockHeader>
|
|
621
|
+
<CodeBlockContent>
|
|
622
|
+
{patch.split("\n").map((line, index) => (
|
|
623
|
+
<CodeBlockLine key={index} variant={getVariant(line)}>
|
|
624
|
+
{line.slice(1)}
|
|
625
|
+
</CodeBlockLine>
|
|
626
|
+
))}
|
|
627
|
+
</CodeBlockContent>
|
|
628
|
+
</CodeBlock>
|
|
629
|
+
</div>
|
|
630
|
+
)
|
|
631
|
+
}
|
|
632
|
+
|
|
633
|
+
```
|
|
634
|
+
|
|
635
|
+
## Height
|
|
636
|
+
|
|
637
|
+
Cap the height with a `max-h-*` class on `CodeBlockContent`. The content scrolls inside the block.
|
|
638
|
+
|
|
639
|
+
```tsx
|
|
640
|
+
import {
|
|
641
|
+
CodeBlock,
|
|
642
|
+
CodeBlockActions,
|
|
643
|
+
CodeBlockContent,
|
|
644
|
+
CodeBlockCopyButton,
|
|
645
|
+
CodeBlockHeader,
|
|
646
|
+
CodeBlockTitle,
|
|
647
|
+
} from "@/components/ui/code-block"
|
|
648
|
+
|
|
649
|
+
const logs = Array.from(
|
|
650
|
+
{ length: 40 },
|
|
651
|
+
(_, index) =>
|
|
652
|
+
`[${String(index + 1).padStart(2, "0")}] GET /api/chat 200 in ${12 + ((index * 7) % 40)}ms`
|
|
653
|
+
).join("\n")
|
|
654
|
+
|
|
655
|
+
export function CodeBlockHeight() {
|
|
656
|
+
return (
|
|
657
|
+
<div className="w-full max-w-md">
|
|
658
|
+
<CodeBlock>
|
|
659
|
+
<CodeBlockHeader>
|
|
660
|
+
<CodeBlockTitle>Logs</CodeBlockTitle>
|
|
661
|
+
<CodeBlockActions>
|
|
662
|
+
<CodeBlockCopyButton value={logs} />
|
|
663
|
+
</CodeBlockActions>
|
|
664
|
+
</CodeBlockHeader>
|
|
665
|
+
<CodeBlockContent className="max-h-48 scroll-fade-y">
|
|
666
|
+
{logs}
|
|
667
|
+
</CodeBlockContent>
|
|
668
|
+
</CodeBlock>
|
|
669
|
+
</div>
|
|
670
|
+
)
|
|
671
|
+
}
|
|
672
|
+
|
|
673
|
+
```
|
|
674
|
+
|
|
675
|
+
`CodeBlockContent` fades its edges with [`scroll-fade`](/docs/utils/scroll-fade) as it scrolls: left and right by default, top and bottom when it wraps. Add `scroll-fade-y` to a capped block that does not wrap.
|
|
676
|
+
|
|
677
|
+
## Show More
|
|
678
|
+
|
|
679
|
+
`CodeBlockFooter` is a slot below the content. For Show More, cap the content while it is collapsed and put a ghost `xs` `Button` in the footer.
|
|
680
|
+
|
|
681
|
+
```tsx
|
|
682
|
+
"use client"
|
|
683
|
+
|
|
684
|
+
import * as React from "react"
|
|
685
|
+
import { ChevronDownIcon } from "lucide-react"
|
|
686
|
+
|
|
687
|
+
import { useHighlightedCode } from "@/components/hooks/use-highlighted-code"
|
|
688
|
+
import { Button } from "@/components/ui/button"
|
|
689
|
+
import {
|
|
690
|
+
CodeBlock,
|
|
691
|
+
CodeBlockActions,
|
|
692
|
+
CodeBlockContent,
|
|
693
|
+
CodeBlockCopyButton,
|
|
694
|
+
CodeBlockFooter,
|
|
695
|
+
CodeBlockHeader,
|
|
696
|
+
CodeBlockLine,
|
|
697
|
+
CodeBlockTitle,
|
|
698
|
+
} from "@/components/ui/code-block"
|
|
699
|
+
|
|
700
|
+
const code = `"use client"
|
|
701
|
+
|
|
702
|
+
import * as React from "react"
|
|
703
|
+
import { useChat } from "@ai-sdk/react"
|
|
704
|
+
|
|
705
|
+
import { Button } from "@/components/ui/button"
|
|
706
|
+
import { Input } from "@/components/ui/input"
|
|
707
|
+
|
|
708
|
+
export function Chat() {
|
|
709
|
+
const [input, setInput] = React.useState("")
|
|
710
|
+
const { messages, sendMessage, status } = useChat()
|
|
711
|
+
|
|
712
|
+
return (
|
|
713
|
+
<div className="flex flex-col gap-4">
|
|
714
|
+
{messages.map((message) => (
|
|
715
|
+
<div key={message.id}>
|
|
716
|
+
{message.parts.map((part, index) =>
|
|
717
|
+
part.type === "text" ? <p key={index}>{part.text}</p> : null
|
|
718
|
+
)}
|
|
719
|
+
</div>
|
|
720
|
+
))}
|
|
721
|
+
<form
|
|
722
|
+
onSubmit={(event) => {
|
|
723
|
+
event.preventDefault()
|
|
724
|
+
sendMessage({ text: input })
|
|
725
|
+
setInput("")
|
|
726
|
+
}}
|
|
727
|
+
>
|
|
728
|
+
<Input value={input} onChange={(event) => setInput(event.target.value)} />
|
|
729
|
+
<Button disabled={status !== "ready"}>Send</Button>
|
|
730
|
+
</form>
|
|
731
|
+
</div>
|
|
732
|
+
)
|
|
733
|
+
}`
|
|
734
|
+
|
|
735
|
+
export function CodeBlockShowMore() {
|
|
736
|
+
const [expanded, setExpanded] = React.useState(false)
|
|
737
|
+
const lines = useHighlightedCode(code, "tsx")
|
|
738
|
+
const id = React.useId()
|
|
739
|
+
|
|
740
|
+
return (
|
|
741
|
+
<div className="w-full max-w-md">
|
|
742
|
+
<CodeBlock>
|
|
743
|
+
<CodeBlockHeader>
|
|
744
|
+
<CodeBlockTitle>components/chat.tsx</CodeBlockTitle>
|
|
745
|
+
<CodeBlockActions>
|
|
746
|
+
<CodeBlockCopyButton value={code} />
|
|
747
|
+
</CodeBlockActions>
|
|
748
|
+
</CodeBlockHeader>
|
|
749
|
+
<CodeBlockContent
|
|
750
|
+
id={id}
|
|
751
|
+
lineNumbers
|
|
752
|
+
className={
|
|
753
|
+
expanded ? undefined : "max-h-64 scroll-fade-y overflow-y-hidden"
|
|
754
|
+
}
|
|
755
|
+
>
|
|
756
|
+
{lines.map((line, index) => (
|
|
757
|
+
<CodeBlockLine key={index}>{line}</CodeBlockLine>
|
|
758
|
+
))}
|
|
759
|
+
</CodeBlockContent>
|
|
760
|
+
<CodeBlockFooter className="justify-center">
|
|
761
|
+
<Button
|
|
762
|
+
variant="ghost"
|
|
763
|
+
size="xs"
|
|
764
|
+
aria-expanded={expanded}
|
|
765
|
+
aria-controls={id}
|
|
766
|
+
onClick={() => setExpanded(!expanded)}
|
|
767
|
+
>
|
|
768
|
+
<ChevronDownIcon className="transition-transform in-aria-expanded:rotate-180" />
|
|
769
|
+
{expanded ? "Show less" : "Show more"}
|
|
770
|
+
</Button>
|
|
771
|
+
</CodeBlockFooter>
|
|
772
|
+
</CodeBlock>
|
|
773
|
+
</div>
|
|
774
|
+
)
|
|
775
|
+
}
|
|
776
|
+
|
|
777
|
+
```
|
|
778
|
+
|
|
779
|
+
```tsx showLineNumbers
|
|
780
|
+
const [expanded, setExpanded] = React.useState(false)
|
|
781
|
+
const id = React.useId()
|
|
782
|
+
|
|
783
|
+
<CodeBlockContent
|
|
784
|
+
id={id}
|
|
785
|
+
className={expanded ? undefined : "max-h-64 overflow-y-hidden scroll-fade-y"}
|
|
786
|
+
>
|
|
787
|
+
{code}
|
|
788
|
+
</CodeBlockContent>
|
|
789
|
+
<CodeBlockFooter className="justify-center">
|
|
790
|
+
<Button
|
|
791
|
+
variant="ghost"
|
|
792
|
+
size="xs"
|
|
793
|
+
aria-expanded={expanded}
|
|
794
|
+
aria-controls={id}
|
|
795
|
+
onClick={() => setExpanded(!expanded)}
|
|
796
|
+
>
|
|
797
|
+
{expanded ? "Show less" : "Show more"}
|
|
798
|
+
</Button>
|
|
799
|
+
</CodeBlockFooter>
|
|
800
|
+
```
|
|
801
|
+
|
|
802
|
+
### Max Height
|
|
803
|
+
|
|
804
|
+
To keep a long block from taking over the page, raise the cap instead of removing it. The expanded content scrolls, and the edges fade as you scroll.
|
|
805
|
+
|
|
806
|
+
```tsx
|
|
807
|
+
"use client"
|
|
808
|
+
|
|
809
|
+
import * as React from "react"
|
|
810
|
+
import { ChevronDownIcon } from "lucide-react"
|
|
811
|
+
|
|
812
|
+
import { useHighlightedCode } from "@/components/hooks/use-highlighted-code"
|
|
813
|
+
import { Button } from "@/components/ui/button"
|
|
814
|
+
import {
|
|
815
|
+
CodeBlock,
|
|
816
|
+
CodeBlockActions,
|
|
817
|
+
CodeBlockContent,
|
|
818
|
+
CodeBlockCopyButton,
|
|
819
|
+
CodeBlockFooter,
|
|
820
|
+
CodeBlockHeader,
|
|
821
|
+
CodeBlockLine,
|
|
822
|
+
CodeBlockTitle,
|
|
823
|
+
} from "@/components/ui/code-block"
|
|
824
|
+
|
|
825
|
+
const code = `"use client"
|
|
826
|
+
|
|
827
|
+
import * as React from "react"
|
|
828
|
+
import { useChat } from "@ai-sdk/react"
|
|
829
|
+
|
|
830
|
+
import { Button } from "@/components/ui/button"
|
|
831
|
+
import { Input } from "@/components/ui/input"
|
|
832
|
+
|
|
833
|
+
export function Chat() {
|
|
834
|
+
const [input, setInput] = React.useState("")
|
|
835
|
+
const { messages, sendMessage, status } = useChat()
|
|
836
|
+
|
|
837
|
+
return (
|
|
838
|
+
<div className="flex flex-col gap-4">
|
|
839
|
+
{messages.map((message) => (
|
|
840
|
+
<div key={message.id}>
|
|
841
|
+
{message.parts.map((part, index) =>
|
|
842
|
+
part.type === "text" ? <p key={index}>{part.text}</p> : null
|
|
843
|
+
)}
|
|
844
|
+
</div>
|
|
845
|
+
))}
|
|
846
|
+
<form
|
|
847
|
+
onSubmit={(event) => {
|
|
848
|
+
event.preventDefault()
|
|
849
|
+
sendMessage({ text: input })
|
|
850
|
+
setInput("")
|
|
851
|
+
}}
|
|
852
|
+
>
|
|
853
|
+
<Input value={input} onChange={(event) => setInput(event.target.value)} />
|
|
854
|
+
<Button disabled={status !== "ready"}>Send</Button>
|
|
855
|
+
</form>
|
|
856
|
+
</div>
|
|
857
|
+
)
|
|
858
|
+
}`
|
|
859
|
+
|
|
860
|
+
export function CodeBlockShowMoreScroll() {
|
|
861
|
+
const [expanded, setExpanded] = React.useState(false)
|
|
862
|
+
const lines = useHighlightedCode(code, "tsx")
|
|
863
|
+
const id = React.useId()
|
|
864
|
+
|
|
865
|
+
return (
|
|
866
|
+
<div className="w-full max-w-md">
|
|
867
|
+
<CodeBlock>
|
|
868
|
+
<CodeBlockHeader>
|
|
869
|
+
<CodeBlockTitle>components/chat.tsx</CodeBlockTitle>
|
|
870
|
+
<CodeBlockActions>
|
|
871
|
+
<CodeBlockCopyButton value={code} />
|
|
872
|
+
</CodeBlockActions>
|
|
873
|
+
</CodeBlockHeader>
|
|
874
|
+
<CodeBlockContent
|
|
875
|
+
id={id}
|
|
876
|
+
lineNumbers
|
|
877
|
+
className={
|
|
878
|
+
expanded
|
|
879
|
+
? "max-h-96 scroll-fade-y"
|
|
880
|
+
: "max-h-64 scroll-fade-y overflow-y-hidden"
|
|
881
|
+
}
|
|
882
|
+
>
|
|
883
|
+
{lines.map((line, index) => (
|
|
884
|
+
<CodeBlockLine key={index}>{line}</CodeBlockLine>
|
|
885
|
+
))}
|
|
886
|
+
</CodeBlockContent>
|
|
887
|
+
<CodeBlockFooter className="justify-center">
|
|
888
|
+
<Button
|
|
889
|
+
variant="ghost"
|
|
890
|
+
size="xs"
|
|
891
|
+
aria-expanded={expanded}
|
|
892
|
+
aria-controls={id}
|
|
893
|
+
onClick={() => setExpanded(!expanded)}
|
|
894
|
+
>
|
|
895
|
+
<ChevronDownIcon className="transition-transform in-aria-expanded:rotate-180" />
|
|
896
|
+
{expanded ? "Show less" : "Show more"}
|
|
897
|
+
</Button>
|
|
898
|
+
</CodeBlockFooter>
|
|
899
|
+
</CodeBlock>
|
|
900
|
+
</div>
|
|
901
|
+
)
|
|
902
|
+
}
|
|
903
|
+
|
|
904
|
+
```
|
|
905
|
+
|
|
906
|
+
## Size
|
|
907
|
+
|
|
908
|
+
Use `size="sm"` for tool and [Trace](#trace) output. It has tighter padding and `text-xs` text.
|
|
909
|
+
|
|
910
|
+
```tsx
|
|
911
|
+
import { TerminalIcon } from "lucide-react"
|
|
912
|
+
|
|
913
|
+
import {
|
|
914
|
+
CodeBlock,
|
|
915
|
+
CodeBlockActions,
|
|
916
|
+
CodeBlockContent,
|
|
917
|
+
CodeBlockCopyButton,
|
|
918
|
+
CodeBlockHeader,
|
|
919
|
+
CodeBlockTitle,
|
|
920
|
+
} from "@/components/ui/code-block"
|
|
921
|
+
|
|
922
|
+
const output = `$ pnpm add ai @ai-sdk/react zod
|
|
923
|
+
Progress: resolved 412, reused 398, downloaded 14, added 14, done
|
|
924
|
+
Done in 2.8s using pnpm v10.18.0`
|
|
925
|
+
|
|
926
|
+
export function CodeBlockSize() {
|
|
927
|
+
return (
|
|
928
|
+
<div className="flex w-full max-w-md flex-col gap-4">
|
|
929
|
+
<CodeBlock>
|
|
930
|
+
<CodeBlockHeader>
|
|
931
|
+
<CodeBlockTitle>
|
|
932
|
+
<TerminalIcon />
|
|
933
|
+
Terminal
|
|
934
|
+
</CodeBlockTitle>
|
|
935
|
+
<CodeBlockActions>
|
|
936
|
+
<CodeBlockCopyButton value={output} />
|
|
937
|
+
</CodeBlockActions>
|
|
938
|
+
</CodeBlockHeader>
|
|
939
|
+
<CodeBlockContent wrap>{output}</CodeBlockContent>
|
|
940
|
+
</CodeBlock>
|
|
941
|
+
<CodeBlock size="sm">
|
|
942
|
+
<CodeBlockHeader>
|
|
943
|
+
<CodeBlockTitle>
|
|
944
|
+
<TerminalIcon />
|
|
945
|
+
Terminal
|
|
946
|
+
</CodeBlockTitle>
|
|
947
|
+
<CodeBlockActions>
|
|
948
|
+
<CodeBlockCopyButton value={output} />
|
|
949
|
+
</CodeBlockActions>
|
|
950
|
+
</CodeBlockHeader>
|
|
951
|
+
<CodeBlockContent wrap>{output}</CodeBlockContent>
|
|
952
|
+
</CodeBlock>
|
|
953
|
+
</div>
|
|
954
|
+
)
|
|
955
|
+
}
|
|
956
|
+
|
|
957
|
+
```
|
|
958
|
+
|
|
959
|
+
## Destructive
|
|
960
|
+
|
|
961
|
+
Use `variant="destructive"` for errors and failed output.
|
|
962
|
+
|
|
963
|
+
```tsx
|
|
964
|
+
import {
|
|
965
|
+
CodeBlock,
|
|
966
|
+
CodeBlockActions,
|
|
967
|
+
CodeBlockContent,
|
|
968
|
+
CodeBlockCopyButton,
|
|
969
|
+
CodeBlockHeader,
|
|
970
|
+
CodeBlockTitle,
|
|
971
|
+
} from "@/components/ui/code-block"
|
|
972
|
+
|
|
973
|
+
const error = `TypeError: Cannot read properties of undefined (reading 'map')
|
|
974
|
+
at MessageList (components/message-list.tsx:18:22)
|
|
975
|
+
at renderWithHooks (react-dom.development.js:16305:18)`
|
|
976
|
+
|
|
977
|
+
export function CodeBlockDestructive() {
|
|
978
|
+
return (
|
|
979
|
+
<div className="w-full max-w-md">
|
|
980
|
+
<CodeBlock variant="destructive">
|
|
981
|
+
<CodeBlockHeader>
|
|
982
|
+
<CodeBlockTitle>Error</CodeBlockTitle>
|
|
983
|
+
<CodeBlockActions>
|
|
984
|
+
<CodeBlockCopyButton value={error} />
|
|
985
|
+
</CodeBlockActions>
|
|
986
|
+
</CodeBlockHeader>
|
|
987
|
+
<CodeBlockContent wrap>{error}</CodeBlockContent>
|
|
988
|
+
</CodeBlock>
|
|
989
|
+
</div>
|
|
990
|
+
)
|
|
991
|
+
}
|
|
992
|
+
|
|
993
|
+
```
|
|
994
|
+
|
|
995
|
+
## Trace
|
|
996
|
+
|
|
997
|
+
Put a `CodeBlock` with `size="sm"` in `TraceCollapsibleContent` for tool and terminal output. Add `wrap` and a `max-h-64` class to `CodeBlockContent` so long output wraps and scrolls inside the trace. The block sets its own text color, so `TraceCollapsibleContent` does not mute it.
|
|
998
|
+
|
|
999
|
+
```tsx
|
|
1000
|
+
import { TerminalIcon } from "lucide-react"
|
|
1001
|
+
|
|
1002
|
+
import { CodeBlock, CodeBlockContent } from "@/components/ui/code-block"
|
|
1003
|
+
import {
|
|
1004
|
+
Trace,
|
|
1005
|
+
TraceCollapsible,
|
|
1006
|
+
TraceCollapsibleContent,
|
|
1007
|
+
TraceCollapsibleTrigger,
|
|
1008
|
+
TraceIcon,
|
|
1009
|
+
TraceLine,
|
|
1010
|
+
TraceTitle,
|
|
1011
|
+
} from "@/components/ui/trace"
|
|
1012
|
+
|
|
1013
|
+
const output = `$ node --version
|
|
1014
|
+
v24.18.0`
|
|
1015
|
+
|
|
1016
|
+
const error = `$ pnpm dev
|
|
1017
|
+
Error: listen EADDRINUSE: address already in use :::3000
|
|
1018
|
+
at Server.setupListenHandle [as _listen2] (node:net:1908:16)`
|
|
1019
|
+
|
|
1020
|
+
export function CodeBlockTrace() {
|
|
1021
|
+
return (
|
|
1022
|
+
<div className="w-full max-w-md">
|
|
1023
|
+
<Trace>
|
|
1024
|
+
<TraceCollapsible defaultOpen>
|
|
1025
|
+
<TraceCollapsibleTrigger>
|
|
1026
|
+
<TraceLine>
|
|
1027
|
+
<TraceIcon>
|
|
1028
|
+
<TerminalIcon />
|
|
1029
|
+
</TraceIcon>
|
|
1030
|
+
<TraceTitle>Ran node --version</TraceTitle>
|
|
1031
|
+
</TraceLine>
|
|
1032
|
+
</TraceCollapsibleTrigger>
|
|
1033
|
+
<TraceCollapsibleContent>
|
|
1034
|
+
<CodeBlock size="sm">
|
|
1035
|
+
<CodeBlockContent wrap className="max-h-64">
|
|
1036
|
+
{output}
|
|
1037
|
+
</CodeBlockContent>
|
|
1038
|
+
</CodeBlock>
|
|
1039
|
+
</TraceCollapsibleContent>
|
|
1040
|
+
</TraceCollapsible>
|
|
1041
|
+
<TraceCollapsible defaultOpen>
|
|
1042
|
+
<TraceCollapsibleTrigger>
|
|
1043
|
+
<TraceLine status="error">
|
|
1044
|
+
<TraceIcon>
|
|
1045
|
+
<TerminalIcon />
|
|
1046
|
+
</TraceIcon>
|
|
1047
|
+
<TraceTitle>Failed to run pnpm dev</TraceTitle>
|
|
1048
|
+
</TraceLine>
|
|
1049
|
+
</TraceCollapsibleTrigger>
|
|
1050
|
+
<TraceCollapsibleContent>
|
|
1051
|
+
<CodeBlock size="sm" variant="destructive">
|
|
1052
|
+
<CodeBlockContent wrap className="max-h-64">
|
|
1053
|
+
{error}
|
|
1054
|
+
</CodeBlockContent>
|
|
1055
|
+
</CodeBlock>
|
|
1056
|
+
</TraceCollapsibleContent>
|
|
1057
|
+
</TraceCollapsible>
|
|
1058
|
+
</Trace>
|
|
1059
|
+
</div>
|
|
1060
|
+
)
|
|
1061
|
+
}
|
|
1062
|
+
|
|
1063
|
+
```
|
|
1064
|
+
|
|
1065
|
+
## Tabs
|
|
1066
|
+
|
|
1067
|
+
Show several files with [Tabs](/docs/components/base/tabs), one `CodeBlock` in each `TabsContent`.
|
|
1068
|
+
|
|
1069
|
+
```tsx
|
|
1070
|
+
"use client"
|
|
1071
|
+
|
|
1072
|
+
import { useHighlightedCode } from "@/components/hooks/use-highlighted-code"
|
|
1073
|
+
import {
|
|
1074
|
+
CodeBlock,
|
|
1075
|
+
CodeBlockActions,
|
|
1076
|
+
CodeBlockContent,
|
|
1077
|
+
CodeBlockCopyButton,
|
|
1078
|
+
CodeBlockHeader,
|
|
1079
|
+
CodeBlockLine,
|
|
1080
|
+
CodeBlockTitle,
|
|
1081
|
+
} from "@/components/ui/code-block"
|
|
1082
|
+
import {
|
|
1083
|
+
Tabs,
|
|
1084
|
+
TabsContent,
|
|
1085
|
+
TabsList,
|
|
1086
|
+
TabsTrigger,
|
|
1087
|
+
} from "@/components/ui/tabs"
|
|
1088
|
+
|
|
1089
|
+
const files = [
|
|
1090
|
+
{
|
|
1091
|
+
id: "route",
|
|
1092
|
+
title: "app/api/chat/route.ts",
|
|
1093
|
+
language: "ts",
|
|
1094
|
+
code: `import { streamText } from "ai"
|
|
1095
|
+
|
|
1096
|
+
export async function POST(request: Request) {
|
|
1097
|
+
const { messages } = await request.json()
|
|
1098
|
+
const result = streamText({ model: "anthropic/claude-sonnet-4.5", messages })
|
|
1099
|
+
|
|
1100
|
+
return result.toUIMessageStreamResponse()
|
|
1101
|
+
}`,
|
|
1102
|
+
},
|
|
1103
|
+
{
|
|
1104
|
+
id: "chat",
|
|
1105
|
+
title: "components/chat.tsx",
|
|
1106
|
+
language: "tsx",
|
|
1107
|
+
code: `"use client"
|
|
1108
|
+
|
|
1109
|
+
import { useChat } from "@ai-sdk/react"
|
|
1110
|
+
|
|
1111
|
+
export function Chat() {
|
|
1112
|
+
const { messages } = useChat()
|
|
1113
|
+
|
|
1114
|
+
return <MessageList messages={messages} />
|
|
1115
|
+
}`,
|
|
1116
|
+
},
|
|
1117
|
+
{
|
|
1118
|
+
id: "env",
|
|
1119
|
+
title: ".env.local",
|
|
1120
|
+
language: "bash",
|
|
1121
|
+
code: "AI_GATEWAY_API_KEY=your-api-key",
|
|
1122
|
+
},
|
|
1123
|
+
]
|
|
1124
|
+
|
|
1125
|
+
function FileCode({ code, language }: { code: string; language: string }) {
|
|
1126
|
+
const lines = useHighlightedCode(code, language)
|
|
1127
|
+
|
|
1128
|
+
return (
|
|
1129
|
+
<CodeBlockContent lineNumbers>
|
|
1130
|
+
{lines.map((line, index) => (
|
|
1131
|
+
<CodeBlockLine key={index}>{line}</CodeBlockLine>
|
|
1132
|
+
))}
|
|
1133
|
+
</CodeBlockContent>
|
|
1134
|
+
)
|
|
1135
|
+
}
|
|
1136
|
+
|
|
1137
|
+
export function CodeBlockTabs() {
|
|
1138
|
+
return (
|
|
1139
|
+
<Tabs defaultValue="route" className="w-full max-w-md">
|
|
1140
|
+
<TabsList>
|
|
1141
|
+
{files.map((file) => (
|
|
1142
|
+
<TabsTrigger key={file.id} value={file.id}>
|
|
1143
|
+
{file.title.split("/").at(-1)}
|
|
1144
|
+
</TabsTrigger>
|
|
1145
|
+
))}
|
|
1146
|
+
</TabsList>
|
|
1147
|
+
{files.map((file) => (
|
|
1148
|
+
<TabsContent key={file.id} value={file.id}>
|
|
1149
|
+
<CodeBlock>
|
|
1150
|
+
<CodeBlockHeader>
|
|
1151
|
+
<CodeBlockTitle>{file.title}</CodeBlockTitle>
|
|
1152
|
+
<CodeBlockActions>
|
|
1153
|
+
<CodeBlockCopyButton value={file.code} />
|
|
1154
|
+
</CodeBlockActions>
|
|
1155
|
+
</CodeBlockHeader>
|
|
1156
|
+
<FileCode code={file.code} language={file.language} />
|
|
1157
|
+
</CodeBlock>
|
|
1158
|
+
</TabsContent>
|
|
1159
|
+
))}
|
|
1160
|
+
</Tabs>
|
|
1161
|
+
)
|
|
1162
|
+
}
|
|
1163
|
+
|
|
1164
|
+
```
|
|
1165
|
+
|
|
1166
|
+
## Message
|
|
1167
|
+
|
|
1168
|
+
Put a `CodeBlock` between paragraphs inside a [Message](/docs/components/base/message).
|
|
1169
|
+
|
|
1170
|
+
```tsx
|
|
1171
|
+
"use client"
|
|
1172
|
+
|
|
1173
|
+
import { useHighlightedCode } from "@/components/hooks/use-highlighted-code"
|
|
1174
|
+
import { Bubble, BubbleContent } from "@/components/ui/bubble"
|
|
1175
|
+
import {
|
|
1176
|
+
CodeBlock,
|
|
1177
|
+
CodeBlockActions,
|
|
1178
|
+
CodeBlockContent,
|
|
1179
|
+
CodeBlockCopyButton,
|
|
1180
|
+
CodeBlockHeader,
|
|
1181
|
+
CodeBlockLine,
|
|
1182
|
+
CodeBlockTitle,
|
|
1183
|
+
} from "@/components/ui/code-block"
|
|
1184
|
+
import { Message, MessageContent } from "@/components/ui/message"
|
|
1185
|
+
|
|
1186
|
+
const code = `import { streamText } from "ai"
|
|
1187
|
+
|
|
1188
|
+
export async function POST(request: Request) {
|
|
1189
|
+
const { messages } = await request.json()
|
|
1190
|
+
|
|
1191
|
+
const result = streamText({
|
|
1192
|
+
model: "anthropic/claude-sonnet-4.5",
|
|
1193
|
+
messages,
|
|
1194
|
+
})
|
|
1195
|
+
|
|
1196
|
+
return result.toUIMessageStreamResponse()
|
|
1197
|
+
}`
|
|
1198
|
+
|
|
1199
|
+
export function CodeBlockChat() {
|
|
1200
|
+
const lines = useHighlightedCode(code, "ts")
|
|
1201
|
+
|
|
1202
|
+
return (
|
|
1203
|
+
<div className="flex w-full max-w-md flex-col gap-4 text-sm">
|
|
1204
|
+
<Message align="end">
|
|
1205
|
+
<MessageContent>
|
|
1206
|
+
<Bubble variant="muted">
|
|
1207
|
+
<BubbleContent>How do I stream a response?</BubbleContent>
|
|
1208
|
+
</Bubble>
|
|
1209
|
+
</MessageContent>
|
|
1210
|
+
</Message>
|
|
1211
|
+
<Message>
|
|
1212
|
+
<MessageContent className="gap-3">
|
|
1213
|
+
<p>Create a route handler that returns the stream:</p>
|
|
1214
|
+
<CodeBlock>
|
|
1215
|
+
<CodeBlockHeader>
|
|
1216
|
+
<CodeBlockTitle>app/api/chat/route.ts</CodeBlockTitle>
|
|
1217
|
+
<CodeBlockActions>
|
|
1218
|
+
<CodeBlockCopyButton value={code} />
|
|
1219
|
+
</CodeBlockActions>
|
|
1220
|
+
</CodeBlockHeader>
|
|
1221
|
+
<CodeBlockContent>
|
|
1222
|
+
{lines.map((line, index) => (
|
|
1223
|
+
<CodeBlockLine key={index}>{line}</CodeBlockLine>
|
|
1224
|
+
))}
|
|
1225
|
+
</CodeBlockContent>
|
|
1226
|
+
</CodeBlock>
|
|
1227
|
+
<p>The client reads it with useChat.</p>
|
|
1228
|
+
</MessageContent>
|
|
1229
|
+
</Message>
|
|
1230
|
+
</div>
|
|
1231
|
+
)
|
|
1232
|
+
}
|
|
1233
|
+
|
|
1234
|
+
```
|
|
1235
|
+
|
|
1236
|
+
## Typeset
|
|
1237
|
+
|
|
1238
|
+
A `CodeBlock` inside a [`typeset`](/docs/typeset) container keeps its own styles and gets the same space above as a paragraph.
|
|
1239
|
+
|
|
1240
|
+
```tsx
|
|
1241
|
+
"use client"
|
|
1242
|
+
|
|
1243
|
+
import { FileCodeIcon } from "lucide-react"
|
|
1244
|
+
|
|
1245
|
+
import { useHighlightedCode } from "@/components/hooks/use-highlighted-code"
|
|
1246
|
+
import {
|
|
1247
|
+
CodeBlock,
|
|
1248
|
+
CodeBlockActions,
|
|
1249
|
+
CodeBlockContent,
|
|
1250
|
+
CodeBlockCopyButton,
|
|
1251
|
+
CodeBlockHeader,
|
|
1252
|
+
CodeBlockLine,
|
|
1253
|
+
CodeBlockTitle,
|
|
1254
|
+
} from "@/components/ui/code-block"
|
|
1255
|
+
|
|
1256
|
+
const code = `import { streamText } from "ai"
|
|
1257
|
+
|
|
1258
|
+
export async function POST(request: Request) {
|
|
1259
|
+
const { messages } = await request.json()
|
|
1260
|
+
const result = streamText({ model: "anthropic/claude-sonnet-4.5", messages })
|
|
1261
|
+
|
|
1262
|
+
return result.toUIMessageStreamResponse()
|
|
1263
|
+
}`
|
|
1264
|
+
|
|
1265
|
+
export function CodeBlockTypeset() {
|
|
1266
|
+
const lines = useHighlightedCode(code, "ts")
|
|
1267
|
+
|
|
1268
|
+
return (
|
|
1269
|
+
<div className="typeset w-full max-w-md">
|
|
1270
|
+
<h3>Stream a response</h3>
|
|
1271
|
+
<p>
|
|
1272
|
+
Create a route handler that calls <code>streamText</code> and returns
|
|
1273
|
+
the stream to the client.
|
|
1274
|
+
</p>
|
|
1275
|
+
<CodeBlock>
|
|
1276
|
+
<CodeBlockHeader>
|
|
1277
|
+
<CodeBlockTitle>
|
|
1278
|
+
<FileCodeIcon />
|
|
1279
|
+
app/api/chat/route.ts
|
|
1280
|
+
</CodeBlockTitle>
|
|
1281
|
+
<CodeBlockActions>
|
|
1282
|
+
<CodeBlockCopyButton value={code} />
|
|
1283
|
+
</CodeBlockActions>
|
|
1284
|
+
</CodeBlockHeader>
|
|
1285
|
+
<CodeBlockContent lineNumbers>
|
|
1286
|
+
{lines.map((line, index) => (
|
|
1287
|
+
<CodeBlockLine key={index}>{line}</CodeBlockLine>
|
|
1288
|
+
))}
|
|
1289
|
+
</CodeBlockContent>
|
|
1290
|
+
</CodeBlock>
|
|
1291
|
+
<p>
|
|
1292
|
+
The <code>useChat</code> hook reads the stream on the client and renders
|
|
1293
|
+
the answer while it is written.
|
|
1294
|
+
</p>
|
|
1295
|
+
</div>
|
|
1296
|
+
)
|
|
1297
|
+
}
|
|
1298
|
+
|
|
1299
|
+
```
|
|
1300
|
+
|
|
1301
|
+
## RTL
|
|
1302
|
+
|
|
1303
|
+
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl). Code always reads left to right. The header follows the page direction.
|
|
1304
|
+
|
|
1305
|
+
```tsx
|
|
1306
|
+
"use client"
|
|
1307
|
+
|
|
1308
|
+
import { TerminalIcon } from "lucide-react"
|
|
1309
|
+
|
|
1310
|
+
import {
|
|
1311
|
+
useTranslation,
|
|
1312
|
+
type Translations,
|
|
1313
|
+
} from "@/components/language-selector"
|
|
1314
|
+
import { useHighlightedCode } from "@/components/hooks/use-highlighted-code"
|
|
1315
|
+
import {
|
|
1316
|
+
CodeBlock,
|
|
1317
|
+
CodeBlockActions,
|
|
1318
|
+
CodeBlockContent,
|
|
1319
|
+
CodeBlockCopyButton,
|
|
1320
|
+
CodeBlockHeader,
|
|
1321
|
+
CodeBlockLine,
|
|
1322
|
+
CodeBlockTitle,
|
|
1323
|
+
} from "@/components/ui/code-block"
|
|
1324
|
+
|
|
1325
|
+
const translations: Translations = {
|
|
1326
|
+
en: {
|
|
1327
|
+
dir: "ltr",
|
|
1328
|
+
values: {
|
|
1329
|
+
description: "Install the packages, then start the dev server.",
|
|
1330
|
+
title: "Terminal",
|
|
1331
|
+
},
|
|
1332
|
+
},
|
|
1333
|
+
ar: {
|
|
1334
|
+
dir: "rtl",
|
|
1335
|
+
values: {
|
|
1336
|
+
description: "ثبّت الحزم، ثم شغّل خادم التطوير.",
|
|
1337
|
+
title: "الطرفية",
|
|
1338
|
+
},
|
|
1339
|
+
},
|
|
1340
|
+
he: {
|
|
1341
|
+
dir: "rtl",
|
|
1342
|
+
values: {
|
|
1343
|
+
description: "התקן את החבילות, ואז הפעל את שרת הפיתוח.",
|
|
1344
|
+
title: "מסוף",
|
|
1345
|
+
},
|
|
1346
|
+
},
|
|
1347
|
+
}
|
|
1348
|
+
|
|
1349
|
+
const code = `pnpm add ai @ai-sdk/react zod
|
|
1350
|
+
pnpm dev`
|
|
1351
|
+
|
|
1352
|
+
export function CodeBlockRtl() {
|
|
1353
|
+
const { dir, t } = useTranslation(translations, "ar")
|
|
1354
|
+
const lines = useHighlightedCode(code, "bash")
|
|
1355
|
+
|
|
1356
|
+
return (
|
|
1357
|
+
<div className="flex w-full max-w-md flex-col gap-3 text-sm" dir={dir}>
|
|
1358
|
+
<p>{t.description}</p>
|
|
1359
|
+
<CodeBlock>
|
|
1360
|
+
<CodeBlockHeader>
|
|
1361
|
+
<CodeBlockTitle>
|
|
1362
|
+
<TerminalIcon />
|
|
1363
|
+
{t.title}
|
|
1364
|
+
</CodeBlockTitle>
|
|
1365
|
+
<CodeBlockActions>
|
|
1366
|
+
<CodeBlockCopyButton value={code} />
|
|
1367
|
+
</CodeBlockActions>
|
|
1368
|
+
</CodeBlockHeader>
|
|
1369
|
+
<CodeBlockContent lineNumbers>
|
|
1370
|
+
{lines.map((line, index) => (
|
|
1371
|
+
<CodeBlockLine key={index}>{line}</CodeBlockLine>
|
|
1372
|
+
))}
|
|
1373
|
+
</CodeBlockContent>
|
|
1374
|
+
</CodeBlock>
|
|
1375
|
+
</div>
|
|
1376
|
+
)
|
|
1377
|
+
}
|
|
1378
|
+
|
|
1379
|
+
```
|
|
1380
|
+
|
|
1381
|
+
## Syntax Highlighting
|
|
1382
|
+
|
|
1383
|
+
`useHighlightedCode` highlights with [Shiki](https://shiki.style) and returns one React node per line for `CodeBlockLine`.
|
|
1384
|
+
|
|
1385
|
+
```tsx
|
|
1386
|
+
"use client"
|
|
1387
|
+
|
|
1388
|
+
import { useHighlightedCode } from "@/components/hooks/use-highlighted-code"
|
|
1389
|
+
import {
|
|
1390
|
+
CodeBlock,
|
|
1391
|
+
CodeBlockContent,
|
|
1392
|
+
CodeBlockHeader,
|
|
1393
|
+
CodeBlockLine,
|
|
1394
|
+
CodeBlockTitle,
|
|
1395
|
+
} from "@/components/ui/code-block"
|
|
1396
|
+
|
|
1397
|
+
const code = `{
|
|
1398
|
+
"location": "San Francisco",
|
|
1399
|
+
"temperature": 18,
|
|
1400
|
+
"unit": "celsius",
|
|
1401
|
+
"conditions": ["fog", "wind"]
|
|
1402
|
+
}`
|
|
1403
|
+
|
|
1404
|
+
export function CodeBlockHighlighting() {
|
|
1405
|
+
const lines = useHighlightedCode(code, "json")
|
|
1406
|
+
|
|
1407
|
+
return (
|
|
1408
|
+
<div className="w-full max-w-md">
|
|
1409
|
+
<CodeBlock>
|
|
1410
|
+
<CodeBlockHeader>
|
|
1411
|
+
<CodeBlockTitle>getWeather output</CodeBlockTitle>
|
|
1412
|
+
</CodeBlockHeader>
|
|
1413
|
+
<CodeBlockContent>
|
|
1414
|
+
{lines.map((line, index) => (
|
|
1415
|
+
<CodeBlockLine key={index}>{line}</CodeBlockLine>
|
|
1416
|
+
))}
|
|
1417
|
+
</CodeBlockContent>
|
|
1418
|
+
</CodeBlock>
|
|
1419
|
+
</div>
|
|
1420
|
+
)
|
|
1421
|
+
}
|
|
1422
|
+
|
|
1423
|
+
```
|
|
1424
|
+
|
|
1425
|
+
```tsx showLineNumbers
|
|
1426
|
+
const lines = useHighlightedCode(code, "json")
|
|
1427
|
+
|
|
1428
|
+
<CodeBlock>
|
|
1429
|
+
<CodeBlockContent>
|
|
1430
|
+
{lines.map((line, index) => (
|
|
1431
|
+
<CodeBlockLine key={index}>{line}</CodeBlockLine>
|
|
1432
|
+
))}
|
|
1433
|
+
</CodeBlockContent>
|
|
1434
|
+
</CodeBlock>
|
|
1435
|
+
```
|
|
1436
|
+
|
|
1437
|
+
Shiki uses its JavaScript regex engine, so there is no WASM to load.
|
|
1438
|
+
|
|
1439
|
+
### Languages
|
|
1440
|
+
|
|
1441
|
+
Each language loads the first time it is used. Edit the list in `lib/highlighter.tsx`. A language that is not in the list renders as plain text.
|
|
1442
|
+
|
|
1443
|
+
```tsx
|
|
1444
|
+
"use client"
|
|
1445
|
+
|
|
1446
|
+
import { useHighlightedCode } from "@/components/hooks/use-highlighted-code"
|
|
1447
|
+
import {
|
|
1448
|
+
CodeBlock,
|
|
1449
|
+
CodeBlockContent,
|
|
1450
|
+
CodeBlockHeader,
|
|
1451
|
+
CodeBlockLine,
|
|
1452
|
+
CodeBlockTitle,
|
|
1453
|
+
} from "@/components/ui/code-block"
|
|
1454
|
+
|
|
1455
|
+
const samples = [
|
|
1456
|
+
{
|
|
1457
|
+
language: "css",
|
|
1458
|
+
title: "app/globals.css",
|
|
1459
|
+
code: `@import "tailwindcss";
|
|
1460
|
+
|
|
1461
|
+
:root {
|
|
1462
|
+
--radius: 0.625rem;
|
|
1463
|
+
}`,
|
|
1464
|
+
},
|
|
1465
|
+
{
|
|
1466
|
+
language: "python",
|
|
1467
|
+
title: "main.py",
|
|
1468
|
+
code: `def greet(name: str) -> str:
|
|
1469
|
+
return f"Hello, {name}!"`,
|
|
1470
|
+
},
|
|
1471
|
+
{
|
|
1472
|
+
language: "text",
|
|
1473
|
+
title: "notes.txt",
|
|
1474
|
+
code: "A language that is not in the list renders as plain text.",
|
|
1475
|
+
},
|
|
1476
|
+
]
|
|
1477
|
+
|
|
1478
|
+
function Sample({ code, language }: { code: string; language: string }) {
|
|
1479
|
+
const lines = useHighlightedCode(code, language)
|
|
1480
|
+
|
|
1481
|
+
return (
|
|
1482
|
+
<CodeBlockContent>
|
|
1483
|
+
{lines.map((line, index) => (
|
|
1484
|
+
<CodeBlockLine key={index}>{line}</CodeBlockLine>
|
|
1485
|
+
))}
|
|
1486
|
+
</CodeBlockContent>
|
|
1487
|
+
)
|
|
1488
|
+
}
|
|
1489
|
+
|
|
1490
|
+
export function CodeBlockLanguages() {
|
|
1491
|
+
return (
|
|
1492
|
+
<div className="flex w-full max-w-md flex-col gap-4">
|
|
1493
|
+
{samples.map((sample) => (
|
|
1494
|
+
<CodeBlock key={sample.language}>
|
|
1495
|
+
<CodeBlockHeader>
|
|
1496
|
+
<CodeBlockTitle>{sample.title}</CodeBlockTitle>
|
|
1497
|
+
</CodeBlockHeader>
|
|
1498
|
+
<Sample code={sample.code} language={sample.language} />
|
|
1499
|
+
</CodeBlock>
|
|
1500
|
+
))}
|
|
1501
|
+
</div>
|
|
1502
|
+
)
|
|
1503
|
+
}
|
|
1504
|
+
|
|
1505
|
+
```
|
|
1506
|
+
|
|
1507
|
+
The list ships with `bash`, `css`, `diff`, `html`, `javascript`, `json`, `jsx`, `markdown`, `python`, `sql`, `tsx`, `typescript` and `yaml`, plus aliases such as `ts`, `js`, `sh` and `yml`.
|
|
1508
|
+
|
|
1509
|
+
### Terminal Output
|
|
1510
|
+
|
|
1511
|
+
Pass `"ansi"` as the language to render the colors in terminal output. Without it, escape codes show as text.
|
|
1512
|
+
|
|
1513
|
+
```tsx
|
|
1514
|
+
"use client"
|
|
1515
|
+
|
|
1516
|
+
import { TerminalIcon } from "lucide-react"
|
|
1517
|
+
|
|
1518
|
+
import { useHighlightedCode } from "@/components/hooks/use-highlighted-code"
|
|
1519
|
+
import {
|
|
1520
|
+
CodeBlock,
|
|
1521
|
+
CodeBlockActions,
|
|
1522
|
+
CodeBlockContent,
|
|
1523
|
+
CodeBlockCopyButton,
|
|
1524
|
+
CodeBlockHeader,
|
|
1525
|
+
CodeBlockLine,
|
|
1526
|
+
CodeBlockTitle,
|
|
1527
|
+
} from "@/components/ui/code-block"
|
|
1528
|
+
|
|
1529
|
+
const output = `$ pnpm test
|
|
1530
|
+
\x1b[32m✓\x1b[39m src/format.test.ts \x1b[2m(4 tests)\x1b[22m
|
|
1531
|
+
\x1b[32m✓\x1b[39m src/parse.test.ts \x1b[2m(7 tests)\x1b[22m
|
|
1532
|
+
\x1b[31m✗\x1b[39m src/stream.test.ts \x1b[2m(3 tests | 1 failed)\x1b[22m
|
|
1533
|
+
|
|
1534
|
+
\x1b[31mAssertionError: expected 'hello' to be 'hello world'\x1b[39m
|
|
1535
|
+
|
|
1536
|
+
Tests \x1b[31m1 failed\x1b[39m | \x1b[32m13 passed\x1b[39m (14)`
|
|
1537
|
+
|
|
1538
|
+
export function CodeBlockAnsi() {
|
|
1539
|
+
const lines = useHighlightedCode(output, "ansi")
|
|
1540
|
+
|
|
1541
|
+
return (
|
|
1542
|
+
<div className="w-full max-w-md">
|
|
1543
|
+
<CodeBlock>
|
|
1544
|
+
<CodeBlockHeader>
|
|
1545
|
+
<CodeBlockTitle>
|
|
1546
|
+
<TerminalIcon />
|
|
1547
|
+
Terminal
|
|
1548
|
+
</CodeBlockTitle>
|
|
1549
|
+
<CodeBlockActions>
|
|
1550
|
+
<CodeBlockCopyButton value={output.replace(/\x1b\[[\d;]*m/g, "")} />
|
|
1551
|
+
</CodeBlockActions>
|
|
1552
|
+
</CodeBlockHeader>
|
|
1553
|
+
<CodeBlockContent wrap>
|
|
1554
|
+
{lines.map((line, index) => (
|
|
1555
|
+
<CodeBlockLine key={index}>{line}</CodeBlockLine>
|
|
1556
|
+
))}
|
|
1557
|
+
</CodeBlockContent>
|
|
1558
|
+
</CodeBlock>
|
|
1559
|
+
</div>
|
|
1560
|
+
)
|
|
1561
|
+
}
|
|
1562
|
+
|
|
1563
|
+
```
|
|
1564
|
+
|
|
1565
|
+
ANSI colors do not carry from one line to the next.
|
|
1566
|
+
|
|
1567
|
+
### Server Rendering
|
|
1568
|
+
|
|
1569
|
+
`highlightCode` is async and works in a Server Component, so Shiki stays out of the client bundle.
|
|
1570
|
+
|
|
1571
|
+
```tsx showLineNumbers
|
|
1572
|
+
import { highlightCode } from "@/lib/highlighter"
|
|
1573
|
+
|
|
1574
|
+
export async function ServerCode({ code }: { code: string }) {
|
|
1575
|
+
const lines = (await highlightCode(code, "tsx")) ?? code.split("\n")
|
|
1576
|
+
|
|
1577
|
+
return (
|
|
1578
|
+
<CodeBlock>
|
|
1579
|
+
<CodeBlockContent lineNumbers>
|
|
1580
|
+
{lines.map((line, index) => (
|
|
1581
|
+
<CodeBlockLine key={index}>{line}</CodeBlockLine>
|
|
1582
|
+
))}
|
|
1583
|
+
</CodeBlockContent>
|
|
1584
|
+
</CodeBlock>
|
|
1585
|
+
)
|
|
1586
|
+
}
|
|
1587
|
+
```
|
|
1588
|
+
|
|
1589
|
+
### Streaming
|
|
1590
|
+
|
|
1591
|
+
While the code streams, the hook tokenizes only the new lines, starting where the last line left off. Lines that did not change keep the same nodes, so React skips them.
|
|
1592
|
+
|
|
1593
|
+
```tsx
|
|
1594
|
+
"use client"
|
|
1595
|
+
|
|
1596
|
+
import * as React from "react"
|
|
1597
|
+
import { RotateCcwIcon } from "lucide-react"
|
|
1598
|
+
|
|
1599
|
+
import { useHighlightedCode } from "@/components/hooks/use-highlighted-code"
|
|
1600
|
+
import { Button } from "@/components/ui/button"
|
|
1601
|
+
import {
|
|
1602
|
+
CodeBlock,
|
|
1603
|
+
CodeBlockActions,
|
|
1604
|
+
CodeBlockContent,
|
|
1605
|
+
CodeBlockCopyButton,
|
|
1606
|
+
CodeBlockHeader,
|
|
1607
|
+
CodeBlockLine,
|
|
1608
|
+
CodeBlockTitle,
|
|
1609
|
+
} from "@/components/ui/code-block"
|
|
1610
|
+
|
|
1611
|
+
const blocks: {
|
|
1612
|
+
title?: string
|
|
1613
|
+
language: string
|
|
1614
|
+
code: string
|
|
1615
|
+
lineNumbers?: boolean
|
|
1616
|
+
highlight?: number[]
|
|
1617
|
+
diff?: boolean
|
|
1618
|
+
}[] = [
|
|
1619
|
+
{
|
|
1620
|
+
title: "hooks/use-debounce.ts",
|
|
1621
|
+
language: "ts",
|
|
1622
|
+
lineNumbers: true,
|
|
1623
|
+
code: `export function useDebounce<T>(value: T, delay = 300) {
|
|
1624
|
+
const [debounced, setDebounced] = React.useState(value)
|
|
1625
|
+
|
|
1626
|
+
React.useEffect(() => {
|
|
1627
|
+
const timeout = setTimeout(() => setDebounced(value), delay)
|
|
1628
|
+
return () => clearTimeout(timeout)
|
|
1629
|
+
}, [value, delay])
|
|
1630
|
+
|
|
1631
|
+
return debounced
|
|
1632
|
+
}`,
|
|
1633
|
+
},
|
|
1634
|
+
{
|
|
1635
|
+
language: "bash",
|
|
1636
|
+
code: "pnpm dlx shadcn@latest add code-block",
|
|
1637
|
+
},
|
|
1638
|
+
{
|
|
1639
|
+
title: "components/search.tsx",
|
|
1640
|
+
language: "tsx",
|
|
1641
|
+
lineNumbers: true,
|
|
1642
|
+
diff: true,
|
|
1643
|
+
code: ` export function Search() {
|
|
1644
|
+
const [query, setQuery] = React.useState("")
|
|
1645
|
+
- const results = useSearch(query)
|
|
1646
|
+
+ const debounced = useDebounce(query, 300)
|
|
1647
|
+
+ const results = useSearch(debounced)
|
|
1648
|
+
|
|
1649
|
+
return <SearchResults results={results} />
|
|
1650
|
+
}`,
|
|
1651
|
+
},
|
|
1652
|
+
{
|
|
1653
|
+
title: "app/api/chat/route.ts",
|
|
1654
|
+
language: "ts",
|
|
1655
|
+
lineNumbers: true,
|
|
1656
|
+
highlight: [5, 6, 7, 8],
|
|
1657
|
+
code: `import { streamText } from "ai"
|
|
1658
|
+
|
|
1659
|
+
export async function POST(request: Request) {
|
|
1660
|
+
const { messages } = await request.json()
|
|
1661
|
+
|
|
1662
|
+
const result = streamText({
|
|
1663
|
+
model: "anthropic/claude-sonnet-4.5",
|
|
1664
|
+
messages,
|
|
1665
|
+
})
|
|
1666
|
+
|
|
1667
|
+
return result.toUIMessageStreamResponse()
|
|
1668
|
+
}`,
|
|
1669
|
+
},
|
|
1670
|
+
{
|
|
1671
|
+
title: ".env.local",
|
|
1672
|
+
language: "bash",
|
|
1673
|
+
code: "AI_GATEWAY_API_KEY=your-api-key",
|
|
1674
|
+
},
|
|
1675
|
+
]
|
|
1676
|
+
|
|
1677
|
+
// Where each block starts in the stream.
|
|
1678
|
+
const offsets = blocks.map((_, index) =>
|
|
1679
|
+
blocks.slice(0, index).reduce((total, block) => total + block.code.length, 0)
|
|
1680
|
+
)
|
|
1681
|
+
const total = blocks.reduce((sum, block) => sum + block.code.length, 0)
|
|
1682
|
+
|
|
1683
|
+
function StreamingBlock({
|
|
1684
|
+
block,
|
|
1685
|
+
code,
|
|
1686
|
+
}: {
|
|
1687
|
+
block: (typeof blocks)[number]
|
|
1688
|
+
code: string
|
|
1689
|
+
}) {
|
|
1690
|
+
const rows = code.split("\n")
|
|
1691
|
+
// A diff row starts with +, - or a space. The marker is not part of the code.
|
|
1692
|
+
const source = block.diff ? rows.map((row) => row.slice(1)).join("\n") : code
|
|
1693
|
+
const lines = useHighlightedCode(source, block.language)
|
|
1694
|
+
|
|
1695
|
+
return (
|
|
1696
|
+
<CodeBlock>
|
|
1697
|
+
{block.title && (
|
|
1698
|
+
<CodeBlockHeader>
|
|
1699
|
+
<CodeBlockTitle>{block.title}</CodeBlockTitle>
|
|
1700
|
+
<CodeBlockActions>
|
|
1701
|
+
<CodeBlockCopyButton
|
|
1702
|
+
value={source}
|
|
1703
|
+
disabled={code.length < block.code.length}
|
|
1704
|
+
/>
|
|
1705
|
+
</CodeBlockActions>
|
|
1706
|
+
</CodeBlockHeader>
|
|
1707
|
+
)}
|
|
1708
|
+
<CodeBlockContent lineNumbers={block.lineNumbers}>
|
|
1709
|
+
{lines.map((line, index) => (
|
|
1710
|
+
<CodeBlockLine
|
|
1711
|
+
key={index}
|
|
1712
|
+
variant={
|
|
1713
|
+
block.diff
|
|
1714
|
+
? rows[index]?.startsWith("+")
|
|
1715
|
+
? "added"
|
|
1716
|
+
: rows[index]?.startsWith("-")
|
|
1717
|
+
? "removed"
|
|
1718
|
+
: "default"
|
|
1719
|
+
: block.highlight?.includes(index)
|
|
1720
|
+
? "highlighted"
|
|
1721
|
+
: "default"
|
|
1722
|
+
}
|
|
1723
|
+
>
|
|
1724
|
+
{line}
|
|
1725
|
+
</CodeBlockLine>
|
|
1726
|
+
))}
|
|
1727
|
+
</CodeBlockContent>
|
|
1728
|
+
</CodeBlock>
|
|
1729
|
+
)
|
|
1730
|
+
}
|
|
1731
|
+
|
|
1732
|
+
export function CodeBlockStreaming() {
|
|
1733
|
+
const [length, setLength] = React.useState(total)
|
|
1734
|
+
|
|
1735
|
+
React.useEffect(() => {
|
|
1736
|
+
if (length >= total) {
|
|
1737
|
+
return
|
|
1738
|
+
}
|
|
1739
|
+
|
|
1740
|
+
const timeout = setTimeout(() => setLength(length + 3), 16)
|
|
1741
|
+
return () => clearTimeout(timeout)
|
|
1742
|
+
}, [length])
|
|
1743
|
+
|
|
1744
|
+
return (
|
|
1745
|
+
<div className="flex w-full max-w-md flex-col gap-4">
|
|
1746
|
+
{blocks.map(
|
|
1747
|
+
(block, index) =>
|
|
1748
|
+
length > offsets[index] && (
|
|
1749
|
+
<StreamingBlock
|
|
1750
|
+
key={block.code}
|
|
1751
|
+
block={block}
|
|
1752
|
+
code={block.code.slice(0, length - offsets[index])}
|
|
1753
|
+
/>
|
|
1754
|
+
)
|
|
1755
|
+
)}
|
|
1756
|
+
<Button
|
|
1757
|
+
variant="outline"
|
|
1758
|
+
size="sm"
|
|
1759
|
+
className="self-start"
|
|
1760
|
+
disabled={length < total}
|
|
1761
|
+
onClick={() => setLength(0)}
|
|
1762
|
+
>
|
|
1763
|
+
<RotateCcwIcon />
|
|
1764
|
+
Replay
|
|
1765
|
+
</Button>
|
|
1766
|
+
</div>
|
|
1767
|
+
)
|
|
1768
|
+
}
|
|
1769
|
+
|
|
1770
|
+
```
|
|
1771
|
+
|
|
1772
|
+
### Markdown
|
|
1773
|
+
|
|
1774
|
+
Render the message with [Streamdown](https://streamdown.ai) and route fenced code to a `CodeBlock` with `components.code`. Streamdown sets `data-block` on fenced code only, so inline code stays inline.
|
|
1775
|
+
|
|
1776
|
+
```tsx
|
|
1777
|
+
"use client"
|
|
1778
|
+
|
|
1779
|
+
import * as React from "react"
|
|
1780
|
+
import { useChat } from "@ai-sdk/react"
|
|
1781
|
+
import {
|
|
1782
|
+
Streamdown,
|
|
1783
|
+
useIsCodeFenceIncomplete,
|
|
1784
|
+
type ExtraProps,
|
|
1785
|
+
} from "streamdown"
|
|
1786
|
+
|
|
1787
|
+
import { createChat, getMessageText } from "@/lib/ai"
|
|
1788
|
+
import { useHighlightedCode } from "@/components/hooks/use-highlighted-code"
|
|
1789
|
+
import { Bubble, BubbleContent } from "@/components/ui/bubble"
|
|
1790
|
+
import { Button } from "@/components/ui/button"
|
|
1791
|
+
import {
|
|
1792
|
+
CodeBlock,
|
|
1793
|
+
CodeBlockActions,
|
|
1794
|
+
CodeBlockContent,
|
|
1795
|
+
CodeBlockCopyButton,
|
|
1796
|
+
CodeBlockHeader,
|
|
1797
|
+
CodeBlockLine,
|
|
1798
|
+
CodeBlockTitle,
|
|
1799
|
+
} from "@/components/ui/code-block"
|
|
1800
|
+
import { Message, MessageContent } from "@/components/ui/message"
|
|
1801
|
+
|
|
1802
|
+
const response = `Wrap the value in a \`useDebounce\` hook. It returns the latest value once it stops changing for \`delay\` milliseconds.
|
|
1803
|
+
|
|
1804
|
+
\`\`\`tsx
|
|
1805
|
+
export function useDebounce<T>(value: T, delay = 300) {
|
|
1806
|
+
const [debounced, setDebounced] = React.useState(value)
|
|
1807
|
+
|
|
1808
|
+
React.useEffect(() => {
|
|
1809
|
+
const timeout = setTimeout(() => setDebounced(value), delay)
|
|
1810
|
+
return () => clearTimeout(timeout)
|
|
1811
|
+
}, [value, delay])
|
|
1812
|
+
|
|
1813
|
+
return debounced
|
|
1814
|
+
}
|
|
1815
|
+
\`\`\`
|
|
1816
|
+
|
|
1817
|
+
Pass the debounced value to your fetch instead of the raw input.`
|
|
1818
|
+
|
|
1819
|
+
const chat = createChat()
|
|
1820
|
+
.user("How do I debounce a search input in React?")
|
|
1821
|
+
.assistant(({ writer }) => {
|
|
1822
|
+
writer.text(response)
|
|
1823
|
+
})
|
|
1824
|
+
|
|
1825
|
+
const transcript = chat.get()
|
|
1826
|
+
const [question] = chat.get(1)
|
|
1827
|
+
const transport = chat.transport({ delayMs: 30 })
|
|
1828
|
+
|
|
1829
|
+
function MarkdownCodeBlock({
|
|
1830
|
+
code,
|
|
1831
|
+
language,
|
|
1832
|
+
}: {
|
|
1833
|
+
code: string
|
|
1834
|
+
language: string
|
|
1835
|
+
}) {
|
|
1836
|
+
// True while the closing fence has not arrived yet.
|
|
1837
|
+
const incomplete = useIsCodeFenceIncomplete()
|
|
1838
|
+
const lines = useHighlightedCode(code, language)
|
|
1839
|
+
|
|
1840
|
+
return (
|
|
1841
|
+
<CodeBlock>
|
|
1842
|
+
<CodeBlockHeader>
|
|
1843
|
+
<CodeBlockTitle>{language || "text"}</CodeBlockTitle>
|
|
1844
|
+
<CodeBlockActions>
|
|
1845
|
+
<CodeBlockCopyButton value={code} disabled={incomplete} />
|
|
1846
|
+
</CodeBlockActions>
|
|
1847
|
+
</CodeBlockHeader>
|
|
1848
|
+
<CodeBlockContent>
|
|
1849
|
+
{lines.map((line, index) => (
|
|
1850
|
+
<CodeBlockLine key={index}>{line}</CodeBlockLine>
|
|
1851
|
+
))}
|
|
1852
|
+
</CodeBlockContent>
|
|
1853
|
+
</CodeBlock>
|
|
1854
|
+
)
|
|
1855
|
+
}
|
|
1856
|
+
|
|
1857
|
+
function MarkdownCode({
|
|
1858
|
+
node,
|
|
1859
|
+
className,
|
|
1860
|
+
children,
|
|
1861
|
+
...props
|
|
1862
|
+
}: React.ComponentProps<"code"> & ExtraProps) {
|
|
1863
|
+
// Streamdown marks fenced code with data-block. Everything else is inline.
|
|
1864
|
+
if (!("data-block" in props)) {
|
|
1865
|
+
return (
|
|
1866
|
+
<code
|
|
1867
|
+
className="rounded-sm bg-muted px-1 py-0.5 font-mono text-[0.9em]"
|
|
1868
|
+
{...props}
|
|
1869
|
+
>
|
|
1870
|
+
{children}
|
|
1871
|
+
</code>
|
|
1872
|
+
)
|
|
1873
|
+
}
|
|
1874
|
+
|
|
1875
|
+
return (
|
|
1876
|
+
<MarkdownCodeBlock
|
|
1877
|
+
code={typeof children === "string" ? children : ""}
|
|
1878
|
+
language={/language-(\S+)/.exec(className ?? "")?.[1] ?? ""}
|
|
1879
|
+
/>
|
|
1880
|
+
)
|
|
1881
|
+
}
|
|
1882
|
+
|
|
1883
|
+
const components = { code: MarkdownCode }
|
|
1884
|
+
|
|
1885
|
+
export function CodeBlockMarkdown() {
|
|
1886
|
+
const { messages, sendMessage, setMessages, status } = useChat({
|
|
1887
|
+
messages: transcript,
|
|
1888
|
+
transport,
|
|
1889
|
+
})
|
|
1890
|
+
const busy = status === "submitted" || status === "streaming"
|
|
1891
|
+
|
|
1892
|
+
return (
|
|
1893
|
+
<div className="flex min-h-112 w-full max-w-md flex-col gap-4 py-6 text-sm">
|
|
1894
|
+
{messages.map((message) =>
|
|
1895
|
+
message.role === "user" ? (
|
|
1896
|
+
<Message key={message.id} align="end">
|
|
1897
|
+
<MessageContent>
|
|
1898
|
+
<Bubble align="end" variant="muted">
|
|
1899
|
+
<BubbleContent>{getMessageText(message)}</BubbleContent>
|
|
1900
|
+
</Bubble>
|
|
1901
|
+
</MessageContent>
|
|
1902
|
+
</Message>
|
|
1903
|
+
) : (
|
|
1904
|
+
<Message key={message.id}>
|
|
1905
|
+
<MessageContent>
|
|
1906
|
+
<Streamdown
|
|
1907
|
+
controls={false}
|
|
1908
|
+
components={components}
|
|
1909
|
+
isAnimating={busy && message === messages.at(-1)}
|
|
1910
|
+
>
|
|
1911
|
+
{getMessageText(message)}
|
|
1912
|
+
</Streamdown>
|
|
1913
|
+
</MessageContent>
|
|
1914
|
+
</Message>
|
|
1915
|
+
)
|
|
1916
|
+
)}
|
|
1917
|
+
{!busy && (
|
|
1918
|
+
<Button
|
|
1919
|
+
variant="outline"
|
|
1920
|
+
size="sm"
|
|
1921
|
+
className="mt-auto self-start"
|
|
1922
|
+
onClick={() => {
|
|
1923
|
+
setMessages([])
|
|
1924
|
+
sendMessage(question)
|
|
1925
|
+
}}
|
|
1926
|
+
>
|
|
1927
|
+
Replay
|
|
1928
|
+
</Button>
|
|
1929
|
+
)}
|
|
1930
|
+
</div>
|
|
1931
|
+
)
|
|
1932
|
+
}
|
|
1933
|
+
|
|
1934
|
+
```
|
|
1935
|
+
|
|
1936
|
+
`useIsCodeFenceIncomplete` returns `true` until the closing fence arrives. Use it to disable the copy button while the code is incomplete. It only works when Streamdown gets `isAnimating`, so pass `isAnimating` while the message streams.
|
|
1937
|
+
|
|
1938
|
+
```tsx showLineNumbers
|
|
1939
|
+
<Streamdown components={{ code: MarkdownCode }} isAnimating={isStreaming}>
|
|
1940
|
+
{text}
|
|
1941
|
+
</Streamdown>
|
|
1942
|
+
```
|
|
1943
|
+
|
|
1944
|
+
## Accessibility
|
|
1945
|
+
|
|
1946
|
+
- `CodeBlockContent` is a `pre` with a `code` element and always sets `dir="ltr"`, so code reads left to right on an RTL page.
|
|
1947
|
+
- `CodeBlockContent` has `tabIndex={0}`, so keyboard users can focus it and scroll it. Pass `tabIndex={-1}` to remove the tab stop.
|
|
1948
|
+
- Floating actions show when focus is inside the block, not only on hover, so keyboard users can reach them.
|
|
1949
|
+
- Line numbers are hidden from screen readers.
|
|
1950
|
+
- Diff lines carry a `+` or `−` marker as well as a tint, so the change does not rely on color.
|
|
1951
|
+
- `CodeBlockCopyButton` is labelled "Copy", and a polite live region announces "Copied" after a successful copy.
|
|
1952
|
+
- Give a wrap toggle `aria-pressed` so its state is announced.
|
|
1953
|
+
- Give a Show More button `aria-expanded` and point `aria-controls` at the `id` of `CodeBlockContent`.
|
|
1954
|
+
|
|
1955
|
+
## API Reference
|
|
1956
|
+
|
|
1957
|
+
### CodeBlock
|
|
1958
|
+
|
|
1959
|
+
The surface that holds the header, the content and the footer.
|
|
1960
|
+
|
|
1961
|
+
| Prop | Type | Default | Description |
|
|
1962
|
+
| ----------- | ---------------------------- | ----------- | --------------------------------------------------------------- |
|
|
1963
|
+
| `variant` | `"default" \| "destructive"` | `"default"` | The tone of the block. |
|
|
1964
|
+
| `size` | `"default" \| "sm"` | `"default"` | `"sm"` has tighter padding and `text-xs` code, for tool output. |
|
|
1965
|
+
| `className` | `string` | - | Additional classes to apply to the block. |
|
|
1966
|
+
|
|
1967
|
+
### CodeBlockHeader
|
|
1968
|
+
|
|
1969
|
+
A row above the content for a title and actions.
|
|
1970
|
+
|
|
1971
|
+
| Prop | Type | Default | Description |
|
|
1972
|
+
| ----------- | -------- | ------- | ------------------------------------------ |
|
|
1973
|
+
| `className` | `string` | - | Additional classes to apply to the header. |
|
|
1974
|
+
|
|
1975
|
+
### CodeBlockTitle
|
|
1976
|
+
|
|
1977
|
+
A filename or a label, with an optional icon. It truncates.
|
|
1978
|
+
|
|
1979
|
+
| Prop | Type | Default | Description |
|
|
1980
|
+
| ----------- | -------- | ------- | ----------------------------------------- |
|
|
1981
|
+
| `className` | `string` | - | Additional classes to apply to the title. |
|
|
1982
|
+
|
|
1983
|
+
### CodeBlockActions
|
|
1984
|
+
|
|
1985
|
+
Holds buttons at the end of the header. As a direct child of `CodeBlock`, it floats.
|
|
1986
|
+
|
|
1987
|
+
| Prop | Type | Default | Description |
|
|
1988
|
+
| ----------- | -------- | ------- | ------------------------------------------- |
|
|
1989
|
+
| `className` | `string` | - | Additional classes to apply to the actions. |
|
|
1990
|
+
|
|
1991
|
+
### CodeBlockCopyButton
|
|
1992
|
+
|
|
1993
|
+
A ghost icon button that copies `value` to the clipboard. It accepts the props of [`Button`](/docs/components/base/button).
|
|
1994
|
+
|
|
1995
|
+
| Prop | Type | Default | Description |
|
|
1996
|
+
| ----------- | -------- | ------- | ------------------------------------------ |
|
|
1997
|
+
| `value` | `string` | - | Required. The text to copy. |
|
|
1998
|
+
| `className` | `string` | - | Additional classes to apply to the button. |
|
|
1999
|
+
|
|
2000
|
+
### CodeBlockContent
|
|
2001
|
+
|
|
2002
|
+
The `pre` that scrolls or wraps.
|
|
2003
|
+
|
|
2004
|
+
| Prop | Type | Default | Description |
|
|
2005
|
+
| ------------- | ----------------- | ------- | --------------------------------------------------------------- |
|
|
2006
|
+
| `children` | `React.ReactNode` | - | A string, or a list of `CodeBlockLine`. |
|
|
2007
|
+
| `wrap` | `boolean` | `false` | Wrap long lines instead of scrolling. |
|
|
2008
|
+
| `lineNumbers` | `boolean` | `false` | Number each line. A string child is split into lines. |
|
|
2009
|
+
| `startLine` | `number` | `1` | The number of the first line, when `lineNumbers` is set. |
|
|
2010
|
+
| `tabIndex` | `number` | `0` | Makes the content focusable so it can be scrolled by keyboard. |
|
|
2011
|
+
| `className` | `string` | - | Additional classes to apply to the content, such as `max-h-72`. |
|
|
2012
|
+
|
|
2013
|
+
### CodeBlockLine
|
|
2014
|
+
|
|
2015
|
+
One line of code.
|
|
2016
|
+
|
|
2017
|
+
| Prop | Type | Default | Description |
|
|
2018
|
+
| ----------- | ---------------------------------------------------- | ----------- | ---------------------------------------- |
|
|
2019
|
+
| `variant` | `"default" \| "added" \| "removed" \| "highlighted"` | `"default"` | The state of the line. |
|
|
2020
|
+
| `className` | `string` | - | Additional classes to apply to the line. |
|
|
2021
|
+
|
|
2022
|
+
### CodeBlockFooter
|
|
2023
|
+
|
|
2024
|
+
A row below the content, such as for a Show More button.
|
|
2025
|
+
|
|
2026
|
+
| Prop | Type | Default | Description |
|
|
2027
|
+
| ----------- | -------- | ------- | ------------------------------------------ |
|
|
2028
|
+
| `className` | `string` | - | Additional classes to apply to the footer. |
|
|
2029
|
+
|
|
2030
|
+
### useHighlightedCode
|
|
2031
|
+
|
|
2032
|
+
```tsx
|
|
2033
|
+
const lines = useHighlightedCode(code, language)
|
|
2034
|
+
```
|
|
2035
|
+
|
|
2036
|
+
Returns one React node per line. It returns plain lines until the first pass finishes, and for a language that is not in the list.
|
|
2037
|
+
|
|
2038
|
+
| Argument | Type | Description |
|
|
2039
|
+
| ---------- | -------- | ------------------------------------------------------------ |
|
|
2040
|
+
| `code` | `string` | The code to highlight. A trailing newline is ignored. |
|
|
2041
|
+
| `language` | `string` | A language or alias from `lib/highlighter.tsx`, or `"ansi"`. |
|