指南多级列表

具有法律样式编号功能的多级列表允许轻松创建和修改带有计数器(1、1.1、1.1.1)的编号列表。这些对于复杂文档中的清晰引用和层次结构组织至关重要。该功能与 Microsoft Word 完全兼容。当带有此类格式的列表使用 从 Office 粘贴增强 功能粘贴到编辑器时,将保留编号格式。

这是一个高级功能,您需要在 CKEditor 5 商业许可证之外获得它的许可证。 联系我们 以获取满足您需求的报价。

您也可以注册 CKEditor 高级功能 30 天免费试用 来测试此功能。

# 演示

载人航天器的列表

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

# 其他功能信息

# 多级列表中的标题

多级列表支持列表项中的标题。标记(表示计数器)将自动插入标题块以实现更相似的样式。

虽然可以创建带有编号标题列表的法律文档,但长篇文档的编辑可能不是最佳体验。您可能需要对 Microsoft Word 在多级列表界面中放置的 **编号标题功能** 提供完全支持。我们还没有,但如果您有兴趣,请在 此 GitHub 问题 或通过我们的支持告诉我们。

# 自定义多级列表样式

目前,我们提供了一种多级列表样式:法律样式编号。但这一步为我们打开了未来添加更多样式或允许集成商创建自己样式的可能性。如果您有兴趣,请在 这个 GitHub 问题 或通过我们的支持告知我们。

# 安装

⚠️ 新的导入路径

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

请注意,此插件需要 基本的 List 插件 才能正常工作。

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

import { List } from 'ckeditor5';
import { MultiLevelList } from 'ckeditor5-premium-features';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ List, MultiLevelList, /* ... */ ],
        toolbar: [ 'multiLevelList', /* ... */ ],
        licenseKey: '<YOUR_LICENSE_KEY>' // provide proper authentication (see below)
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

阅读有关 安装插件工具栏配置 的更多信息。

# 激活功能

要使用此高级功能,您需要使用正确的凭据激活它。有关详细信息,请参阅 许可证密钥和激活 指南。

# 通用 API

The MultiLevelList 注册

  • The 'multiLevelList' UI 下拉菜单组件。
  • The 'multiLevelList' 命令由 MultiLevelListCommand 实现。

您可以使用 editor.execute() 方法执行命令

// Change selected content to multi level list.
editor.execute( 'multiLevelList' );

我们建议在开发和调试中使用官方的 CKEditor 5 检查器。它将为您提供有关编辑器状态的大量有用信息,例如内部数据结构、选择、命令等等。