# @editorjs/list 中文文档

规范地址：https://npmcn.com/package/%40editorjs/list/

版本：2\.0\.9
npm 元数据更新时间：2025-11-13T00:25:14.249Z
中文译文更新时间：2026-11-13T07:07:18.023Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40editorjs/list
原文对照：https://npmcn.com/package/%40editorjs/list/?lang=original
源码仓库：https://github.com/editor-js/list

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

- 包体积（解压后）：160 kB，40 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2019-03-02T15:28:29.612Z
- 最新版本发布：2025-11-13T00:25:14.052Z
- 近 30 天下载量：740767（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 0 个）

## 中文简介

编辑器的列表工具JS

## 安装

```sh
npm install @editorjs/list
```

也可以使用：`pnpm add @editorjs/list`、`yarn add @editorjs/list`、`bun add @editorjs/list`

## README

![](https://badgen.net/badge/Editor.js/v2.19.2/blue)

# 编辑器列表工具

![](https://npmcn.com/package/%40editorjs/list/assets/readme_image.png)

-   \* \* \* 部分内容 [编辑.js](https://editorjs.io/) 生态系统.
-   \- 内斯丁.
-   {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}有秩序和无秩序的名单.
-   \* 核对表.
-   QQ 自定义起始数 .
-   QQ 自定义计数器类型( 如 . `lower-roman`) (中文(简体) ).
-   最大筑巢级别配置.
-   与 [列表](https://github.com/editor-js/list) 财务报告和审定财务报表 [核对清单](https://github.com/editor-js/checklist)。 。 。 .

![](https://npmcn.com/package/%40editorjs/list/assets/demo.gif)

使用 `Tab` 财务报告和审定财务报表 `Shift+Tab` 键以创建或删除带有编目的子列表.

## 安装

拿到包裹

```shell
yarn add @editorjs/list
```

在您的应用程序中包含模块

```javascript
import EditorjsList from '@editorjs/list';
```

您可以选择从 CDN 装入此工具 [JsDelivr CDN (英语)](https://cdn.jsdelivr.net/npm/@editorjs/list@2)

## 使用量

将列表工具添加到 `tools` 的属性.

```javascript
import EditorJS from '@editorjs/editorjs';
import EditorjsList from '@editorjs/list';

var editor = EditorJS({
  // ...
  tools: {
    ...
    List: {
      class: EditorjsList,
      inlineToolbar: true,
      config: {
        defaultStyle: 'unordered'
      },
    },
  },
});
```

> \[大 注意在列表 2. 0 类名称更改自 `List` 改为 `EditorjsList`。 。 。 .

## 配置参数

| 外地 | 类型 | 说明 |
| --- | --- | --- |
| 默认样式 | `string` | 默认列表样式 : `ordered`, (中文(简体) ), `unordered` 或者说 `checklist`默认值为 `unordered` |
| 最大级别 | `number` | 列表嵌入的最大水平,可设定为 `1` 来禁用巢穴,默认无限制 |
| 反键 | `string[]` | 指定在命令的列表样式中显示哪些对应类型,可设置为 `['numeric','upper-roman']`默认值为 `undefined` 显示所有计数器类型 |

## 产出数据

| 外地 | 类型 | 说明 |
| --- | --- | --- |
| 样式 | `string` | 列表将按此样式显示 : `ordered`, (中文(简体) ), `unordered` 或者说 `checklist`默认值为 `defaultStyle` 从工具配置 |
| 元数据a | `ItemMeta` | 基于列表样式的项目元a |
| 项目 | `Item[]` | 列表项目数组 |

对象 `Item`数字 :

| 外地 | 类型 | 说明 |
| --- | --- | --- |
| 内容 | `string` | 项的字符串内容 |
| 元数据a | `ItemMeta` | 关于项目的信息 |
| 项目 | `Item[]` | 列表项目数组 |

对象 `ItemMeta` 核对列表 :

| 外地 | 类型 | 说明 |
| --- | --- | --- |
| 检查 | `boolean` | 复选框状态 |

对象 `ItemMeta` 排列列表

| 外地 | 类型 | 说明 |
| --- | --- | --- |
| 开始 | `number` | 要从列表开始的编号, 默认值为 1 |
| 计数器 | `string` | 列表的对应类型, 它可能是 `numeric`, (中文(简体) ), `lower-roman`, (中文(简体) ), `upper-roman`, (中文(简体) ), `lower-alpha`, (中文(简体) ), `upper-alpha`默认值为 `numeric` |

对象 `ItemMeta` 对于未排序的列表, 将会是空的 .

## 本地化

如果您想将语言用于工具箱项目, 您可以通过 i18n 字典到工具下面的编辑器实例 `block`数字 :

```javascript
i18n: { 
  messages: {
    "toolNames": {
      "Ordered List": "Nummerierte Liste",
      "Unordered List": "Unnummeriert Liste",
      "Checklist": "Checkliste",
    },
    "tools": {
      "List": {
        'Unordered': 'Unnummeriert',
        'Ordered': 'Nummerierte',
        'Checklist': 'Checkliste',
      }
    },
  },
},
```

### 其他支持的密钥用于 `tools.List`

-   `Start with`
-   `Counter type`
-   `Numeric`
-   `Lower Roman`
-   `Upper Roman`
-   `Lower Alpha`
-   `Upper Alpha`

## 内容示例 `Unordered List`

```json
{
  "type" : "list",
  "data" : {
    "style": "unordered",
    "items": [
      {
        "content": "Apples",
        "meta": {},
        "items": [
          {
            "content": "Red",
            "meta": {},
            "items": []
          },
        ]
      },
    ]
  }
},
```

## 内容示例 `Ordered List`

```json
{
  "type" : "list",
  "data" : {
    "style": "ordered",
    "meta": {
      "start": 2,
      "counterType": "upper-roman",
    },
    "items" : [
      {
        "content": "Apples",
        "meta": {},
        "items": [
          {
            "content": "Red",
            "meta": {},
            "items": []
          },
        ]
      },
    ]
  }
},
```

## 内容示例 `Checklist`

```json
{
  "type" : "list",
  "data" : {
    "style": "checklist",
    "items" : [
      {
        "content": "Apples",
        "meta": {
          "checked": false
        },
        "items": [
          {
            "content": "Red",
            "meta": {
              "checked": true
            },
            "items": []
          },
        ]
      },
    ]
  }
},
```

## 常见问题

### @editorjs/list 是什么？

编辑器的列表工具JS

### 如何安装 @editorjs/list？

在项目目录运行 npm install @editorjs/list，或使用 pnpm add / yarn add / bun add。

### @editorjs/list 支持 TypeScript 吗？

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

### @editorjs/list 支持 ESM 还是 CommonJS？

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

### @editorjs/list 可以商用吗？

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

### @editorjs/list 的下载量有多少？

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

### @editorjs/list 还在维护吗？

最新版本 2\.0\.9 发布于 2025/11/13（1 年前）；至今共发布 25 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/03/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。