编辑器列表工具
- * * * 部分内容 编辑.js 生态系统.
- - 内斯丁.
- {\fn黑体\fs22\bord1\shad0\3aHBE\4aH00\fscx67\fscy66\2cHFFFFFF\3cH808080}有秩序和无秩序的名单.
- * 核对表.
- QQ 自定义起始数 .
- QQ 自定义计数器类型( 如 .
lower-roman) (中文(简体) ). - 最大筑巢级别配置.
- 与 列表 财务报告和审定财务报表 核对清单。 。 。 .
使用 Tab 财务报告和审定财务报表 Shift+Tab 键以创建或删除带有编目的子列表.
安装
拿到包裹
yarn add @editorjs/list
在您的应用程序中包含模块
import EditorjsList from '@editorjs/list';
您可以选择从 CDN 装入此工具 JsDelivr CDN (英语)
使用量
将列表工具添加到 tools 的属性.
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数字 :
i18n: {
messages: {
"toolNames": {
"Ordered List": "Nummerierte Liste",
"Unordered List": "Unnummeriert Liste",
"Checklist": "Checkliste",
},
"tools": {
"List": {
'Unordered': 'Unnummeriert',
'Ordered': 'Nummerierte',
'Checklist': 'Checkliste',
}
},
},
},
其他支持的密钥用于 tools.List
Start withCounter typeNumericLower RomanUpper RomanLower AlphaUpper Alpha
内容示例 Unordered List
{
"type" : "list",
"data" : {
"style": "unordered",
"items": [
{
"content": "Apples",
"meta": {},
"items": [
{
"content": "Red",
"meta": {},
"items": []
},
]
},
]
}
},
内容示例 Ordered List
{
"type" : "list",
"data" : {
"style": "ordered",
"meta": {
"start": 2,
"counterType": "upper-roman",
},
"items" : [
{
"content": "Apples",
"meta": {},
"items": [
{
"content": "Red",
"meta": {},
"items": []
},
]
},
]
}
},
内容示例 Checklist
{
"type" : "list",
"data" : {
"style": "checklist",
"items" : [
{
"content": "Apples",
"meta": {
"checked": false
},
"items": [
{
"content": "Red",
"meta": {
"checked": true
},
"items": []
},
]
},
]
}
},