UNPKG

@ckeditor/ckeditor5-list

Version:

Ordered and unordered lists feature to CKEditor 5.

297 lines (296 loc) • 8.36 kB
{ "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-icons/theme/icons/numbered-list.svg" }, { "type": "Button", "name": "bulletedList", "iconPath": "@ckeditor/ckeditor5-icons/theme/icons/bulleted-list.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-icons/theme/icons/todo-list.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-icons/theme/icons/numbered-list.svg" }, { "type": "Button", "name": "bulletedList", "iconPath": "@ckeditor/ckeditor5-icons/theme/icons/bulleted-list.svg" } ], "htmlOutput": [ { "elements": [ "ol", "ul" ] }, { "elements": "li" } ] }, { "name": "List formatting", "className": "ListFormatting", "description": "Enables integration with formatting plugins to style the list marker. Supports font color, font size, font family, bold, and italic formatting.", "docs": "features/lists/lists.html#list-item-marker-formatting", "path": "src/listformatting.js", "requires": [ "ListItemBoldIntegration", "ListItemItalicIntegration", "ListItemFontSizeIntegration", "ListItemFontColorIntegration", "ListItemFontFamilyIntegration" ] }, { "name": "List item bold integration", "className": "ListItemBoldIntegration", "description": "Integrates bold formatting with list items to style list markers with bold formatting when the content is consistently bold.", "docs": "features/lists/lists.html#list-item-marker-formatting", "path": "src/listformatting/listitemboldintegration.js", "requires": [ "ListEditing" ], "htmlOutput": [ { "elements": "li", "classes": "ck-list-marker-bold" } ] }, { "name": "List item italic integration", "className": "ListItemItalicIntegration", "description": "Integrates italic formatting with list items to style list markers with italic formatting when the content is consistently italic.", "docs": "features/lists/lists.html#list-item-marker-formatting", "path": "src/listformatting/listitemitalicintegration.js", "requires": [ "ListEditing" ], "htmlOutput": [ { "elements": "li", "classes": "ck-list-marker-italic" } ] }, { "name": "List item font size integration", "className": "ListItemFontSizeIntegration", "description": "Integrates font size formatting with list items to style list markers with specific font sizes when the content has consistent font sizing.", "docs": "features/lists/lists.html#list-item-marker-formatting", "path": "src/listformatting/listitemfontsizeintegration.js", "requires": [ "ListEditing" ], "htmlOutput": [ { "elements": "li", "classes": [ "ck-list-marker-font-size", "ck-list-marker-font-size-tiny", "ck-list-marker-font-size-small", "ck-list-marker-font-size-big", "ck-list-marker-font-size-huge" ], "styles": "--ck-content-list-marker-font-size" } ] }, { "name": "List item font color integration", "className": "ListItemFontColorIntegration", "description": "Integrates font color formatting with list items to style list markers with specific colors when the content has consistent font coloring.", "docs": "features/lists/lists.html#list-item-marker-formatting", "path": "src/listformatting/listitemfontcolorintegration.js", "requires": [ "ListEditing" ], "htmlOutput": [ { "elements": "li", "classes": "ck-list-marker-color", "styles": "--ck-content-list-marker-color" } ] }, { "name": "List item font family integration", "className": "ListItemFontFamilyIntegration", "description": "Integrates font family formatting with list items to style list markers with specific font families when the content has consistent font family formatting.", "docs": "features/lists/lists.html#list-item-marker-formatting", "path": "src/listformatting/listitemfontfamilyintegration.js", "requires": [ "ListEditing" ], "htmlOutput": [ { "elements": "li", "classes": "ck-list-marker-font-family", "styles": "--ck-content-list-marker-font-family" } ] }, { "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-icons/theme/icons/todo-list.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" } ] } ] }