跳到主要内容
版本：3.8.1

Docusaurus 客户端 API

Docusaurus 在客户端提供了一些 API，可以在您构建网站时提供帮助。

组件​

<ErrorBoundary />​

此组件创建了一个 React 错误边界。

使用它来包装可能抛出错误的组件，并在发生错误时显示备用内容，而不是让整个应用程序崩溃。

import React from 'react';
import ErrorBoundary from '@docusaurus/ErrorBoundary';

const SafeComponent = () => (
  <ErrorBoundary
    fallback={({error, tryAgain}) => (
      <div>
        <p>This component crashed because of error: {error.message}.</p>
        <button onClick={tryAgain}>Try Again!</button>
      </div>
    )}>
    <SomeDangerousComponentThatMayThrow />
  </ErrorBoundary>
);
提示

要查看实际效果，请点击此处

信息

Docusaurus 使用此组件来捕获主题布局内以及整个应用程序内的错误。

注意

此组件不捕获构建时错误，仅保护客户端渲染时可能发生的有状态 React 组件错误。

Props​

  • fallback：一个可选的渲染回调，返回一个 JSX 元素。它将接收一个包含 2 个属性的对象：error（捕获到的错误）和 tryAgain（一个函数 (() => void) 回调，用于重置组件中的错误并尝试再次渲染）。如果未提供，则会渲染 @theme/Error。@theme/Error 用于包装站点布局之上的错误边界。
警告

fallback prop 是一个回调，而**不是一个 React 函数组件**。您不能在此回调内部使用 React Hook。

这个可复用的 React 组件将管理您对文档 `` 的所有更改。它接受纯 HTML 标签并输出纯 HTML 标签，对初学者友好。它是 React Helmet 的一个封装。

使用示例

import React from 'react';
import Head from '@docusaurus/Head';

const MySEO = () => (
  <Head>
    <meta property="og:description" content="My custom description" />
    <meta charSet="utf-8" />
    <title>My Title</title>
    <link rel="canonical" href="http://mysite.com/example" />
  </Head>
);

嵌套或后续组件将覆盖重复使用

<Parent>
  <Head>
    <title>My Title</title>
    <meta name="description" content="Helmet application" />
  </Head>
  <Child>
    <Head>
      <title>Nested Title</title>
      <meta name="description" content="Nested component" />
    </Head>
  </Child>
</Parent>

输出

<head>
  <title>Nested Title</title>
  <meta name="description" content="Nested component" />
</head>

此组件支持链接到内部页面，并提供了一个强大的性能特性，称为预加载。预加载用于预取资源，以便用户使用此组件导航时资源已被获取。当 <Link> 在视口中时，我们使用 IntersectionObserver 发起低优先级请求；当用户可能导航到所请求的资源时，我们使用 onMouseOver 事件触发高优先级请求。

该组件是 React Router 的 <Link> 组件的一个封装，添加了 Docusaurus 特有的有用增强功能。所有 props 都透传给 React Router 的 <Link> 组件。

外部链接也适用，并自动具有这些 props：target="_blank" rel="noopener noreferrer"。

import React from 'react';
import Link from '@docusaurus/Link';

const Page = () => (
  <div>
    <p>
      Check out my <Link to="/blog">blog</Link>!
    </p>
    <p>
      Follow me on <Link to="https://x.com/docusaurus">X</Link>!
    </p>
  </div>
);

to：字符串​

导航的目标位置。示例：/docs/introduction。

<Link to="/courses" />
提示

优先使用此组件而不是普通的 <a> 标签，因为如果您使用 <Link>，Docusaurus 会进行许多优化（例如，断开路径检测、预取、应用基本 URL 等）。

<Redirect/>​

渲染 <Redirect> 将导航到一个新位置。新位置将覆盖历史堆栈中的当前位置，就像服务器端重定向（HTTP 3xx）那样。您可以参考 React Router 的 Redirect 文档 以获取更多关于可用 props 的信息。

使用示例

import React from 'react';
import {Redirect} from '@docusaurus/router';

const Home = () => {
  return <Redirect to="/docs/test" />;
};
注意

@docusaurus/router 实现了 React Router 并支持其功能。

