# @doist/typist 中文文档

规范地址：https://npmcn.com/package/%40doist/typist/

版本：17\.1\.2
npm 元数据更新时间：2026-11-11T13:44:16.524Z
中文译文更新时间：2026-11-12T15:39:11.634Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40doist/typist
原文对照：https://npmcn.com/package/%40doist/typist/?lang=original
项目主页：https://typist.doist.dev/
源码仓库：https://github.com/todoist/typist

弃用说明：Moved to @todoist/typist\. Replace @doist/typist with @todoist/typist in your dependencies and imports\.

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：498 kB，191 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>= 24\.13\.0
- 运行依赖：52 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，linkifyjs ^4\.3\.2，lodash-es ^4\.17\.21，react-dom ^18\.0\.0 \|\| ^19\.0\.0，emoji-regex ^10\.2\.1 \|\| ^11\.0\.0
- 首次发布：2022-11-04T17:41:49.939Z
- 最新版本发布：2026-11-11T11:26:14.980Z
- 近 30 天下载量：3344（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：142（近 12 个月 42 个）

## 中文简介

强大的基于Tiptap的丰富文本编辑器 React 组件,能给Doist产品带来力量.

## 安装

```sh
npm install @doist/typist
```

也可以使用：`pnpm add @doist/typist`、`yarn add @doist/typist`、`bun add @doist/typist`

## README

# ![](https://github.com/todoist/typist/blob/main/.github/assets/logo-light.png?raw=true)

打字是强势的 [提示](https://tiptap.dev/)\- 基础丰富的文本编辑器 React 组件,可以赋予 Todoist 产品权力,它也可以用来以只读的方式显示内容. Typist也支持平正文本模式,并带有HTML/Markdown序列器.

> **说明**
> 
> 这个计划并不想成为全能的丰富文本编辑器. 虽然欢迎每个人在自己的产品中叉出或使用这套产品,但发展决策则以托多主义的产品要求为中心.

[![GitHub: CI Validation](https://github.com/todoist/typist/actions/workflows/check-ci-validation.yml/badge.svg?branch=main)](https://github.com/todoist/typist/actions/workflows/check-ci-validation.yml?query=branch%3Amain) [![npm Version](https://img.shields.io/npm/v/@doist/typist)](https://www.npmjs.com/package/@doist/typist) [![npm Bundle Size (minified)](https://img.shields.io/bundlephobia/min/@doist/typist)](https://bundlephobia.com/package/@doist/typist) [![npm Downloads (monthly)](https://img.shields.io/npm/dm/@doist/typist?color=blue)](https://npmtrends.com/@doist/typist)

[![semantic-release: Conventional Commits](https://img.shields.io/badge/semantic--release-Conventional%20Commits-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://npmcn.com/package/%40doist/typist/CODE_OF_CONDUCT.md) [![License: MIT](https://img.shields.io/github/license/todoist/typist)](https://npmcn.com/package/%40doist/typist/LICENSE.md)

## 安装

```sh
npm install --save @doist/typist
```

## 使用量

```tsx
import { TypistEditor, RichTextKit } from '@doist/typist'

function TypistEditorContainer({ content }) {
    return (
        <TypistEditor
            placeholder="A full rich-text editor, be creative…"
            content={content}
            extensions={[RichTextKit]}
        />
    )
}
```

> **说明**
> 
> `content`, (中文(简体) ), `extensions`,以及 `placeholder` 仅初始化:当编辑器首次挂载时会被读取,后来对这些道具的修改被忽略. 见 [组成部分生命周期](https://typist.doist.dev/?path=/docs/documentation-tips-tricks-component-lifecycle--docs) 用于处理运行时间变化的文档.

如果你在找更多的文件, 深入的例子, 或现场演示, 请检查我们 [故事书](https://typist.doist.dev/)。 。 。 .

## 资源

由 Tiptap 驱动的开源丰富文本编辑器目录, 我们可以从中汲取灵感 :

-   GitLab 的内容编辑器 :  
    [https://gitlab.com/gitlab-org/gitlab/-/tree/master/app/assets/javascripts/content editor 互联网档案馆的存檔,存档日期2013-12-22](https://gitlab.com/gitlab-org/gitlab/-/tree/master/app/assets/javascripts/content_editor)

## 捐款

如果您有兴趣提供代码和/或文档,请阅读我们 [贡献指南](https://npmcn.com/package/%40doist/typist/CONTRIBUTING.md)。 。 。 .

## 许可证

使用此源代码受麻省理工学院风格的许可管理,该许可可在 [自由主义](https://npmcn.com/package/%40doist/typist/LICENSE) 文档.

## 常见问题

### @doist/typist 是什么？

强大的基于Tiptap的丰富文本编辑器 React 组件,能给Doist产品带来力量\.注意：该包已被作者标记为弃用——Moved to @todoist/typist\. Replace @doist/typist with @todoist/typist in your dependencies and imports\.

### 如何安装 @doist/typist？

在项目目录运行 npm install @doist/typist，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0\.0 \|\| ^19\.0\.0）、linkifyjs（^4\.3\.2）、lodash-es（^4\.17\.21）、react-dom（^18\.0\.0 \|\| ^19\.0\.0）、emoji-regex（^10\.2\.1 \|\| ^11\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @doist/typist 支持 TypeScript 吗？

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

### @doist/typist 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @doist/typist 需要什么版本的 Node\.js？

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

### @doist/typist 可以商用吗？

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

### @doist/typist 的下载量有多少？

根据 npm 官方下载统计，@doist/typist 在 2026/10/13 – 2026/11/11 这 30 天内被下载 3,344 次，日均约 111 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @doist/typist 还在维护吗？

最新版本 17\.1\.2 发布于 2026/11/11（2 天前）；至今共发布 142 个版本，其中过去 12 个月发布了 42 个；首次发布于 2022/11/05。作者已将其标记为弃用，新项目建议寻找替代方案。