JGuang

代码块

Code Block · Chakra UI

交互预览
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

代码块

展示代码、语法高亮、行号与复制操作。复制应得到原始代码而非装饰行号;长行允许滚动或换行,高亮器依赖只加载所需语言,代码内容不应被执行。

随附图标许可

源码查看器包含 ICON_ATTRIBUTION.md,以及本组示例实际使用的图标集合原始许可。再分发示例时请保留;react-icons 封装包的许可证不能替代各图标集合自身的条款。

  • Font Awesome 5: CC BY 4.0 License
  • Ionicons 5: MIT
  • Lucide: ISC

安装与初始化

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0

渲染前配置 ChakraProvider、defaultSystem 和 Emotion。保留宿主项目的 React 版本并检查 peer 兼容。官方 npm 安装提供组件包,不会复制以下示例源码。locale、next-themes 和框架专属 SSR 配置见资源安装指南;npm 安装之外还需单独复制所选示例源码。

完整原生使用示例

这是固定版本的真实示例,不是通用 API 伪代码。复制完整源码依赖并保留命名导出;附加依赖逐例列在下方。

"use client"

import { CodeBlock, createShikiAdapter } from "@chakra-ui/react"
import type { HighlighterGeneric } from "shiki"

const file = {
  code: `
<div class="container">
  <h1>Hello, world!</h1>
</div>
`,
  language: "html",
  title: "index.html",
}

export const CodeBlockBasic = () => {
  return (
    <CodeBlock.AdapterProvider value={shikiAdapter}>
      <CodeBlock.Root code={file.code} language={file.language}>
        <CodeBlock.Content>
          <CodeBlock.Code>
            <CodeBlock.CodeText />
          </CodeBlock.Code>
        </CodeBlock.Content>
      </CodeBlock.Root>
    </CodeBlock.AdapterProvider>
  )
}

const shikiAdapter = createShikiAdapter<HighlighterGeneric<any, any>>({
  async load() {
    const { createHighlighter } = await import("shiki")
    return createHighlighter({
      langs: ["tsx", "scss", "html", "bash", "json"],
      themes: ["github-dark"],
    })
  },
  theme: "github-dark",
})

全部示例与复现要求

示例名称用于选择演示,不是组件通用 variant 属性。复制所选示例全部 sourceFiles;compositions 别名表示本地文件,不是 npm 包。保留相对导入或映射到宿主真实目录。React peer 单独检查;编辑器示例保留一致的固定 Tiptap 扩展版本。

基础用法

code-block-basic · 命名导出 CodeBlockBasic · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-basic.tsx

不同尺寸

code-block-with-sizes · 命名导出 CodeBlockWithSizes · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-sizes.tsx

标题

code-block-with-title · 命名导出 CodeBlockWithTitle · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 react-icons@5.6.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-title.tsx

复制按钮

code-block-with-copy-button · 命名导出 CodeBlockWithCopyButton · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-copy-button.tsx

行数字

code-block-with-line-numbers · 命名导出 CodeBlockWithLineNumbers · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-line-numbers.tsx

行高亮

code-block-with-line-highlight · 命名导出 CodeBlockWithLineHighlight · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-line-highlight.tsx

行焦点

code-block-with-line-focus · 命名导出 CodeBlockWithLineFocus · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-line-focus.tsx

差异

code-block-with-diff · 命名导出 CodeBlockWithDiff · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-diff.tsx

最大行

code-block-with-max-lines · 命名导出 CodeBlockWithMaxLines · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-max-lines.tsx

语言切换器

code-block-with-language-switcher · 命名导出 CodeBlockWithLanguageSwitcher · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 react-icons@5.6.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-language-switcher.tsx

浮动复制按钮

code-block-with-floating-copy-button · 命名导出 CodeBlockWithFloatingCopyButton · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-floating-copy-button.tsx

标签页

code-block-with-tabs · 命名导出 CodeBlockWithTabs · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-tabs.tsx

标签页同步

code-block-with-tabs-sync · 命名导出 CodeBlockWithTabsSync · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-tabs-sync.tsx

主题

code-block-with-themes · 命名导出 CodeBlockWithThemes · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 next-themes@0.4.6 react-icons@5.6.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-themes.tsx
  • vendor/apps/compositions/src/ui/color-mode.tsx

文字换行

code-block-with-word-wrap · 命名导出 CodeBlockWithWordWrap · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-word-wrap.tsx

行数字文字换行

code-block-with-line-numbers-word-wrap · 命名导出 CodeBlockWithLineNumbersWordWrap · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 shiki@3.23.0
  • vendor/apps/compositions/src/examples/code-block-with-line-numbers-word-wrap.tsx

高亮JS

code-block-with-highlight-js · 命名导出 CodeBlockWithHighlightJs · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 highlight.js@11.11.1
  • vendor/apps/compositions/src/examples/code-block-with-highlight-js.tsx

纯文本文本

code-block-plain-text · 命名导出 CodeBlockPlainText · 上游原始示例

npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
  • vendor/apps/compositions/src/examples/code-block-plain-text.tsx

原生 API 与源码参考

源码查看器保留原始声明、import 与继承关系。Ark UI 事件契约、Chakra 样式属性和 recipe 类型仍以原生包为准;本指南不平铺或编造默认值。代码注释保留原文,不冒充正文翻译。

  • npm/@chakra-ui/react@3.37.0/dist/types/components/code-block/adapters.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/code-block/code-block-adapter-context.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/code-block/code-block-adapter-provider.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/code-block/code-block-context.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/code-block/code-block.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/code-block/index.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/code-block/namespace.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/code-block/types.d.ts
  • npm/@chakra-ui/react@3.37.0/dist/types/components/code-block/use-code-highlight.d.ts

状态与安装后检查

执行严格类型检查、目标项目生产构建和实际操作。检查名称/焦点/键盘、深浅色、窄屏、原生支持的空/加载/错误状态以及卸载清理。预览限制远程接口、上传与下载,业务服务需自行配置。复制命令或预览就绪不代表安装完成或后端成功。

来源与许可边界

https://github.com/chakra-ui/chakra-ui/tree/2e7517745cff2fcde0b8012f136cf99611ff262a

本页是 JGuang 双语实用说明,不声称全文翻译上游 MDX。原始文档与示例字节保留在 vendor。保留仓库 MIT、compositions 的 ISC 元数据和独立依赖声明;原始许可元数据差异与缺失完整声明仍作为显式审查事项,不包含 Chakra Pro 付费内容。