ListKit · 列表预设
组合 BulletList、OrderedList、ListItem 与 ListKeymap。StarterKit 已包含这些组件,完整安装 StarterKit 时无需再安装 ListKit。
组合 BulletList、OrderedList、ListItem 与 ListKeymap。StarterKit 已包含这些组件,完整安装 StarterKit 时无需再安装 ListKit。
@quirekit/extension-list · MIT
编辑器适用范围
层次:共享文档能力
| 编辑器 | 状态 | 所需装配与边界 |
|---|---|---|
| Classic | 直接支持 | classicEditorPreset — 使用产品中立的 classicEditorPreset;已有能力由预设装配,不要重复追加。Word 预设会替换段落、标题和容器列表,不能把通用结构直接叠加到 Word 模型。 |
| Block | 直接支持 | createBlockEditorPreset — createBlockEditor 默认预设已装配此能力。通过 preset 中对应子项配置;图形编辑使用预设注入的工作区,宿主仍负责保存和资源。不要重复安装同名扩展。 |
“直接支持”指已有上述产品装配;具体交互、宿主服务和格式支持仍有各自条件。状态与接入规则。许可独立显示。
接入
pnpm add @quirekit/extension-list@alpha
在创建 Editor 时放入 extensions。挂载容器、视图和保存由宿主提供,见快速开始。
import { ListKit } from '@quirekit/extension-list'
const lists = ListKit.configure({ orderedList: false })
安装时按包声明选择兼容版本,外部可用版本以分发源为准。本站使用工作区 Alpha;许可标签来自入口所属包,使用条件见支持与许可。
按编辑器接入
以下片段沿用已挂载的宿主元素 element,宿主负责容器尺寸与保存;退出页面时调用 instance.destroy()。已有预设装配的能力不要再重复追加;需要宿主端口的入口应先完成下方配置。
Classic · 直接支持
使用产品中立的 classicEditorPreset;已有能力由预设装配,不要重复追加。Word 预设会替换段落、标题和容器列表,不能把通用结构直接叠加到 Word 模型。
classicEditorPresetimport { createClassicEditor } from '@quirekit/classic-editor'
import '@quirekit/classic-editor/styles.css'
const instance = createClassicEditor({ element })Block · 直接支持
createBlockEditor 默认预设已装配此能力。通过 preset 中对应子项配置;图形编辑使用预设注入的工作区,宿主仍负责保存和资源。不要重复安装同名扩展。
createBlockEditorPresetimport { createBlockEditor } from '@quirekit/block-editor'
import '@quirekit/block-editor/styles.css'
const instance = createBlockEditor({
element,
content: { type: 'doc', content: [{ type: 'paragraph' }] },
})配置
下面是扩展自身的默认选项。预设可以覆盖这些值;它们不等于当前文档属性。配置方法见配置插件。
bulletList
配置 BulletList 子扩展;允许 false 时可关闭此项。
类型:false | Partial<BulletListOptions>
默认:{}
子扩展的具体选项见 BulletList。是否可以设为 false,以本字段类型为准。
listItem
配置 ListItem 子扩展;允许 false 时可关闭此项。
类型:false | Partial<ListItemOptions>
默认:{}
子扩展的具体选项见 ListItem。是否可以设为 false,以本字段类型为准。
listKeymap
配置 ListKeymap 子扩展;允许 false 时可关闭此项。
类型:false | Partial<ListKeymapOptions>
默认:{}
子扩展的具体选项见 ListKeymap。是否可以设为 false,以本字段类型为准。
orderedList
配置 OrderedList 子扩展;允许 false 时可关闭此项。
类型:false | Partial<OrderedListOptions>
默认:{}
子扩展的具体选项见 OrderedList。是否可以设为 false,以本字段类型为准。
命令与运行方式
此入口没有直接声明可枚举的命令。组合扩展的命令由子扩展提供;产品插件通过 contribution 或文件服务工作。不能把安装入口名称当作命令调用。