跳到正文

Equation 公式

要展示用 TeX 写的数学公式时用 Equation:句子里的一个变量或一小段表达式,或者在讲解、报告、模型回答里单独占一行的公式。要渲染整条 Markdown 消息,里面的公式用 $…$ 和 $$…$$ 写的,请在 Markdown 里打开 mathExtension,它会替你用 Equation 渲染。代码请用 Code。

使用前须知
  • 渲染需要 KaTeX,Pika 既不打包也不依赖它:请安装 katex,传给 ConfigProvider(katex={katex})或 katex 属性,并引入一次它的样式表(import "katex/dist/katex.min.css",字体也随之加载)。没有 KaTeX 时,Equation 把 TeX 源码按代码显示。
  • 在 Markdown 里,公式默认关闭,要把 @pika-lab/react/markdown 的 mathExtension 加进 extensions 才会生效。

Equation 用 KaTeX 的 renderToString 渲染,所以服务端和首屏就能出公式;除了看得见的 HTML,还会输出给读屏软件用的 MathML。需要 KaTeX trust 的命令(链接、类名、图片)一律关闭。

配置 KaTeX

tsx
import "katex/dist/katex.min.css"; import katex from "katex"; import { ConfigProvider } from "@pika-lab/react"; export function App() { return <ConfigProvider katex={katex}>{/* … */}</ConfigProvider>; }

演示

基础用法

嵌在一行文字里,大小和颜色跟随文字。

独占一行

display 让公式单独占一行并居中。比容器宽的公式可以左右滚动。

出错和没有 KaTeX

KaTeX 解析不了的公式会保留源码并加上错误边框,不会把页面弄坏;鼠标悬停能看到 KaTeX 的报错。没有 KaTeX 时源码按代码显示。

在 Markdown 里

打开 mathExtension 后,$…$ 是行内公式,$$ 块是独占一行的公式,\$ 写出一个美元符号。不打开时 $ 只是普通文字,价格和 shell 变量不会被当成公式。

Props

名称类型默认值说明版本
valuestring必填TeX 公式,不带 $ 分隔符。未发布
displaybooleanfalse单独占一行并居中,而不是嵌在行内。未发布
katexEquationRendererundefined这个公式用的 KaTeX(import katex from "katex"),默认用 ConfigProvider 的。未发布

其余 props 传给根节点 <span>。EquationRenderer 是 Equation 调用的那部分 KaTeX(renderToString);Pika 只导出它的类型,运行时从不引入 KaTeX。