<BrowserOnly/>​

<BrowserOnly> 组件允许在 React 应用程序水合后仅在浏览器中渲染 React 组件。

提示

将其用于集成无法在 Node.js 中运行的代码，因为这些代码访问了 window 或 document 对象。

Props​

  • children：返回仅浏览器 JSX 的渲染函数 prop。不会在 Node.js 中执行。
  • fallback（可选）：在服务器端（Node.js）以及 React 水合完成前渲染的 JSX。

代码示例​

import BrowserOnly from '@docusaurus/BrowserOnly';

const MyComponent = () => {
  return (
    <BrowserOnly>
      {() => <span>page url = {window.location.href}</span>}
    </BrowserOnly>
  );
};

库示例​

import BrowserOnly from '@docusaurus/BrowserOnly';

const MyComponent = (props) => {
  return (
    <BrowserOnly fallback={<div>Loading...</div>}>
      {() => {
        const LibComponent = require('some-lib').LibComponent;
        return <LibComponent {...props} />;
      }}
    </BrowserOnly>
  );
};

<Interpolate/>​

一个简单的插值组件，用于包含动态占位符的文本。

占位符将被提供的动态值和您选择的 JSX 元素（字符串、链接、样式化元素等）替换。

Props​

  • children：包含插值占位符（例如 {placeholderName}）的文本。
  • values：包含插值占位符值的对象。
import React from 'react';
import Link from '@docusaurus/Link';
import Interpolate from '@docusaurus/Interpolate';

export default function VisitMyWebsiteMessage() {
  return (
    <Interpolate
      values={{
        firstName: 'Sébastien',
        website: (
          <Link to="https://docusaurus.org.cn" className="my-website-class">
            website
          </Link>
        ),
      }}>
      {'Hello, {firstName}! How are you? Take a look at my {website}'}
    </Interpolate>
  );
}

<Translate/>​

当本地化您的网站时，<Translate/> 组件将允许为 **React 组件提供翻译支持**，例如您的主页。<Translate> 组件支持插值。

翻译字符串将通过 docusaurus write-translations CLI 从您的代码中静态提取，并在 website/i18n/[locale] 中创建 code.json 翻译文件。

注意

<Translate/> 的 props **必须是硬编码字符串**。

除了用于插值的 values prop 之外，**不能使用变量**，否则静态提取将无法工作。

Props​

  • children：默认站点语言环境中的未翻译字符串（可以包含插值占位符）
  • id：可选值，用作 JSON 翻译文件中的键。
  • description：可选文本，用于帮助译者。
  • values：可选对象，包含插值占位符值。

示例​

src/pages/index.js
import React from 'react';
import Layout from '@theme/Layout';

import Translate from '@docusaurus/Translate';

export default function Home() {
  return (
    <Layout>
      <h1>
        <Translate
          id="homepage.title"
          description="The homepage welcome message">
          Welcome to my website
        </Translate>
      </h1>
      <main>
        <Translate values={{firstName: 'Sébastien'}}>
          {'Welcome, {firstName}! How are you?'}
        </Translate>
      </main>
    </Layout>
  );
}
注意

您甚至可以省略 children prop，并在运行 docusaurus write-translations CLI 命令后手动在 code.json 文件中指定翻译字符串。

<Translate id="homepage.title" />
信息

<Translate> 组件支持插值。您还可以通过一些自定义代码和字符串复数化来使用translate 命令式 API。

Hook​

useDocusaurusContext​

用于访问 Docusaurus Context 的 React Hook。该上下文包含来自 docusaurus.config.js 的 siteConfig 对象和一些额外的站点元数据。

type PluginVersionInformation =
  | {readonly type: 'package'; readonly version?: string}
  | {readonly type: 'project'}
  | {readonly type: 'local'}
  | {readonly type: 'synthetic'};

type SiteMetadata = {
  readonly docusaurusVersion: string;
  readonly siteVersion?: string;
  readonly pluginVersions: Record<string, PluginVersionInformation>;
};

type I18nLocaleConfig = {
  label: string;
  direction: string;
};

