@ckeditor/ckeditor5-heading 47.4.0-alpha.3 → 47.4.0-alpha.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-heading",
-  "version": "47.4.0-alpha.3",
+  "version": "47.4.0-alpha.5",
   "description": "Headings feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,13 +13,13 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "47.4.0-alpha.3",
-    "@ckeditor/ckeditor5-engine": "47.4.0-alpha.3",
-    "@ckeditor/ckeditor5-icons": "47.4.0-alpha.3",
-    "@ckeditor/ckeditor5-paragraph": "47.4.0-alpha.3",
-    "@ckeditor/ckeditor5-ui": "47.4.0-alpha.3",
-    "@ckeditor/ckeditor5-utils": "47.4.0-alpha.3",
-    "ckeditor5": "47.4.0-alpha.3"
+    "@ckeditor/ckeditor5-core": "47.4.0-alpha.5",
+    "@ckeditor/ckeditor5-engine": "47.4.0-alpha.5",
+    "@ckeditor/ckeditor5-icons": "47.4.0-alpha.5",
+    "@ckeditor/ckeditor5-paragraph": "47.4.0-alpha.5",
+    "@ckeditor/ckeditor5-ui": "47.4.0-alpha.5",
+    "@ckeditor/ckeditor5-utils": "47.4.0-alpha.5",
+    "ckeditor5": "47.4.0-alpha.5"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "SEE LICENSE IN LICENSE.md",

package/src/title.d.ts

