Skip to content
This repository was archived by the owner on Jul 5, 2024. It is now read-only.

Upgrade to v41.3.1 #14

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 50 additions & 50 deletions CHANGELOG.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Contributing
========================================

See the [official contributors' guide to CKEditor 5](https://ckeditor.com/docs/ckeditor5/latest/framework/contributing/contributing.html) to learn more.
See the [official contributors' guide to CKEditor 5](https://ckeditor.com/docs/ckeditor5/latest/framework/contributing/contributing.html) to learn more.
6 changes: 3 additions & 3 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Software License Agreement
==========================

**CKEditor 5 list feature** – https://github.com/ckeditor/ckeditor5-list <br>
Copyright (c) 2003-2023, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
**CKEditor&nbsp;5 list feature** – https://github.com/ckeditor/ckeditor5-list <br>
Copyright (c) 2003–2024, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.

Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).

Expand All @@ -14,4 +14,4 @@ Where not otherwise indicated, all CKEditor content is authored by CKSource engi
Trademarks
----------

**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.
**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks, or service marks of their respective holders.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
CKEditor 5 list feature
CKEditor&nbsp;5 list feature
========================================

[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-list.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-list)
[![Coverage Status](https://coveralls.io/repos/github/ckeditor/ckeditor5/badge.svg?branch=master)](https://coveralls.io/github/ckeditor/ckeditor5?branch=master)
[![Build Status](https://travis-ci.com/ckeditor/ckeditor5.svg?branch=master)](https://app.travis-ci.com/github/ckeditor/ckeditor5)
![Dependency Status](https://img.shields.io/librariesio/release/npm/@ckeditor/ckeditor5-list)

This package implements bulleted, numbered and to-do list feature for CKEditor 5.
This package implements bulleted, numbered and to-do list feature for CKEditor&nbsp;5.

## Demo

Check out the demos for [ordered and unordered lists](https://ckeditor.com/docs/ckeditor5/latest/features/lists/lists.html#demo) as well as [to-do list](https://ckeditor.com/docs/ckeditor5/latest/features/lists/todo-lists.html#demo) in the CKEditor 5 documentation.
Check out the demos for [ordered and unordered lists](https://ckeditor.com/docs/ckeditor5/latest/features/lists/lists.html#demo) as well as [to-do list](https://ckeditor.com/docs/ckeditor5/latest/features/lists/todo-lists.html#demo) in the CKEditor&nbsp;5 documentation.

## Documentation

See the [`@ckeditor/ckeditor5-list` package](https://ckeditor.com/docs/ckeditor5/latest/api/list.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
See the [`@ckeditor/ckeditor5-list` package](https://ckeditor.com/docs/ckeditor5/latest/api/list.html) page in [CKEditor&nbsp;5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).

## License

Expand Down
94 changes: 69 additions & 25 deletions ckeditor5-metadata.json
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
{
"plugins": [
{
"name": "List",
"className": "List",
"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/list.js",
"path": "src/legacylist.js",
"uiComponents": [
{
"type": "Button",
"name": "numberedList",
"iconPath": "theme/icons/numberedlist.svg"
"iconPath": "@ckeditor/ckeditor5-core/theme/icons/numberedlist.svg"
},
{
"type": "Button",
"name": "bulletedList",
"iconPath": "theme/icons/bulletedlist.svg"
"iconPath": "@ckeditor/ckeditor5-core/theme/icons/bulletedlist.svg"
}
],
"htmlOutput": [
Expand All @@ -32,16 +32,16 @@
]
},
{
"name": "To-do list",
"className": "TodoList",
"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/todolist",
"path": "src/legacytodolist",
"uiComponents": [
{
"type": "Button",
"name": "todoList",
"iconPath": "theme/icons/todolist.svg"
"iconPath": "@ckeditor/ckeditor5-core/theme/icons/todolist.svg"
}
],
"htmlOutput": [
Expand Down Expand Up @@ -71,13 +71,13 @@
]
},
{
"name": "List properties",
"className": "ListProperties",
"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 start index (initial marker value) and list reversal (from ascending to descending) for numbered lists. ",
"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/listproperties.js",
"path": "src/legacylistproperties.js",
"requires": [
"List"
"LegacyList"
],
"htmlOutput": [
{
Expand All @@ -94,20 +94,21 @@
]
},
{
"name": "Document list",
"className": "DocumentList",
"description": "Implements bulleted and numbered list features. Supports block content inside list elements. Incompatible with the List plugin.",
"path": "src/documentlist.js",
"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": "theme/icons/numberedlist.svg"
"iconPath": "@ckeditor/ckeditor5-core/theme/icons/numberedlist.svg"
},
{
"type": "Button",
"name": "bulletedList",
"iconPath": "theme/icons/bulletedlist.svg"
"iconPath": "@ckeditor/ckeditor5-core/theme/icons/bulletedlist.svg"
}
],
"htmlOutput": [
Expand All @@ -123,12 +124,55 @@
]
},
{
"name": "Document list properties",
"className": "DocumentListProperties",
"description": "Enables styling the list item markers for both ordered and unordered lists created by the document list plugin. You can choose various types of numerals and letters or visual markers to use with these lists. Also enables setting start index (initial marker value) and list reversal (from ascending to descending) for numbered lists.",
"path": "src/documentlistproperties.js",
"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": [
"DocumentList"
"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": [
{
Expand Down
21 changes: 0 additions & 21 deletions docs/_snippets/features/lists-basic.html
Original file line number Diff line number Diff line change
@@ -1,21 +0,0 @@
<div id="snippet-lists-basic">
<h2>Ingredients</h2>
<figure>
<img class="image image_resized image-style-align-right" src="%BASE_PATH%/assets/img/coffee.jpg">
</figure>
<p>Ingredients required for making a cup of coffee:</p>
<ul>
<li>15&nbsp;g ground coffee</li>
<li>water</li>
<li>milk <i>(optional)</i></li>
</ul>
<h2>Instructions</h2>
<p>How to prepare a cup of coffee:</p>
<ol>
<li>Gather the ingredients.</li>
<li>Put 15&nbsp;g of ground coffee in the cup.</li>
<li>Boil 200&nbsp;ml of water.</li>
<li>Pour the water into the cup.</li>
<li>Optional: Add milk.</li>
</ol>
</div>
16 changes: 12 additions & 4 deletions docs/_snippets/features/lists-basic.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
/**
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/

/* globals window, document, console, ClassicEditor, ImageResize, ListProperties */

import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config';
import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config.js';
import { TOKEN_URL } from '@ckeditor/ckeditor5-ckbox/tests/_utils/ckbox-config.js';

ClassicEditor
.create( document.querySelector( '#snippet-lists-basic' ), {
Expand All @@ -14,7 +15,7 @@ ClassicEditor
items: [
'undo', 'redo', '|', 'heading',
'|', 'bold', 'italic',
'|', 'link', 'uploadImage', 'insertTable', 'mediaEmbed',
'|', 'link', 'insertImage', 'insertTable', 'mediaEmbed',
'|', 'bulletedList', 'numberedList', 'outdent', 'indent'
]
},
Expand All @@ -23,14 +24,21 @@ ClassicEditor
top: window.getViewportTopOffsetConfig()
}
},
ckbox: {
tokenUrl: TOKEN_URL,
allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ],
forceDemoLabel: true
},
image: {
toolbar: [
'imageStyle:inline',
'imageStyle:wrapText',
'imageStyle:breakText',
'|',
'toggleImageCaption',
'imageTextAlternative'
'imageTextAlternative',
'|',
'ckboxImageEdit'
]
},
table: {
Expand Down
2 changes: 1 addition & 1 deletion docs/_snippets/features/lists-document.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div id="snippet-lists-document">
<div class="ck ck-content" id="snippet-lists-document">
<h2>Top five places to visit this summer</h2>
<h3>...and stay on the budget.</h3>
<ol>
Expand Down
25 changes: 15 additions & 10 deletions docs/_snippets/features/lists-document.js
Original file line number Diff line number Diff line change
@@ -1,39 +1,44 @@
/**
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/

/* globals window, document, console, ClassicEditor, DocumentList, DocumentListProperties, ImageResize */
/* globals window, document, console, ClassicEditor, ListProperties, TodoList, ImageResize */

import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config';

/* import { DocumentList } from '@ckeditor/ckeditor5-list'; */
import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config.js';
import { TOKEN_URL } from '@ckeditor/ckeditor5-ckbox/tests/_utils/ckbox-config.js';

ClassicEditor
.create( document.querySelector( '#snippet-lists-document' ), {
removePlugins: [ 'List' ],
extraPlugins: [ DocumentList, DocumentListProperties, ImageResize ],
extraPlugins: [ ListProperties, TodoList, ImageResize ],
toolbar: {
items: [
'undo', 'redo', '|', 'heading',
'|', 'bold', 'italic',
'|', 'link', 'uploadImage', 'insertTable', 'mediaEmbed',
'|', 'bulletedList', 'numberedList', 'outdent', 'indent'
'|', 'link', 'insertImage', 'insertTable', 'mediaEmbed',
'|', 'bulletedList', 'numberedList', 'todoList', 'outdent', 'indent'
]
},
ui: {
viewportOffset: {
top: window.getViewportTopOffsetConfig()
}
},
ckbox: {
tokenUrl: TOKEN_URL,
allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ],
forceDemoLabel: true
},
image: {
toolbar: [
'imageStyle:inline',
'imageStyle:wrapText',
'imageStyle:breakText',
'|',
'toggleImageCaption',
'imageTextAlternative'
'imageTextAlternative',
'|',
'ckboxImageEdit'
]
},
table: {
Expand Down
2 changes: 1 addition & 1 deletion docs/_snippets/features/lists-index.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div id="snippet-lists-index">
<div class="ck ck-content" id="snippet-lists-index">
<h2>A list of human spacecraft</h2>
<p>Soviet and Russian spaceships:</p>

Expand Down
16 changes: 12 additions & 4 deletions docs/_snippets/features/lists-index.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
/**
* @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/

/* globals window, document, console, ClassicEditor, ListProperties */

import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config';
import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config.js';
import { TOKEN_URL } from '@ckeditor/ckeditor5-ckbox/tests/_utils/ckbox-config.js';

ClassicEditor
.create( document.querySelector( '#snippet-lists-index' ), {
Expand All @@ -14,7 +15,7 @@ ClassicEditor
items: [
'undo', 'redo', '|', 'heading',
'|', 'bold', 'italic',
'|', 'link', 'uploadImage', 'insertTable', 'mediaEmbed',
'|', 'link', 'insertImage', 'insertTable', 'mediaEmbed',
'|', 'bulletedList', 'numberedList', 'outdent', 'indent'
]
},
Expand All @@ -23,14 +24,21 @@ ClassicEditor
top: window.getViewportTopOffsetConfig()
}
},
ckbox: {
tokenUrl: TOKEN_URL,
allowExternalImagesEditing: [ /^data:/, 'origin', /ckbox/ ],
forceDemoLabel: true
},
image: {
toolbar: [
'imageStyle:inline',
'imageStyle:wrapText',
'imageStyle:breakText',
'|',
'toggleImageCaption',
'imageTextAlternative'
'imageTextAlternative',
'|',
'ckboxImageEdit'
]
},
table: {
Expand Down
2 changes: 1 addition & 1 deletion docs/_snippets/features/lists-reversed.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div id="snippet-lists-reversed">
<div class="ck ck-content" id="snippet-lists-reversed">
<h2>Replacing the screen of your Nintendo Game Boy</h2>
<figure class="image image-style-side">
<img src="../../assets/img/gbc.jpg" alt="Game Boy Color, a spudger and a triwing screwdriver.">
Expand Down
Loading