@ckeditor/ckeditor5-heading 39.0.2 → 40.0.0

package/src/headingediting.d.ts

@@ -1,42 +1,42 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module heading/headingediting
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core';
-import { Paragraph } from 'ckeditor5/src/paragraph';
-/**
- * The headings engine feature. It handles switching between block formats – headings and paragraph.
- * This class represents the engine part of the heading feature. See also {@link module:heading/heading~Heading}.
- * It introduces `heading1`-`headingN` commands which allow to convert paragraphs into headings.
- */
-export default class HeadingEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "HeadingEditing";
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Paragraph];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Adds default conversion for `h1` -> `heading1` with a low priority.
-     *
-     * @param editor Editor instance on which to add the `h1` conversion.
-     */
-    private _addDefaultH1Conversion;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module heading/headingediting
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+import { Paragraph } from 'ckeditor5/src/paragraph';
+/**
+ * The headings engine feature. It handles switching between block formats – headings and paragraph.
+ * This class represents the engine part of the heading feature. See also {@link module:heading/heading~Heading}.
+ * It introduces `heading1`-`headingN` commands which allow to convert paragraphs into headings.
+ */
+export default class HeadingEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "HeadingEditing";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof Paragraph];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * Adds default conversion for `h1` -> `heading1` with a low priority.
+     *
+     * @param editor Editor instance on which to add the `h1` conversion.
+     */
+    private _addDefaultH1Conversion;
+}

package/src/headingediting.js

