@ckeditor/ckeditor5-list
Version:
Ordered and unordered lists feature to CKEditor 5.
194 lines (193 loc) • 4.82 kB
JSON
{
"plugins": [
{
"name": "Legacy list",
"className": "LegacyList",
"description": "Implements bulleted and numbered list features. Add the to-do list plugin to bring support for inserting interactive checkboxes.",
"docs": "features/lists/lists.html",
"path": "src/legacylist.js",
"uiComponents": [
{
"type": "Button",
"name": "numberedList",
"iconPath": "@ckeditor/ckeditor5-core/theme/icons/numberedlist.svg"
},
{
"type": "Button",
"name": "bulletedList",
"iconPath": "@ckeditor/ckeditor5-core/theme/icons/bulletedlist.svg"
}
],
"htmlOutput": [
{
"elements": [
"ol",
"ul"
]
},
{
"elements": "li",
"implements": "$block"
}
]
},
{
"name": "Legacy to-do list",
"className": "LegacyTodoList",
"description": "Allows for creating a list of interactive checkboxes with labels. It supports all features of regular lists so you can nest a to-do list together with bulleted and numbered lists in any combination.",
"docs": "features/lists/todo-lists.html",
"path": "src/legacytodolist",
"uiComponents": [
{
"type": "Button",
"name": "todoList",
"iconPath": "@ckeditor/ckeditor5-core/theme/icons/todolist.svg"
}
],
"htmlOutput": [
{
"elements": "ul",
"classes": "todo-list"
},
{
"elements": "li"
},
{
"elements": "label",
"classes": "todo-list__label"
},
{
"elements": "span",
"classes": "todo-list__label__description"
},
{
"elements": "input",
"attributes": [
"checked",
"disabled",
"type"
]
}
]
},
{
"name": "Legacy list properties",
"className": "LegacyListProperties",
"description": "Enables styling the list item markers for both ordered and unordered lists. You can choose various types of numerals and letters or visual markers to use with these lists. Also enables setting the start index (initial marker value) and list reversal (from ascending to descending) for numbered lists.",
"docs": "features/lists/lists.html#list-styles",
"path": "src/legacylistproperties.js",
"requires": [
"LegacyList"
],
"htmlOutput": [
{
"elements": [
"ol",
"ul"
],
"attributes": [
"start",
"reversed"
],
"styles": "list-style-type"
}
]
},
{
"name": "List",
"className": "List",
"description": "Implements bulleted and numbered list features. Supports block content inside list elements. Incompatible with the LegacyList plugin.",
"docs": "features/lists/lists.html",
"path": "src/list.js",
"uiComponents": [
{
"type": "Button",
"name": "numberedList",
"iconPath": "@ckeditor/ckeditor5-core/theme/icons/numberedlist.svg"
},
{
"type": "Button",
"name": "bulletedList",
"iconPath": "@ckeditor/ckeditor5-core/theme/icons/bulletedlist.svg"
}
],
"htmlOutput": [
{
"elements": [
"ol",
"ul"
]
},
{
"elements": "li"
}
]
},
{
"name": "To-do list",
"className": "TodoList",
"description": "Allows for creating a list of interactive checkboxes with labels. Supports all features of lists so you can nest a to-do list together with bulleted and numbered lists in any combination.",
"docs": "features/lists/todo-lists.html",
"path": "src/todolist.js",
"requires": [
"List"
],
"uiComponents": [
{
"type": "Button",
"name": "todoList",
"iconPath": "@ckeditor/ckeditor5-core/theme/icons/todolist.svg"
}
],
"htmlOutput": [
{
"elements": "ul",
"classes": "todo-list"
},
{
"elements": "li"
},
{
"elements": "label",
"classes": [ "todo-list__label", "todo-list__label_without-description" ]
},
{
"elements": "span",
"classes": "todo-list__label__description"
},
{
"elements": "input",
"attributes": [
"checked",
"disabled",
"type"
]
}
]
},
{
"name": "List properties",
"className": "ListProperties",
"description": "Enables styling the list item markers for both ordered and unordered lists created by the list plugin. You can choose various types of numerals and letters or visual markers to use with these lists. Also enables setting the start index (initial marker value) and list reversal (from ascending to descending) for numbered lists.",
"docs": "features/lists/lists.html#list-properties",
"path": "src/listproperties.js",
"requires": [
"List"
],
"htmlOutput": [
{
"elements": [
"ol",
"ul"
],
"attributes": [
"start",
"reversed",
"type"
],
"styles": "list-style-type"
}
]
}
]
}