@ckeditor/ckeditor5-list 45.2.1 → 46.0.0-alpha.0

package/src/todolist/todocheckboxchangeobserver.d.ts

@@ -5,14 +5,16 @@
 /**
  * @module list/todolist/todocheckboxchangeobserver
  */
-import { DomEventObserver, type DomEventData } from 'ckeditor5/src/engine.js';
+import { DomEventObserver, type ViewDocumentDomEventData } from 'ckeditor5/src/engine.js';
 /**
  * Observes all to-do list checkboxes state changes.
  *
  * Note that this observer is not available by default. To make it available it needs to be added to
- * {@link module:engine/view/view~View} by {@link module:engine/view/view~View#addObserver} method.
+ * {@link module:engine/view/view~EditingView} by {@link module:engine/view/view~EditingView#addObserver} method.
+ *
+ * @internal
  */
-export default class TodoCheckboxChangeObserver extends DomEventObserver<'change'> {
+export declare class TodoCheckboxChangeObserver extends DomEventObserver<'change'> {
     /**
      * @inheritDoc
      */
@@ -29,13 +31,13 @@ export default class TodoCheckboxChangeObserver extends DomEventObserver<'change
  *
  * Note that this event is not available by default. To make it available,
  * {@link module:list/todolist/todocheckboxchangeobserver~TodoCheckboxChangeObserver}
- * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
+ * needs to be added to {@link module:engine/view/view~EditingView} by the {@link module:engine/view/view~EditingView#addObserver} method.
  *
  * @see module:list/todolist/todocheckboxchangeobserver~TodoCheckboxChangeObserver
- * @eventName module:engine/view/document~Document#todoCheckboxChange
+ * @eventName module:engine/view/document~ViewDocument#todoCheckboxChange
  * @param data The event data.
  */
 export type ViewDocumentTodoCheckboxChangeEvent = {
     name: 'todoCheckboxChange';
-    args: [data: DomEventData<Event>];
+    args: [data: ViewDocumentDomEventData<Event>];
 };

package/src/todolist/todocheckboxchangeobserver.js

@@ -10,9 +10,11 @@ import { DomEventObserver } from 'ckeditor5/src/engine.js';
  * Observes all to-do list checkboxes state changes.
  *
  * Note that this observer is not available by default. To make it available it needs to be added to
- * {@link module:engine/view/view~View} by {@link module:engine/view/view~View#addObserver} method.
+ * {@link module:engine/view/view~EditingView} by {@link module:engine/view/view~EditingView#addObserver} method.
+ *
+ * @internal
  */
-export default class TodoCheckboxChangeObserver extends DomEventObserver {
+export class TodoCheckboxChangeObserver extends DomEventObserver {
     /**
      * @inheritDoc
      */

package/src/todolist/todolistediting.d.ts

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 import { Plugin } from 'ckeditor5/src/core.js';
-import ListEditing from '../list/listediting.js';
+import { ListEditing } from '../list/listediting.js';
 /**
  * The engine of the to-do list feature. It handles creating, editing and removing to-do lists and their items.
  *
@@ -13,7 +13,7 @@ import ListEditing from '../list/listediting.js';
  * - `'todoList'`,
  * - `'checkTodoList'`,
  */
-export default class TodoListEditing extends Plugin {
+export declare class TodoListEditing extends Plugin {
     /**
      * @inheritDoc
      */

package/src/todolist/todolistediting.js

@@ -9,10 +9,10 @@ import { Matcher } from 'ckeditor5/src/engine.js';
 import { getCode, parseKeystroke, getLocalizedArrowKeyCodeDirection } from 'ckeditor5/src/utils.js';
 import { Plugin } from 'ckeditor5/src/core.js';
 import { getAllListItemBlocks, isFirstBlockOfListItem, isListItemBlock } from '../list/utils/model.js';
-import ListEditing from '../list/listediting.js';
-import ListCommand from '../list/listcommand.js';
-import CheckTodoListCommand from './checktodolistcommand.js';
-import TodoCheckboxChangeObserver from './todocheckboxchangeobserver.js';
+import { ListEditing } from '../list/listediting.js';
+import { ListCommand } from '../list/listcommand.js';
+import { CheckTodoListCommand } from './checktodolistcommand.js';
+import { TodoCheckboxChangeObserver } from './todocheckboxchangeobserver.js';
 const ITEM_TOGGLE_KEYSTROKE = /* #__PURE__ */ parseKeystroke('Ctrl+Enter');
 /**
  * The engine of the to-do list feature. It handles creating, editing and removing to-do lists and their items.
@@ -23,7 +23,7 @@ const ITEM_TOGGLE_KEYSTROKE = /* #__PURE__ */ parseKeystroke('Ctrl+Enter');
  * - `'todoList'`,
  * - `'checkTodoList'`,
  */
-export default class TodoListEditing extends Plugin {
+export class TodoListEditing extends Plugin {
     /**
      * @inheritDoc
      */

package/src/todolist/todolistui.d.ts

@@ -7,7 +7,7 @@ import { Plugin } from 'ckeditor5/src/core.js';
  * The to-do list UI feature. It introduces the `'todoList'` button that
  * allows to convert elements to and from to-do list items and to indent or outdent them.
  */
-export default class TodoListUI extends Plugin {
+export declare class TodoListUI extends Plugin {
     /**
      * @inheritDoc
      */

package/src/todolist/todolistui.js

@@ -12,7 +12,7 @@ import { IconTodoList } from 'ckeditor5/src/icons.js';
  * The to-do list UI feature. It introduces the `'todoList'` button that
  * allows to convert elements to and from to-do list items and to indent or outdent them.
  */
-export default class TodoListUI extends Plugin {
+export class TodoListUI extends Plugin {
     /**
      * @inheritDoc
      */

package/src/todolist.d.ts

@@ -5,8 +5,8 @@
 /**
  * @module list/todolist
  */
-import TodoListEditing from './todolist/todolistediting.js';
-import TodoListUI from './todolist/todolistui.js';
+import { TodoListEditing } from './todolist/todolistediting.js';
+import { TodoListUI } from './todolist/todolistui.js';
 import { Plugin } from 'ckeditor5/src/core.js';
 import '../theme/todolist.css';
 /**
@@ -15,7 +15,7 @@ import '../theme/todolist.css';
  * This is a "glue" plugin that loads the {@link module:list/todolist/todolistediting~TodoListEditing to-do list
  * editing feature} and the {@link module:list/todolist/todolistui~TodoListUI to-do list UI feature}.
  */
-export default class TodoList extends Plugin {
+export declare class TodoList extends Plugin {
     /**
      * @inheritDoc
      */

package/src/todolist.js

@@ -5,8 +5,8 @@
 /**
  * @module list/todolist
  */
-import TodoListEditing from './todolist/todolistediting.js';
-import TodoListUI from './todolist/todolistui.js';
+import { TodoListEditing } from './todolist/todolistediting.js';
+import { TodoListUI } from './todolist/todolistui.js';
 import { Plugin } from 'ckeditor5/src/core.js';
 import '../theme/todolist.css';
 /**
@@ -15,7 +15,7 @@ import '../theme/todolist.css';
  * This is a "glue" plugin that loads the {@link module:list/todolist/todolistediting~TodoListEditing to-do list
  * editing feature} and the {@link module:list/todolist/todolistui~TodoListUI to-do list UI feature}.
  */
-export default class TodoList extends Plugin {
+export class TodoList extends Plugin {
     /**
      * @inheritDoc
      */

package/theme/listformatting.css

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+ */
+
+:root {
+	--ck-content-list-marker-color: var(--ck-content-font-color);
+	--ck-content-list-marker-font-family: var(--ck-content-font-family);
+	--ck-content-list-marker-font-size: var(--ck-content-font-size);
+}
+
+.ck-content li {
+	&.ck-list-marker-bold::marker {
+		font-weight: bold;
+	}
+
+	&.ck-list-marker-italic::marker {
+		font-style: italic;
+	}
+
+	&.ck-list-marker-color::marker {
+		color: var(--ck-content-list-marker-color);
+	}
+
+	&.ck-list-marker-font-family::marker {
+		font-family: var(--ck-content-list-marker-font-family);
+	}
+
+	&.ck-list-marker-font-size::marker {
+		font-size: var(--ck-content-list-marker-font-size);
+	}
+
+	&.ck-list-marker-font-size-tiny::marker {
+		font-size: var(--ck-content-font-size-tiny);
+	}
+
+	&.ck-list-marker-font-size-small::marker {
+		font-size: var(--ck-content-font-size-small);
+	}
+
+	&.ck-list-marker-font-size-big::marker {
+		font-size: var(--ck-content-font-size-big);
+	}
+
+	&.ck-list-marker-font-size-huge::marker {
+		font-size: var(--ck-content-font-size-huge);
+	}
+}

package/theme/todolist.css

@@ -4,15 +4,15 @@
  */
 
 :root {
-	--ck-todo-list-checkmark-size: 16px;
+	--ck-content-todo-list-checkmark-size: 16px;
 }
 
 @define-mixin todo-list-checkbox {
 	-webkit-appearance: none;
 	display: inline-block;
 	position: relative;
-	width: var(--ck-todo-list-checkmark-size);
-	height: var(--ck-todo-list-checkmark-size);
+	width: var(--ck-content-todo-list-checkmark-size);
+	height: var(--ck-content-todo-list-checkmark-size);
 	vertical-align: middle;
 
 	/* Needed on iOS */
@@ -56,13 +56,13 @@
 		content: '';
 
 		/* Calculate tick position, size and border-width proportional to the checkmark size. */
-		left: calc( var(--ck-todo-list-checkmark-size) / 3 );
-		top: calc( var(--ck-todo-list-checkmark-size) / 5.3 );
-		width: calc( var(--ck-todo-list-checkmark-size) / 5.3 );
-		height: calc( var(--ck-todo-list-checkmark-size) / 2.6 );
+		left: calc( var(--ck-content-todo-list-checkmark-size) / 3 );
+		top: calc( var(--ck-content-todo-list-checkmark-size) / 5.3 );
+		width: calc( var(--ck-content-todo-list-checkmark-size) / 5.3 );
+		height: calc( var(--ck-content-todo-list-checkmark-size) / 2.6 );
 		border-style: solid;
 		border-color: transparent;
-		border-width: 0 calc( var(--ck-todo-list-checkmark-size) / 8 ) calc( var(--ck-todo-list-checkmark-size) / 8 ) 0;
+		border-width: 0 calc( var(--ck-content-todo-list-checkmark-size) / 8 ) calc( var(--ck-content-todo-list-checkmark-size) / 8 ) 0;
 		transform: rotate(45deg);
 	}
 

package/src/documentlist.d.ts

@@ -1,32 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module list/documentlist
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import List from './list.js';
-/**
- * The document list feature.
- *
- * This is an obsolete plugin that exists for backward compatibility only.
- * Use the {@link module:list/list~List `List`} instead.
- *
- * @deprecated
- */
-export default class DocumentList extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof List];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "DocumentList";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    constructor(editor: Editor);
-}

package/src/documentlist.js

@@ -1,47 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module list/documentlist
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { logWarning } from 'ckeditor5/src/utils.js';
-import List from './list.js';
-/**
- * The document list feature.
- *
- * This is an obsolete plugin that exists for backward compatibility only.
- * Use the {@link module:list/list~List `List`} instead.
- *
- * @deprecated
- */
-export default class DocumentList extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [List];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'DocumentList';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    constructor(editor) {
-        super(editor);
-        /**
-         * The `DocumentList` plugin is obsolete. Use `List` instead.
-         *
-         * @error plugin-obsolete-documentlist
-         */
-        logWarning('plugin-obsolete-documentlist', { pluginName: 'DocumentList' });
-    }
-}

package/src/documentlistproperties.d.ts

@@ -1,32 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module list/documentlistproperties
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import ListProperties from './listproperties.js';
-/**
- * The document list properties feature.
- *
- * This is an obsolete plugin that exists for backward compatibility only.
- * Use the {@link module:list/listproperties~ListProperties `ListProperties`} instead.
- *
- * @deprecated
- */
-export default class DocumentListProperties extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ListProperties];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "DocumentListProperties";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    constructor(editor: Editor);
-}

package/src/documentlistproperties.js

@@ -1,47 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module list/documentlistproperties
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { logWarning } from 'ckeditor5/src/utils.js';
-import ListProperties from './listproperties.js';
-/**
- * The document list properties feature.
- *
- * This is an obsolete plugin that exists for backward compatibility only.
- * Use the {@link module:list/listproperties~ListProperties `ListProperties`} instead.
- *
- * @deprecated
- */
-export default class DocumentListProperties extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [ListProperties];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'DocumentListProperties';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    constructor(editor) {
-        super(editor);
-        /**
-         * The `DocumentListProperties` plugin is obsolete. Use `ListProperties` instead.
-         *
-         * @error plugin-obsolete-documentlistproperties
-         */
-        logWarning('plugin-obsolete-documentlistproperties', { pluginName: 'DocumentListProperties' });
-    }
-}

package/src/tododocumentlist.d.ts

@@ -1,32 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module list/tododocumentlist
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import TodoList from './todolist.js';
-/**
- * The to-do list feature.
- *
- * This is an obsolete plugin that exists for backward compatibility only.
- * Use the {@link module:list/todolist~TodoList `TodoList`} instead.
- *
- * @deprecated
- */
-export default class TodoDocumentList extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TodoList];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TodoDocumentList";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    constructor(editor: Editor);
-}

package/src/tododocumentlist.js

@@ -1,47 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module list/tododocumentlist
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { logWarning } from 'ckeditor5/src/utils.js';
-import TodoList from './todolist.js';
-/**
- * The to-do list feature.
- *
- * This is an obsolete plugin that exists for backward compatibility only.
- * Use the {@link module:list/todolist~TodoList `TodoList`} instead.
- *
- * @deprecated
- */
-export default class TodoDocumentList extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [TodoList];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'TodoDocumentList';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    constructor(editor) {
-        super(editor);
-        /**
-         * The `TodoDocumentList` plugin is obsolete. Use `TodoList` instead.
-         *
-         * @error plugin-obsolete-tododocumentlist
-         */
-        logWarning('plugin-obsolete-tododocumentlist', { pluginName: 'TodoDocumentList' });
-    }
-}