@@ -1,101 +1,101 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module heading/headingediting
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Paragraph } from 'ckeditor5/src/paragraph';
-import { priorities } from 'ckeditor5/src/utils';
-import HeadingCommand from './headingcommand';
-const defaultModelElement = 'paragraph';
-/**
- * The headings engine feature. It handles switching between block formats – headings and paragraph.
- * This class represents the engine part of the heading feature. See also {@link module:heading/heading~Heading}.
- * It introduces `heading1`-`headingN` commands which allow to convert paragraphs into headings.
- */
-export default class HeadingEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'HeadingEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        editor.config.define('heading', {
-            options: [
-                { model: 'paragraph', title: 'Paragraph', class: 'ck-heading_paragraph' },
-                { model: 'heading1', view: 'h2', title: 'Heading 1', class: 'ck-heading_heading1' },
-                { model: 'heading2', view: 'h3', title: 'Heading 2', class: 'ck-heading_heading2' },
-                { model: 'heading3', view: 'h4', title: 'Heading 3', class: 'ck-heading_heading3' }
-            ]
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [Paragraph];
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const options = editor.config.get('heading.options');
-        const modelElements = [];
-        for (const option of options) {
-            // Skip paragraph - it is defined in required Paragraph feature.
-            if (option.model === 'paragraph') {
-                continue;
-            }
-            // Schema.
-            editor.model.schema.register(option.model, {
-                inheritAllFrom: '$block'
-            });
-            editor.conversion.elementToElement(option);
-            modelElements.push(option.model);
-        }
-        this._addDefaultH1Conversion(editor);
-        // Register the heading command for this option.
-        editor.commands.add('heading', new HeadingCommand(editor, modelElements));
-    }
-    /**
-     * @inheritDoc
-     */
-    afterInit() {
-        // If the enter command is added to the editor, alter its behavior.
-        // Enter at the end of a heading element should create a paragraph.
-        const editor = this.editor;
-        const enterCommand = editor.commands.get('enter');
-        const options = editor.config.get('heading.options');
-        if (enterCommand) {
-            this.listenTo(enterCommand, 'afterExecute', (evt, data) => {
-                const positionParent = editor.model.document.selection.getFirstPosition().parent;
-                const isHeading = options.some(option => positionParent.is('element', option.model));
-                if (isHeading && !positionParent.is('element', defaultModelElement) && positionParent.childCount === 0) {
-                    data.writer.rename(positionParent, defaultModelElement);
-                }
-            });
-        }
-    }
-    /**
-     * Adds default conversion for `h1` -> `heading1` with a low priority.
-     *
-     * @param editor Editor instance on which to add the `h1` conversion.
-     */
-    _addDefaultH1Conversion(editor) {
-        editor.conversion.for('upcast').elementToElement({
-            model: 'heading1',
-            view: 'h1',
-            // With a `low` priority, `paragraph` plugin autoparagraphing mechanism is executed. Make sure
-            // this listener is called before it. If not, `h1` will be transformed into a paragraph.
-            converterPriority: priorities.low + 1
-        });
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module heading/headingediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Paragraph } from 'ckeditor5/src/paragraph';
+import { priorities } from 'ckeditor5/src/utils';
+import HeadingCommand from './headingcommand';
+const defaultModelElement = 'paragraph';
+/**
+ * The headings engine feature. It handles switching between block formats – headings and paragraph.
+ * This class represents the engine part of the heading feature. See also {@link module:heading/heading~Heading}.
+ * It introduces `heading1`-`headingN` commands which allow to convert paragraphs into headings.
+ */
+export default class HeadingEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'HeadingEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        editor.config.define('heading', {
+            options: [
+                { model: 'paragraph', title: 'Paragraph', class: 'ck-heading_paragraph' },
+                { model: 'heading1', view: 'h2', title: 'Heading 1', class: 'ck-heading_heading1' },
+                { model: 'heading2', view: 'h3', title: 'Heading 2', class: 'ck-heading_heading2' },
+                { model: 'heading3', view: 'h4', title: 'Heading 3', class: 'ck-heading_heading3' }
+            ]
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [Paragraph];
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const options = editor.config.get('heading.options');
+        const modelElements = [];
+        for (const option of options) {
+            // Skip paragraph - it is defined in required Paragraph feature.
+            if (option.model === 'paragraph') {
+                continue;
+            }
+            // Schema.
+            editor.model.schema.register(option.model, {
+                inheritAllFrom: '$block'
+            });
+            editor.conversion.elementToElement(option);
+            modelElements.push(option.model);
+        }
+        this._addDefaultH1Conversion(editor);
+        // Register the heading command for this option.
+        editor.commands.add('heading', new HeadingCommand(editor, modelElements));
+    }
+    /**
+     * @inheritDoc
+     */
+    afterInit() {
+        // If the enter command is added to the editor, alter its behavior.
+        // Enter at the end of a heading element should create a paragraph.
+        const editor = this.editor;
+        const enterCommand = editor.commands.get('enter');
+        const options = editor.config.get('heading.options');
+        if (enterCommand) {
+            this.listenTo(enterCommand, 'afterExecute', (evt, data) => {
+                const positionParent = editor.model.document.selection.getFirstPosition().parent;
+                const isHeading = options.some(option => positionParent.is('element', option.model));
+                if (isHeading && !positionParent.is('element', defaultModelElement) && positionParent.childCount === 0) {
+                    data.writer.rename(positionParent, defaultModelElement);
+                }
+            });
+        }
+    }
+    /**
+     * Adds default conversion for `h1` -> `heading1` with a low priority.
+     *
+     * @param editor Editor instance on which to add the `h1` conversion.
+     */
+    _addDefaultH1Conversion(editor) {
+        editor.conversion.for('upcast').elementToElement({
+            model: 'heading1',
+            view: 'h1',
+            // With a `low` priority, `paragraph` plugin autoparagraphing mechanism is executed. Make sure
+            // this listener is called before it. If not, `h1` will be transformed into a paragraph.
+            converterPriority: priorities.low + 1
+        });
+    }
+}

package/src/headingui.d.ts

@@ -1,22 +1,22 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module heading/headingui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import '../theme/heading.css';
-/**
- * The headings UI feature. It introduces the `headings` dropdown.
- */
-export default class HeadingUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "HeadingUI";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module heading/headingui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import '../theme/heading.css';
+/**
+ * The headings UI feature. It introduces the `headings` dropdown.
+ */
+export default class HeadingUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "HeadingUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/headingui.js