@@ -35,10 +35,10 @@ export declare class Title extends Plugin {
     init(): void;
     /**
      * Returns the title of the document. Note that because this plugin does not allow any formatting inside
-     * the `title` element, the output of this method will be a plain text, with no HTML tags.
+     * the title element, the output of this method will be a plain text, with no HTML tags.
      *
      * It is not recommended to use this method together with features that insert markers to the
-     * data output, like comments or track changes features. If such markers start in the `title` and end in the
+     * data output, like comments or track changes features. If such markers start in the title and end in the
      * body, the result of this method might be incorrect.
      *
      * @param options Additional configuration passed to the conversion process.
@@ -68,8 +68,8 @@ export declare class Title extends Plugin {
      */
     private _fixTitleContent;
     /**
-     * Model post-fixer callback that creates a `title` element when it is missing,
-     * takes care of the correct position of it and removes additional `title` elements.
+     * Model post-fixer callback that creates a title element when it is missing,
+     * takes care of the correct position of it and removes additional title elements.
      */
     private _fixTitleElement;
     /**

package/src/title.js

@@ -9,7 +9,7 @@ import { Plugin } from 'ckeditor5/src/core.js';
 import { first } from 'ckeditor5/src/utils.js';
 import { ViewDowncastWriter, enableViewPlaceholder, hideViewPlaceholder, needsViewPlaceholder, showViewPlaceholder } from 'ckeditor5/src/engine.js';
 // A list of element names that should be treated by the Title plugin as title-like.
-// This means that an element of a type from this list will be changed to a `title` element
+// This means that an element of a type from this list will be changed to a title element
 // when it is the first element in the root.
 const titleLikeElements = new Set(['paragraph', 'heading1', 'heading2', 'heading3', 'heading4', 'heading5', 'heading6']);
 /**
@@ -47,7 +47,7 @@ export class Title extends Plugin {
     init() {
         const editor = this.editor;
         const model = editor.model;
-        // To use the schema for disabling some features when the selection is inside the `title` element
+        // To use the schema for disabling some features when the selection is inside the title element
         // it is needed to create the following structure:
         //
         // <title>
@@ -58,13 +58,13 @@ export class Title extends Plugin {
         model.schema.register('title', { isBlock: true, allowIn: '$root' });
         model.schema.register('title-content', { isBlock: true, allowIn: 'title', allowAttributes: ['alignment'] });
         model.schema.extend('$text', { allowIn: 'title-content' });
-        // Disallow all attributes in `title-content` `$text`.
+        // Disallow all attributes in `title-content`.
         model.schema.addAttributeCheck(context => {
             if (context.endsWith('title-content $text')) {
                 return false;
             }
         });
-        // Because `title` is represented by two elements (`title` and `title-content`) in the model
+        // Because `title` is represented by two elements in the model
         // but only one in the view, it is needed to adjust Mapper.
         editor.editing.mapper.on('modelToViewPosition', mapModelPositionToView(editor.editing.view));
         editor.data.mapper.on('modelToViewPosition', mapModelPositionToView(editor.editing.view));
@@ -73,37 +73,6 @@ export class Title extends Plugin {
         editor.conversion.for('downcast').add(dispatcher => dispatcher.on('insert:title', (evt, data, conversionApi) => {
             conversionApi.consumable.consume(data.item, evt.name);
         }));
-        // This converter intercepts attribute changes on `title` and redirects them to `title-content`.
-        //
-        // The `title` element in the model doesn't have a corresponding view element, only `title-content`
-        // is converted to `<h1>`. Setting an attribute on `title` would cause a downcast conversion error
-        // because there's no view element to apply it to.
-        editor.conversion.for('downcast').add(dispatcher => {
-            dispatcher.on('attribute', (evt, data, conversionApi) => {
-                // Only process if the attribute change is on a `title` element.
-                if (!data.item.is('element', 'title')) {
-                    return;
-                }
-                const titleElement = data.item;
-                if (!conversionApi.consumable.consume(titleElement, evt.name)) {
-                    return;
-                }
-                const titleContentElement = titleElement.getChild(0);
-                // Ensure the `title-content` element is converted to view first.
-                // This is needed because attribute conversion might run before insert conversion.
-                conversionApi.convertItem(titleContentElement);
-                const viewElement = conversionApi.mapper.toViewElement(titleContentElement);
-                const attributeKey = data.attributeKey;
-                const attributeNewValue = data.attributeNewValue;
-                // Apply the attribute to the view element.
-                if (attributeNewValue !== null) {
-                    conversionApi.writer.setAttribute(attributeKey, attributeNewValue, viewElement);
-                }
-                else {
-                    conversionApi.writer.removeAttribute(attributeKey, viewElement);
-                }
-            });
-        });
         // Custom converter is used for data v -> m conversion to avoid calling post-fixer when setting data.
         // See https://github.com/ckeditor/ckeditor5/issues/2036.
         editor.data.upcastDispatcher.on('element:h1', dataViewModelH1Insertion, { priority: 'high' });
@@ -124,10 +93,10 @@ export class Title extends Plugin {
     }
     /**
      * Returns the title of the document. Note that because this plugin does not allow any formatting inside
-     * the `title` element, the output of this method will be a plain text, with no HTML tags.
+     * the title element, the output of this method will be a plain text, with no HTML tags.
      *
      * It is not recommended to use this method together with features that insert markers to the
-     * data output, like comments or track changes features. If such markers start in the `title` and end in the
+     * data output, like comments or track changes features. If such markers start in the title and end in the
      * body, the result of this method might be incorrect.
      *
      * @param options Additional configuration passed to the conversion process.
@@ -175,7 +144,7 @@ export class Title extends Plugin {
         data.mapper.clearBindings();
         data.mapper.bindElements(root, viewDocumentFragment);
         data.downcastDispatcher.convert(rootRange, markers, viewWriter, options);
-        // Remove `title` element from view.
+        // Remove title element from view.
         viewWriter.remove(viewWriter.createRangeOn(viewDocumentFragment.getChild(0)));
         // view -> data
         return editor.data.processor.toData(viewDocumentFragment);
@@ -216,8 +185,8 @@ export class Title extends Plugin {
         return changed;
     }
     /**
-     * Model post-fixer callback that creates a `title` element when it is missing,
-     * takes care of the correct position of it and removes additional `title` elements.
+     * Model post-fixer callback that creates a title element when it is missing,
+     * takes care of the correct position of it and removes additional title elements.
      */
     _fixTitleElement(writer) {
         let changed = false;
@@ -226,7 +195,7 @@ export class Title extends Plugin {
             const titleElements = Array.from(modelRoot.getChildren()).filter(isTitle);
             const firstTitleElement = titleElements[0];
             const firstRootChild = modelRoot.getChild(0);
-            // When `title` element is at the beginning of the document then try to fix additional `title` elements (if there are any).
+            // When title element is at the beginning of the document then try to fix additional title elements (if there are any).
             if (firstRootChild.is('element', 'title')) {
                 if (titleElements.length > 1) {
                     fixAdditionalTitleElements(titleElements, writer, model);
@@ -244,11 +213,11 @@ export class Title extends Plugin {
                 continue;
             }
             if (titleLikeElements.has(firstRootChild.name)) {
-                // Change the first element in the document to the `title` if it can be changed (is title-like).
+                // Change the first element in the document to the title if it can be changed (is title-like).
                 changeElementToTitle(firstRootChild, writer, model);
             }
             else {
-                // Otherwise, move the first occurrence of the `title` element to the beginning of the document.
+                // Otherwise, move the first occurrence of the title element to the beginning of the document.
                 writer.move(writer.createRangeOn(firstTitleElement), modelRoot, 0);
             }
             fixAdditionalTitleElements(titleElements, writer, model);
@@ -302,7 +271,7 @@ export class Title extends Plugin {
         const bodyPlaceholder = editor.config.get('placeholder') ||
             sourceElement && sourceElement.tagName.toLowerCase() === 'textarea' && sourceElement.getAttribute('placeholder') ||
             t('Type or paste your content here.');
-        // Attach placeholder to the view `title-content` element.
+        // Attach placeholder to the view title element.
         editor.editing.downcastDispatcher.on('insert:title-content', (evt, data, conversionApi) => {
             const element = conversionApi.mapper.toViewElement(data.item);
             element.placeholder = titlePlaceholder;
@@ -312,8 +281,8 @@ export class Title extends Plugin {
                 keepOnFocus: true
             });
         });
-        // Attach placeholder to first element after a `title` element and remove it if it's not needed anymore.
-        // First element after `title` can change, so we need to observe all changes keep placeholder in sync.
+        // Attach placeholder to first element after a title element and remove it if it's not needed anymore.
+        // First element after title can change, so we need to observe all changes keep placeholder in sync.
         const bodyViewElements = new Map();
         // This post-fixer runs after the model post-fixer, so we can assume that the second child in view root will always exist.
         view.document.registerPostFixer(writer => {
@@ -389,7 +358,7 @@ export class Title extends Plugin {
     }
 }
 /**
- * A view-to-model converter for the `h1` that appears at the beginning of the document (a `title` element).
+ * A view-to-model converter for the h1 that appears at the beginning of the document (a title element).
  *
  * @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element
  * @param evt An object containing information about the fired event.
@@ -439,7 +408,7 @@ function isTitle(element) {
     return element.is('element', 'title');
 }
 /**
- * Changes the given element to the `title` element.
+ * Changes the given element to the title element.
  */
 function changeElementToTitle(element, writer, model) {
     const title = writer.createElement('title');
@@ -449,7 +418,7 @@ function changeElementToTitle(element, writer, model) {
     model.schema.removeDisallowedAttributes([element], writer);
 }
 /**
- * Loops over the list of `title` elements and fixes additional ones.
+ * Loops over the list of title elements and fixes additional ones.
  *
  * @returns Returns true when there was any change. Returns false otherwise.
  */
@@ -464,12 +433,12 @@ function fixAdditionalTitleElements(titleElements, writer, model) {
     return hasChanged;
 }
 /**
- * Changes given `title` element to a paragraph or removes it when it is empty.
+ * Changes given title element to a paragraph or removes it when it is empty.
  */
 function fixTitleElement(title, writer, model) {
     const child = title.getChild(0);
-    // Empty `title` should be removed.
-    // It is created as a result of pasting to the `title` element.
+    // Empty title should be removed.
+    // It is created as a result of pasting to the title element.
     if (child.isEmpty) {
         writer.remove(title);
         return;