type I18n = {
  defaultLocale: string;
  locales: [string, ...string[]];
  currentLocale: string;
  localeConfigs: Record<string, I18nLocaleConfig>;
};

type DocusaurusContext = {
  siteConfig: DocusaurusConfig;
  siteMetadata: SiteMetadata;
  globalData: Record<string, unknown>;
  i18n: I18n;
  codeTranslations: Record<string, string>;
};

使用示例

import React from 'react';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';

const MyComponent = () => {
  const {siteConfig, siteMetadata} = useDocusaurusContext();
  return (
    <div>
      <h1>{siteConfig.title}</h1>
      <div>{siteMetadata.siteVersion}</div>
      <div>{siteMetadata.docusaurusVersion}</div>
    </div>
  );
};
注意

siteConfig 对象只包含**可序列化的值**（即经过 JSON.stringify() 后仍能保留的值）。函数、正则表达式等会在客户端丢失。

useIsBrowser​

当 React 应用在浏览器中成功水合后返回 true。

警告

在 React 渲染逻辑中，请使用此 Hook 而非 typeof windows !== 'undefined'。

首次客户端渲染输出（在浏览器中）**必须与**服务器端渲染输出（Node.js）**完全相同**。不遵循此规则可能导致意外的水合行为，如 “再水合的危险” 中所述。

使用示例

import React from 'react';
import useIsBrowser from '@docusaurus/useIsBrowser';

const MyComponent = () => {
  const isBrowser = useIsBrowser();
  return <div>{isBrowser ? 'Client' : 'Server'}</div>;
};

useBaseUrl​

将站点 baseUrl 前置到字符串的 React Hook。

警告

不要将其用于常规链接！

/baseUrl/ 前缀默认会自动添加到所有**绝对路径**。

  • Markdown：[link](/my/path) 将链接到 /baseUrl/my/path
  • React：<Link to="/my/path/">link</Link> 将链接到 /baseUrl/my/path

选项​

type BaseUrlOptions = {
  forcePrependBaseUrl: boolean;
  absolute: boolean;
};

使用示例：​

import React from 'react';
import useBaseUrl from '@docusaurus/useBaseUrl';

const SomeImage = () => {
  const imgSrc = useBaseUrl('/img/myImage.png');
  return <img src={imgSrc} />;
};
提示

在大多数情况下，您不需要 useBaseUrl。

对于资产，更倾向于使用 require() 调用。

<img src={require('@site/static/img/myImage.png').default} />

useBaseUrlUtils​

有时 useBaseUrl 不够用。此 Hook 返回与您站点基本 URL 相关的额外实用工具。

  • withBaseUrl：如果您需要一次性向多个 URL 添加基本 URL，这将很有用。
import React from 'react';
import {useBaseUrlUtils} from '@docusaurus/useBaseUrl';

const Component = () => {
  const urls = ['/a', '/b'];
  const {withBaseUrl} = useBaseUrlUtils();
  const urlsWithBaseUrl = urls.map(withBaseUrl);
  return <div>{/* ... */}</div>;
};

useGlobalData​

用于访问由所有插件创建的 Docusaurus 全局数据的 React Hook。

全局数据按插件名称，然后按插件 ID 进行命名空间划分。

信息

插件 ID 仅在同一站点上多次使用同一插件时有用。每个插件实例都能够创建自己的全局数据。

type GlobalData = Record<
  PluginName,
  Record<
    PluginId, // "default" by default
    any // plugin-specific data
  >
>;

使用示例

import React from 'react';
import useGlobalData from '@docusaurus/useGlobalData';

const MyComponent = () => {
  const globalData = useGlobalData();
  const myPluginData = globalData['my-plugin']['default'];
  return <div>{myPluginData.someAttribute}</div>;
};
提示

在 .docusaurus/globalData.json 查看您站点的全局数据。

usePluginData​

访问由特定插件实例创建的全局数据。

这是访问插件全局数据最方便的 Hook，大部分时间都应该使用它。

如果您不使用多实例插件，pluginId 是可选的。

function usePluginData(
  pluginName: string,
  pluginId?: string,
  options?: {failfast?: boolean},
);

使用示例

import React from 'react';
import {usePluginData} from '@docusaurus/useGlobalData';