@@ -1,107 +1,107 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module heading/headingui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Model, createDropdown, addListToDropdown } from 'ckeditor5/src/ui';
-import { Collection } from 'ckeditor5/src/utils';
-import { getLocalizedOptions } from './utils';
-import '../theme/heading.css';
-/**
- * The headings UI feature. It introduces the `headings` dropdown.
- */
-export default class HeadingUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'HeadingUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const t = editor.t;
-        const options = getLocalizedOptions(editor);
-        const defaultTitle = t('Choose heading');
-        const accessibleLabel = t('Heading');
-        // Register UI component.
-        editor.ui.componentFactory.add('heading', locale => {
-            const titles = {};
-            const itemDefinitions = new Collection();
-            const headingCommand = editor.commands.get('heading');
-            const paragraphCommand = editor.commands.get('paragraph');
-            const commands = [headingCommand];
-            for (const option of options) {
-                const def = {
-                    type: 'button',
-                    model: new Model({
-                        label: option.title,
-                        class: option.class,
-                        role: 'menuitemradio',
-                        withText: true
-                    })
-                };
-                if (option.model === 'paragraph') {
-                    def.model.bind('isOn').to(paragraphCommand, 'value');
-                    def.model.set('commandName', 'paragraph');
-                    commands.push(paragraphCommand);
-                }
-                else {
-                    def.model.bind('isOn').to(headingCommand, 'value', value => value === option.model);
-                    def.model.set({
-                        commandName: 'heading',
-                        commandValue: option.model
-                    });
-                }
-                // Add the option to the collection.
-                itemDefinitions.add(def);
-                titles[option.model] = option.title;
-            }
-            const dropdownView = createDropdown(locale);
-            addListToDropdown(dropdownView, itemDefinitions, {
-                ariaLabel: accessibleLabel,
-                role: 'menu'
-            });
-            dropdownView.buttonView.set({
-                ariaLabel: accessibleLabel,
-                ariaLabelledBy: undefined,
-                isOn: false,
-                withText: true,
-                tooltip: accessibleLabel
-            });
-            dropdownView.extendTemplate({
-                attributes: {
-                    class: [
-                        'ck-heading-dropdown'
-                    ]
-                }
-            });
-            dropdownView.bind('isEnabled').toMany(commands, 'isEnabled', (...areEnabled) => {
-                return areEnabled.some(isEnabled => isEnabled);
-            });
-            dropdownView.buttonView.bind('label').to(headingCommand, 'value', paragraphCommand, 'value', (value, para) => {
-                const whichModel = value || para && 'paragraph';
-                if (typeof whichModel === 'boolean') {
-                    return defaultTitle;
-                }
-                // If none of the commands is active, display default title.
-                if (!titles[whichModel]) {
-                    return defaultTitle;
-                }
-                return titles[whichModel];
-            });
-            // Execute command when an item from the dropdown is selected.
-            this.listenTo(dropdownView, 'execute', evt => {
-                const { commandName, commandValue } = evt.source;
-                editor.execute(commandName, commandValue ? { value: commandValue } : undefined);
-                editor.editing.view.focus();
-            });
-            return dropdownView;
-        });
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module heading/headingui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Model, createDropdown, addListToDropdown } from 'ckeditor5/src/ui';
+import { Collection } from 'ckeditor5/src/utils';
+import { getLocalizedOptions } from './utils';
+import '../theme/heading.css';
+/**
+ * The headings UI feature. It introduces the `headings` dropdown.
+ */
+export default class HeadingUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'HeadingUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.t;
+        const options = getLocalizedOptions(editor);
+        const defaultTitle = t('Choose heading');
+        const accessibleLabel = t('Heading');
+        // Register UI component.
+        editor.ui.componentFactory.add('heading', locale => {
+            const titles = {};
+            const itemDefinitions = new Collection();
+            const headingCommand = editor.commands.get('heading');
+            const paragraphCommand = editor.commands.get('paragraph');
+            const commands = [headingCommand];
+            for (const option of options) {
+                const def = {
+                    type: 'button',
+                    model: new Model({
+                        label: option.title,
+                        class: option.class,
+                        role: 'menuitemradio',
+                        withText: true
+                    })
+                };
+                if (option.model === 'paragraph') {
+                    def.model.bind('isOn').to(paragraphCommand, 'value');
+                    def.model.set('commandName', 'paragraph');
+                    commands.push(paragraphCommand);
+                }
+                else {
+                    def.model.bind('isOn').to(headingCommand, 'value', value => value === option.model);
+                    def.model.set({
+                        commandName: 'heading',
+                        commandValue: option.model
+                    });
+                }
+                // Add the option to the collection.
+                itemDefinitions.add(def);
+                titles[option.model] = option.title;
+            }
+            const dropdownView = createDropdown(locale);
+            addListToDropdown(dropdownView, itemDefinitions, {
+                ariaLabel: accessibleLabel,
+                role: 'menu'
+            });
+            dropdownView.buttonView.set({
+                ariaLabel: accessibleLabel,
+                ariaLabelledBy: undefined,
+                isOn: false,
+                withText: true,
+                tooltip: accessibleLabel
+            });
+            dropdownView.extendTemplate({
+                attributes: {
+                    class: [
+                        'ck-heading-dropdown'
+                    ]
+                }
+            });
+            dropdownView.bind('isEnabled').toMany(commands, 'isEnabled', (...areEnabled) => {
+                return areEnabled.some(isEnabled => isEnabled);
+            });
+            dropdownView.buttonView.bind('label').to(headingCommand, 'value', paragraphCommand, 'value', (value, para) => {
+                const whichModel = value || para && 'paragraph';
+                if (typeof whichModel === 'boolean') {
+                    return defaultTitle;
+                }
+                // If none of the commands is active, display default title.
+                if (!titles[whichModel]) {
+                    return defaultTitle;
+                }
+                return titles[whichModel];
+            });
+            // Execute command when an item from the dropdown is selected.
+            this.listenTo(dropdownView, 'execute', evt => {
+                const { commandName, commandValue } = evt.source;
+                editor.execute(commandName, commandValue ? { value: commandValue } : undefined);
+                editor.editing.view.focus();
+            });
+            return dropdownView;
+        });
+    }
+}

