fluxdown

中文文档
0.14.3发布于 2026/11/04MITTypeScriptESM + CJS构建来源已验证

用于React AI聊天的流式Markdown渲染器,具有语法修复,平滑输出和可定制组件。

中文使用文档
文档目录5 节
  1. 安装
  2. 呈现消息
  3. 让它成为你自己的
  4. 文档
  5. 贡献与许可

React的Fluxdown

流式Markdown,为React应用准备好了。

fluxdown 呈现包含基本样式、代码高亮显示和复制按钮的Markdown。它支持GFM表、任务列表、删除和自动链接。在生成过程中,它可以平滑输入的文本,修复未完成的语法,并淡入尾随字符。

文档 · 操场上 · 简体中文

安装

在React 18或19应用中:

pnpm add fluxdown

呈现消息

import { Fluxdown } from "fluxdown";

type MessageProps = {
  text: string;
  isStreaming: boolean;
};

export function Message({ text, isStreaming }: MessageProps) {
  return <Fluxdown text={text} streaming={isStreaming} />;
}

通过 到目前为止收到了完整的消息 作为 text,如有必要,在请求处理程序中积累块。集 isStreaming 来 false 请求完成、取消或失败时。Fluxdown然后显示所有接收到的文本并停止其流效果。你的应用程序处理请求、取消和错误。

对于静态Markdown,使用 <Fluxdown text={text} />. 在消息列表中,为每个组件提供一个稳定的消息ID作为其 key。

如果你的打包器不自动加载这些样式,把下面的添加到你的应用的全局样式条目中:

import "fluxdown/styles.css";

让它成为你自己的

选项目的
streaming配置尾随语法修复、平滑输出和可选的视觉效果。
theme使用浅色或深色预设,或覆盖颜色、排版和间距。
build启用语法,如公式和脚注。
plugins自定义解析、呈现、语义槽和交互。
className, style设置容器布局和样式。

streaming={true} 允许拖尾修复和平滑输出。添加一个可选的视觉效果:

<Fluxdown text={text} streaming={isStreaming && { effect: "shad" }} />

文档

有关React之外的自定义渲染器,请参见 @fluxdown/core。

贡献与许可

看到 CONTRIBUTING.md. 下许可 麻省理工学院。

版本与发布记录

fluxdown 共发布 25 个版本,首次发布于 2026/09/14;过去 12 个月发布了 25 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.14.3latest2026/11/04今天
0.14.22026/11/022 天前
0.14.12026/10/278 天前
0.14.02026/10/259 天前
0.13.02026/10/2311 天前
0.12.02026/10/2113 天前

其他发布通道:beta → 0.5.2-beta.20260914060133.g70a9205c67e9d58120dce091f2c0f90c52f6fec2.r34811620073.a1。

关于 fluxdown 的常见问题

fluxdown 是什么?

用于React AI聊天的流式Markdown渲染器,具有语法修复,平滑输出和可定制组件。

如何安装 fluxdown?

在项目目录运行 npm install fluxdown,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、react-dom(^18.0.0 || ^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

fluxdown 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

fluxdown 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

fluxdown 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.18.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

fluxdown 可以商用吗?

fluxdown 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

fluxdown 还在维护吗?

最新版本 0.14.3 发布于 2026/11/04(今天);至今共发布 25 个版本,其中过去 12 个月发布了 25 个;首次发布于 2026/09/14。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。