{
  "url": "https://unifast.dev/zh-CN/docs/packages/react/overview/",
  "locale": "zh-CN",
  "title": "@unifast/react",
  "description": "将 unifast 的 HAST 输出转换为 React 元素，并支持组件映射。",
  "section": "packages",
  "body": "## 概述\n\n`@unifast/react` 会将 unifast 的 HAST（HTML 抽象语法树）输出转换为 React 元素。它提供了两个主要函数：\n\n- [`compileToReact()`](/docs/packages/react/compile-to-react) —— 高层 API：编译 Markdown/MDX 并直接返回 React 元素\n- [`hastToReact()`](/docs/packages/react/hast-to-react) —— 低层 API：将 HAST 树转换为 React 元素\n\n该包会自动处理 HTML 到 React 的属性重命名（`class` 改为 `className`、`for` 改为 `htmlFor` 等），并解析 CSS 样式字符串。\n\n## 安装\n\n对等依赖：`compileToReact` 需要 `@unifast/node`。\n\n## 类型定义\n\n### CompileToReactOptions\n\n在 `CompileOptions` 的基础上新增了 React 相关字段。\n\n| 属性 | 类型 | 描述 |\n|----------|------|-------------|\n| `createElement` | `CreateElement` | React 的 `createElement` 函数 |\n| `Fragment` | `unknown` | React 的 `Fragment` 组件 |\n| `components?` | `ComponentMap` | HTML 标签名到 React 组件的映射 |\n| *（所有 CompileOptions）* | - | 继承自 `CompileOptions` |\n\n### CompileToReactResult\n\n| 属性 | 类型 | 描述 |\n|----------|------|-------------|\n| `element` | `unknown` | 根 React 元素 |\n| `frontmatter` | `Record<string, unknown>` | 解析后的 frontmatter 元数据 |\n| `diagnostics` | `Diagnostic[]` | 警告和错误 |\n| `stats` | `{ parseMs, transformMs, emitMs }` | 各阶段耗时（毫秒） |\n| `toc` | `TocEntry[]` | 提取出的目录 |\n\n### HastToReactOptions\n\n| 属性 | 类型 | 描述 |\n|----------|------|-------------|\n| `createElement` | `CreateElement` | React 的 `createElement` 函数 |\n| `Fragment` | `unknown` | React 的 `Fragment` 组件 |\n| `components?` | `ComponentMap` | HTML 标签名到自定义 React 组件的映射 |\n\n### CreateElement\n\n```ts\ntype CreateElement = (type: any, props: any, ...children: any[]) => any;\n```\n\n### ComponentMap\n\n```ts\ntype ComponentMap = Record<string, unknown>;\n```\n\n### 属性转换\n\n| HTML 属性 | React 属性 |\n|---------------|------------|\n| `class` | `className` |\n| `for` | `htmlFor` |\n| `accesskey` | `accessKey` |\n| `autocomplete` | `autoComplete` |\n| `autofocus` | `autoFocus` |\n| `autoplay` | `autoPlay` |\n| `charset` | `charSet` |\n| `colspan` | `colSpan` |\n| `contenteditable` | `contentEditable` |\n| `crossorigin` | `crossOrigin` |\n| `datetime` | `dateTime` |\n| `enctype` | `encType` |\n| `formaction` | `formAction` |\n| `hreflang` | `hrefLang` |\n| `httpequiv` | `httpEquiv` |\n| `inputmode` | `inputMode` |\n| `maxlength` | `maxLength` |\n| `minlength` | `minLength` |\n| `novalidate` | `noValidate` |\n| `readonly` | `readOnly` |\n| `referrerpolicy` | `referrerPolicy` |\n| `rowspan` | `rowSpan` |\n| `spellcheck` | `spellCheck` |\n| `srcdoc` | `srcDoc` |\n| `srclang` | `srcLang` |\n| `srcset` | `srcSet` |\n| `tabindex` | `tabIndex` |\n| `usemap` | `useMap` |\n\nCSS `style` 字符串会被自动解析为 React 的样式对象（例如 `\"font-size: 16px\"` 会变成 `{ fontSize: \"16px\" }`）。\n\n## 导出列表\n\n| 导出 | 类别 | 描述 |\n|--------|------|-------------|\n| `compileToReact` | function | 将 Markdown/MDX 编译为 React 元素 |\n| `hastToReact` | function | 将 HAST 转换为 React 元素 |\n| `CompileToReactOptions` | type | `compileToReact` 的选项 |\n| `CompileToReactResult` | type | `compileToReact` 的结果 |\n| `HastToReactOptions` | type | `hastToReact` 的选项 |\n| `CreateElement` | type | React createElement 的签名 |\n| `ComponentMap` | type | HTML 标签到组件的映射 |",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/docs/packages/react/overview.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/ja/docs/packages/react/overview.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/react/overview.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/react/overview.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/ko/docs/packages/react/overview.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/fr/docs/packages/react/overview.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/it/docs/packages/react/overview.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/es/docs/packages/react/overview.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/react/overview.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/de/docs/packages/react/overview.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/ru/docs/packages/react/overview.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/hi/docs/packages/react/overview.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/id/docs/packages/react/overview.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/tr/docs/packages/react/overview.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/react/overview/",
      "api": "https://unifast.dev//api/vi/docs/packages/react/overview.json"
    }
  ]
}