package/src/index.d.ts

@@ -1,16 +1,16 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module heading
- */
-export { default as Heading } from './heading';
-export type { HeadingOption } from './headingconfig';
-export { default as HeadingEditing } from './headingediting';
-export { default as HeadingUI } from './headingui';
-export { default as HeadingButtonsUI } from './headingbuttonsui';
-export { default as Title, type TitleConfig } from './title';
-export type { HeadingConfig } from './headingconfig';
-export type { default as HeadingCommand } from './headingcommand';
-import './augmentation';
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module heading
+ */
+export { default as Heading } from './heading';
+export type { HeadingOption } from './headingconfig';
+export { default as HeadingEditing } from './headingediting';
+export { default as HeadingUI } from './headingui';
+export { default as HeadingButtonsUI } from './headingbuttonsui';
+export { default as Title, type TitleConfig } from './title';
+export type { HeadingConfig } from './headingconfig';
+export type { default as HeadingCommand } from './headingcommand';
+import './augmentation';

package/src/index.js

@@ -1,13 +1,13 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module heading
- */
-export { default as Heading } from './heading';
-export { default as HeadingEditing } from './headingediting';
-export { default as HeadingUI } from './headingui';
-export { default as HeadingButtonsUI } from './headingbuttonsui';
-export { default as Title } from './title';
-import './augmentation';
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module heading
+ */
+export { default as Heading } from './heading';
+export { default as HeadingEditing } from './headingediting';
+export { default as HeadingUI } from './headingui';
+export { default as HeadingButtonsUI } from './headingbuttonsui';
+export { default as Title } from './title';
+import './augmentation';