const MyComponent = () => {
  const myPluginData = usePluginData('my-plugin');
  return <div>{myPluginData.someAttribute}</div>;
};

useAllPluginInstancesData​

访问由特定插件创建的全局数据。给定一个插件名称，它会按插件 ID 返回该名称下所有插件实例的数据。

function useAllPluginInstancesData(
  pluginName: string,
  options?: {failfast?: boolean},
);

使用示例

import React from 'react';
import {useAllPluginInstancesData} from '@docusaurus/useGlobalData';

const MyComponent = () => {
  const allPluginInstancesData = useAllPluginInstancesData('my-plugin');
  const myPluginData = allPluginInstancesData['default'];
  return <div>{myPluginData.someAttribute}</div>;
};

用于访问 Docusaurus 损坏链接检查器 API 的 React Hook，它提供了一种方式让 Docusaurus 页面报告和收集它们的链接和锚点。

警告

这是一个**高级** API，**大多数 Docusaurus 用户不需要直接使用**。

它已经**内置**在现有的高级组件中

  • <Link> 组件将为您收集链接
  • @theme/Heading（用于 Markdown 标题）将收集锚点

如果您实现自己的 <Heading> 或 <Link> 组件，请使用 useBrokenLinks()。

使用示例

MyHeading.js
import useBrokenLinks from '@docusaurus/useBrokenLinks';

export default function MyHeading(props) {
  useBrokenLinks().collectAnchor(props.id);
  return <h2 {...props} />;
}
MyLink.js
import useBrokenLinks from '@docusaurus/useBrokenLinks';

export default function MyLink(props) {
  useBrokenLinks().collectLink(props.href);
  return <a {...props} />;
}

函数​

interpolate​

<Interpolate> 组件的命令式对应项。

签名​

// Simple string interpolation
function interpolate(text: string, values: Record<string, string>): string;

// JSX interpolation
function interpolate(
  text: string,
  values: Record<string, ReactNode>,
): ReactNode;

示例​

import {interpolate} from '@docusaurus/Interpolate';

const message = interpolate('Welcome {firstName}', {firstName: 'Sébastien'});

translate​

<Translate> 组件的命令式对应项。也支持占位符插值。

提示

在**极少数情况下**，当**无法使用组件**时，请使用命令式 API，例如：

  • 页面 title 元数据
  • 表单输入框的 placeholder props
  • 用于可访问性的 aria-label props

签名​

function translate(
  translation: {message: string; id?: string; description?: string},
  values: Record<string, string>,
): string;

示例​

src/pages/index.js
import React from 'react';
import Layout from '@theme/Layout';

import {translate} from '@docusaurus/Translate';

export default function Home() {
  return (
    <Layout
      title={translate({message: 'My page meta title'})}>
      <img
        src={'https://docusaurus.org.cn/logo.png'}
        aria-label={
          translate(
            {
              message: 'The logo of site {siteName}',
              // Optional
              id: 'homepage.logo.ariaLabel',
              description: 'The home page logo aria label',
            },
            {siteName: 'Docusaurus'},
          )
        }
      />
    </Layout>
  );
}

模块​

ExecutionEnvironment​

一个模块，公开了一些布尔变量以检查当前的渲染环境。

警告

对于 React 渲染逻辑，请改用useIsBrowser() 或 <BrowserOnly>。

示例

import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';

if (ExecutionEnvironment.canUseDOM) {
  require('lib-that-only-works-client-side');
}
字段描述
ExecutionEnvironment.canUseDOM如果在客户端/浏览器上为 true，在 Node.js/预渲染上为 false。
ExecutionEnvironment.canUseEventListeners如果在客户端且具有 window.addEventListener 则为 true。
ExecutionEnvironment.canUseIntersectionObserver如果在客户端且具有 IntersectionObserver 则为 true。
ExecutionEnvironment.canUseViewport如果在客户端且具有 window.screen 则为 true。

constants​

一个模块，向客户端主题代码公开有用的常量。

import {DEFAULT_PLUGIN_ID} from '@docusaurus/constants';
命名导出值
DEFAULT_PLUGIN_ID默认