CKEditor 生态系统文档
Search
Contribute to this guide
主页/CKEditor 5/功能

指南待办列表

待办列表功能允许您创建带有标签的交互式复选框列表。它支持 项目符号和编号列表 的所有功能，因此您可以将待办列表与任何其他列表组合嵌套在一起。

# 演示

使用待办列表工具栏按钮 待办列表 将列表添加到编辑器内容中。由于与 自动格式化功能 的集成，您也可以用 [ ] 或 [x] 以及一个空格开始一行以插入未选中或已选中的列表项。

华夫饼

Waffles with raspberries and whipped cream.

配料

说明

准备 烹饪 准备好
5 分钟 15 分钟 20 分钟

预热华夫饼机。用手动搅拌器将鸡蛋放入一个大碗中搅拌至蓬松。加入面粉、牛奶、植物油、糖、泡打粉、盐和香草精，搅拌至光滑。

在预热的华夫饼机上喷上不粘烹饪喷雾。将混合物倒入热的华夫饼机上。煮至金黄色。趁热食用。

来源：allrecipes

此演示展示了一组有限的功能。请访问 功能丰富的编辑器示例 以查看更多实际操作。

# 键盘支持

当选择位于该项目中时，您可以使用 Ctrl + Enter (Cmd + Enter 在 Mac 上) 快捷键选中和取消选中列表项。

# 安装

⚠️ 新的导入路径

从 版本 42.0.0 开始，我们更改了导入路径的格式。本指南使用新的、更短的格式。如果您使用的是 CKEditor 5 的旧版本，请参阅 旧版设置中的包 指南。

在 安装编辑器 后，将功能添加到您的插件列表和工具栏配置中

import { TodoList } from 'ckeditor5';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ TodoList, /* ... */ ],
        toolbar: [ 'todoList', /* ... */ ],
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

这些 CKEditor 5 功能提供了类似的功能

  • 有序和无序列表 – 创建具有可配置标记的有序和无序列表。
  • 多级列表 – 多级列表允许用户设置不同的标记（符号、文本或数字）以在列表的每一级显示。
  • 自动格式化 – 使用 Markdown 代码动态格式化文本。

# 通用 API

TodoList 插件注册

# 贡献

该功能的源代码在 GitHub 上的 https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-list 中提供。