跳到主要内容
版本:Canary 🚧

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 元素。 它会收到一个具有两个属性的对象: error,被捕捉的错误,和 tryAgain,一个函数回调 (() => void),用来重置组件中的错误并尝试重新渲染它。 如果 fallback 不存在,@theme/Error 会被渲染。 @theme/Error 默认用于在布局上层包裹整个站点的错误边界。
注意

fallback prop 是一个回调,不是一个 React 函数组件。 你不能在这个回调中使用 React 钩子。

此可复用的 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 的专有改进。 所有的 props 都会被传递给 react-router 的 <Link> 组件。

外部链接也能正常工作,并且会自动拥有这些 props: target="_blank" rel="noopener noreferrer"

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

const Page = () => (
<div>
<p>
看看我的<Link to="/blog">博客</Link>吧!
</p>
<p>
{/* highlight-next line */}
关注我的<Link to="https://twitter.com/docusaurus">Twitter</Link>
</p>
</div>
);

to: string

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

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

建议用这个组件,而不是原生的 <a> 标签,因为如果你用 <Link>,Docusaurus 会做很多优化(比如无效链接探测、预抓取、添加 base URL……)。

<Redirect/>

渲染 <Redirect> 组件将导航至新的位置。 新位置会覆盖历史记录栈的现有位置,效果类似服务端重定向 (HTTP 3xx)。 您可参阅 React Router 的重定向文档来了解更多可传入的属性。

示例用法:

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 中运行的代码,比如如果代码要访问 windowdocument 对象。

属性

  • children: 一个渲染函数,返回只在浏览器中被渲染的 JSX。 不会在 Node.js 中被执行。
  • fallback(可选): 在服务器 (Node.js) 上渲染的 JSX,直到 React 注水完毕后被替换为真实内容。

代码示例

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 元素(字符串、链接、样式元素等)。

属性

  • 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: '思达',
website: (
<Link to="https://docusaurus.io" className="my-website-class">
网站
</Link>
),
}}>
{'你好,{firstName}! 你好吗? 看看我的{website}吧'}
</Interpolate>
);
}

<Translate/>

本地化你的网站时,<Translate/> 组件允许你为诸如首页的 React 组件提供翻译支持<Translate> 组件支持插值.

docusaurus write-translations 命令会从你的代码中静态提取翻译字符串,并在 website/i18n/[locale] 处创建一个 code.json 翻译文件。

备注

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

除了插值用到的 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">
欢迎来到我的网站
</Translate>
</h1>
<main>
<Translate values={{firstName: 'Sébastien'}}>
{'欢迎,{firstName}! 你好吗?'}
</Translate>
</main>
</Layout>
);
}
备注

你甚至可以忽略 children,然后在运行 docusaurus write-translations 命令后,手动在 code.json 文件中填写翻译字符串。

<Translate id="homepage.title" />

钩子函数

useDocusaurusContext

用于访问 Docusaurus context 的 React 钩子函数。 这个 context 包含了来自 docusaurus.config.jssiteConfig 对象,以及其他一些站点元数据。

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 渲染逻辑中,用这个钩子,而不是用 typeof windows !== 'undefined'

浏览器中的首次客户端渲染输出和 Node.js 的服务端渲染输出必须完全一致。 不遵守这条准则可能导致难以预料的注水错误,在 The Perils of Rehydration 中有详细描述。

示例用法:

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

const MyComponent = () => {
const isBrowser = useIsBrowser();
return <div>{isBrowser ? '客户端' : '服务端'}</div>;
};

useBaseUrl

用于在一个字符串前添加网站 baseUrl 的钩子函数。

注意

别在普通的链接里用它!

所有绝对路径前会自动默认加上 /baseUrl/ 前缀:

  • Markdown: [链接](/my/path) 会链接到 /baseUrl/my/path
  • React: <Link to="/my/path/">链接</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

用来访问所有插件创建的 Docusaurus 全局数据的钩子。

全局数据会先按照插件名再按照插件 ID 排列。

信息

插件 ID 只在某个插件在同一个网站上被多次使用时才有用。 每个插件实例都能创建它自己的全局数据。

type GlobalData = Record<
PluginName,
Record<
PluginId, // 默认为 "default"
any // 插件专有的数据
>
>;

示例用法:

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

函数

interpolate

<Interpolate> 组件的命令式版本。

签名

// 简单字符串插值
function interpolate(text: string, values: Record<string, string>): string;

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

示例

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

const message = interpolate('欢迎{firstName}', {firstName: '思达'});

translate

<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: '我的页面标题'})}>
<img
src={'https://docusaurus.io/logo.png'}
aria-label={
translate(
{
message: '{siteName} 网站的 logo',
// 可选
id: 'homepage.logo.ariaLabel',
description: '首页 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_IDdefault