跳到主要内容

Docusaurus 客户端 API

Docusaurus 提供了一些客户端 API，在构建站点时可能对你有帮助。

组件​

<ErrorBoundary />​

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

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

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

const SafeComponent = () => (
  <ErrorBoundary
    fallback={({error, tryAgain}) => (
      <div>
        <p>此组件因错误而崩溃：{error.message}。</p>
        <button onClick={tryAgain}>重试！</button>
      </div>
    )}>
    <SomeDangerousComponentThatMayThrow />
  </ErrorBoundary>
);
提示

要查看实际效果，请点击这里：

信息

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

备注

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

属性​

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

fallback 属性是一个回调，不是 React 功能组件。你不能在此回调中使用 React hooks。

这是一个可重用的 React 组件，用于管理对文档头的所有更改。它接受普通的 HTML 标签并输出普通的 HTML 标签，对初学者友好。它是 React Helmet 的包装器。

使用示例：

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

const MySEO = () => (
  <Head>
    <meta property="og:description" content="我的自定义描述" />
    <meta charSet="utf-8" />
    <title>我的标题</title>
    <link rel="canonical" href="http://mysite.com/example" />
  </Head>
);

嵌套或后续组件将覆盖重复的用法：

<Parent>
  <Head>
    <title>我的标题</title>
    <meta name="description" content="Helmet 应用" />
  </Head>
  <Child>
    <Head>
      <title>嵌套标题</title>
      <meta name="description" content="嵌套组件" />
    </Head>
  </Child>
</Parent>

输出：

<head>
  <title>嵌套标题</title>
  <meta name="description" content="嵌套组件" />
</head>

此组件支持链接到内部页面，并提供了一个名为预加载的强大性能功能。预加载用于预取资源，以便在用户使用此组件导航时资源已准备就绪。我们使用 IntersectionObserver 在 <Link> 位于视口时获取低优先级请求，然后使用 onMouseOver 事件在用户可能导航到请求资源时触发高优先级请求。

该组件是 react-router 的 <Link> 组件的包装器，添加了 Docusaurus 特定的有用增强。所有属性都传递给 react-router 的 <Link> 组件。

外部链接也可以工作，并自动具有这些属性：target="_blank" rel="noopener noreferrer"。

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

const Page = () => (
  <div>
    <p>
      查看我的 <Link to="/blog">博客</Link>！
    </p>
    <p>
      在 <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 文档 了解更多可用属性。

使用示例：

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 对象。

属性​

  • children：渲染函数属性，返回仅在浏览器中的 JSX。在 Node.js 中不会执行
  • fallback（可选）：在服务器（Node.js）上渲染并直到 React 水合完成的 JSX

代码示例​

import BrowserOnly from '@docusaurus/BrowserOnly';

const MyComponent = () => {
  return (
    <BrowserOnly>
      {() => <span>页面 URL = {window.location.href}</span>}
    </BrowserOnly>
  );
};

库示例​

import BrowserOnly from '@docusaurus/BrowserOnly';

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

<Interpolate/>​

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

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

属性​

  • 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.io" 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 和 code.json 翻译文件将创建在 website/i18n/[locale] 中。

备注

<Translate/> 的 values 属性 必须是硬编码字符串。

除了用于插值的 values 属性外，它 不能使用变量，否则静态提取将不起作用。

属性​

  • 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 属性并指定翻译字符串在 code.json 文件中手动运行 docusaurus write-translations CLI 命令。

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

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

Hooks​

useDocusaurusContext​

React 钩子访问 Docusaurus 上下文。上下文包含来自 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​

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

注意

使用此钩子而不是 typeof windows !== 'undefined' 在 React 渲染逻辑中。

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

使用示例：

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

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

useBaseUrl​

React 钩子将你的站点 baseUrl 添加到字符串之前。

注意

不要将其用于常规链接！

默认情况下，默认情况下，所有 绝对路径 都会自动添加 /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 不够好。此钩子返回与站点 base URL 相关的其他有用工具。

  • withBaseUrl：如果你需要一次为多个 URL 添加 base 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​

React 钩子访问 Docusaurus 全局数据，由所有插件创建。

全局数据按插件名称然后按插件 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​

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

这是访问插件全局数据的最方便的钩子，应该在大多数情况下使用。

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>;
};

React 钩子访问 Docusaurus 断开链接检查器 APIs，暴露一种方式，让 Docusaurus 页面报告并收集他们的链接和锚点。

注意

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

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

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

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

使用示例：

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} />;
}

Functions​

interpolate​

命令式 API 的 <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​

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

提示

对于 罕见情况，使用命令式 API，例如：

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

签名​

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.io/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>
  );
}

Modules​

ExecutionEnvironment​

一个模块，暴露一些布尔变量以检查当前渲染环境。

注意

对于 React 渲染逻辑，请使用 useIsBrowser() 或 <BrowserOnly> 而不是此模块。

示例：

import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';

if (ExecutionEnvironment.canUseDOM) {
  require('lib-that-only-works-client-side');
}
FieldDescription
ExecutionEnvironment.canUseDOMtrue if on client/browser, false on Node.js/prerendering.
ExecutionEnvironment.canUseEventListenerstrue if on client and has window.addEventListener.
ExecutionEnvironment.canUseIntersectionObservertrue if on client and has IntersectionObserver.
ExecutionEnvironment.canUseViewporttrue if on client and has window.screen.

constants​

一个模块暴露有用的常量以供客户端主题代码使用。

import {DEFAULT_PLUGIN_ID} from '@docusaurus/constants';
Named exportValue
DEFAULT_PLUGIN_IDdefault