@ckeditor/ckeditor5-paragraph 40.0.0 → 40.2.0

package/src/paragraph.d.ts

@@ -1,61 +1,61 @@
-/**
- * @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
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-/**
- * The paragraph feature for the editor.
- *
- * It introduces the `<paragraph>` element in the model which renders as a `<p>` element in the DOM and data.
- *
- * It also brings two editors commands:
- *
- * * The {@link module:paragraph/paragraphcommand~ParagraphCommand `'paragraph'`} command that converts all
- * blocks in the model selection into paragraphs.
- * * The {@link module:paragraph/insertparagraphcommand~InsertParagraphCommand `'insertParagraph'`} command
- * that inserts a new paragraph at a specified location in the model.
- */
-export default class Paragraph extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Paragraph";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * A list of element names which should be treated by the autoparagraphing algorithms as
-     * paragraph-like. This means that e.g. the following content:
-     *
-     * ```html
-     * <h1>Foo</h1>
-     * <table>
-     *   <tr>
-     *     <td>X</td>
-     *     <td>
-     *       <ul>
-     *         <li>Y</li>
-     *         <li>Z</li>
-     *       </ul>
-     *     </td>
-     *   </tr>
-     * </table>
-     * ```
-     *
-     * contains five paragraph-like elements: `<h1>`, two `<td>`s and two `<li>`s.
-     * Hence, if none of the features is going to convert those elements the above content will be automatically handled
-     * by the paragraph feature and converted to:
-     *
-     * ```html
-     * <p>Foo</p>
-     * <p>X</p>
-     * <p>Y</p>
-     * <p>Z</p>
-     * ```
-     *
-     * Note: The `<td>` containing two `<li>` elements was ignored as the innermost paragraph-like elements
-     * have a priority upon conversion.
-     */
-    static paragraphLikeElements: Set<string>;
-}
+/**
+ * @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
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+/**
+ * The paragraph feature for the editor.
+ *
+ * It introduces the `<paragraph>` element in the model which renders as a `<p>` element in the DOM and data.
+ *
+ * It also brings two editors commands:
+ *
+ * * The {@link module:paragraph/paragraphcommand~ParagraphCommand `'paragraph'`} command that converts all
+ * blocks in the model selection into paragraphs.
+ * * The {@link module:paragraph/insertparagraphcommand~InsertParagraphCommand `'insertParagraph'`} command
+ * that inserts a new paragraph at a specified location in the model.
+ */
+export default class Paragraph extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Paragraph";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * A list of element names which should be treated by the autoparagraphing algorithms as
+     * paragraph-like. This means that e.g. the following content:
+     *
+     * ```html
+     * <h1>Foo</h1>
+     * <table>
+     *   <tr>
+     *     <td>X</td>
+     *     <td>
+     *       <ul>
+     *         <li>Y</li>
+     *         <li>Z</li>
+     *       </ul>
+     *     </td>
+     *   </tr>
+     * </table>
+     * ```
+     *
+     * contains five paragraph-like elements: `<h1>`, two `<td>`s and two `<li>`s.
+     * Hence, if none of the features is going to convert those elements the above content will be automatically handled
+     * by the paragraph feature and converted to:
+     *
+     * ```html
+     * <p>Foo</p>
+     * <p>X</p>
+     * <p>Y</p>
+     * <p>Z</p>
+     * ```
+     *
+     * Note: The `<td>` containing two `<li>` elements was ignored as the innermost paragraph-like elements
+     * have a priority upon conversion.
+     */
+    static paragraphLikeElements: Set<string>;
+}

package/src/paragraph.js

@@ -1,106 +1,106 @@
-/**
- * @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 paragraph/paragraph
- */
-import ParagraphCommand from './paragraphcommand';
-import InsertParagraphCommand from './insertparagraphcommand';
-import { Plugin } from '@ckeditor/ckeditor5-core';
-/**
- * The paragraph feature for the editor.
- *
- * It introduces the `<paragraph>` element in the model which renders as a `<p>` element in the DOM and data.
- *
- * It also brings two editors commands:
- *
- * * The {@link module:paragraph/paragraphcommand~ParagraphCommand `'paragraph'`} command that converts all
- * blocks in the model selection into paragraphs.
- * * The {@link module:paragraph/insertparagraphcommand~InsertParagraphCommand `'insertParagraph'`} command
- * that inserts a new paragraph at a specified location in the model.
- */
-export default class Paragraph extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'Paragraph';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const model = editor.model;
-        editor.commands.add('paragraph', new ParagraphCommand(editor));
-        editor.commands.add('insertParagraph', new InsertParagraphCommand(editor));
-        // Schema.
-        model.schema.register('paragraph', { inheritAllFrom: '$block' });
-        editor.conversion.elementToElement({ model: 'paragraph', view: 'p' });
-        // Conversion for paragraph-like elements which has not been converted by any plugin.
-        editor.conversion.for('upcast').elementToElement({
-            model: (viewElement, { writer }) => {
-                if (!Paragraph.paragraphLikeElements.has(viewElement.name)) {
-                    return null;
-                }
-                // Do not auto-paragraph empty elements.
-                if (viewElement.isEmpty) {
-                    return null;
-                }
-                return writer.createElement('paragraph');
-            },
-            view: /.+/,
-            converterPriority: 'low'
-        });
-    }
-}
-/**
- * A list of element names which should be treated by the autoparagraphing algorithms as
- * paragraph-like. This means that e.g. the following content:
- *
- * ```html
- * <h1>Foo</h1>
- * <table>
- *   <tr>
- *     <td>X</td>
- *     <td>
- *       <ul>
- *         <li>Y</li>
- *         <li>Z</li>
- *       </ul>
- *     </td>
- *   </tr>
- * </table>
- * ```
- *
- * contains five paragraph-like elements: `<h1>`, two `<td>`s and two `<li>`s.
- * Hence, if none of the features is going to convert those elements the above content will be automatically handled
- * by the paragraph feature and converted to:
- *
- * ```html
- * <p>Foo</p>
- * <p>X</p>
- * <p>Y</p>
- * <p>Z</p>
- * ```
- *
- * Note: The `<td>` containing two `<li>` elements was ignored as the innermost paragraph-like elements
- * have a priority upon conversion.
- */
-Paragraph.paragraphLikeElements = new Set([
-    'blockquote',
-    'dd',
-    'div',
-    'dt',
-    'h1',
-    'h2',
-    'h3',
-    'h4',
-    'h5',
-    'h6',
-    'li',
-    'p',
-    'td',
-    'th'
-]);
+/**
+ * @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 paragraph/paragraph
+ */
+import ParagraphCommand from './paragraphcommand';
+import InsertParagraphCommand from './insertparagraphcommand';
+import { Plugin } from '@ckeditor/ckeditor5-core';
+/**
+ * The paragraph feature for the editor.
+ *
+ * It introduces the `<paragraph>` element in the model which renders as a `<p>` element in the DOM and data.
+ *
+ * It also brings two editors commands:
+ *
+ * * The {@link module:paragraph/paragraphcommand~ParagraphCommand `'paragraph'`} command that converts all
+ * blocks in the model selection into paragraphs.
+ * * The {@link module:paragraph/insertparagraphcommand~InsertParagraphCommand `'insertParagraph'`} command
+ * that inserts a new paragraph at a specified location in the model.
+ */
+export default class Paragraph extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Paragraph';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const model = editor.model;
+        editor.commands.add('paragraph', new ParagraphCommand(editor));
+        editor.commands.add('insertParagraph', new InsertParagraphCommand(editor));
+        // Schema.
+        model.schema.register('paragraph', { inheritAllFrom: '$block' });
+        editor.conversion.elementToElement({ model: 'paragraph', view: 'p' });
+        // Conversion for paragraph-like elements which has not been converted by any plugin.
+        editor.conversion.for('upcast').elementToElement({
+            model: (viewElement, { writer }) => {
+                if (!Paragraph.paragraphLikeElements.has(viewElement.name)) {
+                    return null;
+                }
+                // Do not auto-paragraph empty elements.
+                if (viewElement.isEmpty) {
+                    return null;
+                }
+                return writer.createElement('paragraph');
+            },
+            view: /.+/,
+            converterPriority: 'low'
+        });
+    }
+}
+/**
+ * A list of element names which should be treated by the autoparagraphing algorithms as
+ * paragraph-like. This means that e.g. the following content:
+ *
+ * ```html
+ * <h1>Foo</h1>
+ * <table>
+ *   <tr>
+ *     <td>X</td>
+ *     <td>
+ *       <ul>
+ *         <li>Y</li>
+ *         <li>Z</li>
+ *       </ul>
+ *     </td>
+ *   </tr>
+ * </table>
+ * ```
+ *
+ * contains five paragraph-like elements: `<h1>`, two `<td>`s and two `<li>`s.
+ * Hence, if none of the features is going to convert those elements the above content will be automatically handled
+ * by the paragraph feature and converted to:
+ *
+ * ```html
+ * <p>Foo</p>
+ * <p>X</p>
+ * <p>Y</p>
+ * <p>Z</p>
+ * ```
+ *
+ * Note: The `<td>` containing two `<li>` elements was ignored as the innermost paragraph-like elements
+ * have a priority upon conversion.
+ */
+Paragraph.paragraphLikeElements = new Set([
+    'blockquote',
+    'dd',
+    'div',
+    'dt',
+    'h1',
+    'h2',
+    'h3',
+    'h4',
+    'h5',
+    'h6',
+    'li',
+    'p',
+    'td',
+    'th'
+]);

package/src/paragraphbuttonui.d.ts

@@ -1,36 +1,36 @@
-/**
- * @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 paragraph/paragraphbuttonui
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import Paragraph from './paragraph';
-/**
- * This plugin defines the `'paragraph'` button. It can be used together with
- * {@link module:heading/headingbuttonsui~HeadingButtonsUI} to replace the standard heading dropdown.
- *
- * This plugin is not loaded automatically by the {@link module:paragraph/paragraph~Paragraph} plugin. It must
- * be added manually.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     plugins: [ ..., Heading, Paragraph, HeadingButtonsUI, ParagraphButtonUI ]
- *     toolbar: [ 'paragraph', 'heading1', 'heading2', 'heading3' ]
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- */
-export default class ParagraphButtonUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Paragraph];
-    /**
-     * @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 paragraph/paragraphbuttonui
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import Paragraph from './paragraph';
+/**
+ * This plugin defines the `'paragraph'` button. It can be used together with
+ * {@link module:heading/headingbuttonsui~HeadingButtonsUI} to replace the standard heading dropdown.
+ *
+ * This plugin is not loaded automatically by the {@link module:paragraph/paragraph~Paragraph} plugin. It must
+ * be added manually.
+ *
+ * ```ts
+ * ClassicEditor
+ *   .create( {
+ *     plugins: [ ..., Heading, Paragraph, HeadingButtonsUI, ParagraphButtonUI ]
+ *     toolbar: [ 'paragraph', 'heading1', 'heading2', 'heading3' ]
+ *   } )
+ *   .then( ... )
+ *   .catch( ... );
+ * ```
+ */
+export default class ParagraphButtonUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof Paragraph];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/paragraphbuttonui.js

@@ -1,57 +1,57 @@
-/**
- * @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 paragraph/paragraphbuttonui
- */
-import { Plugin, icons } from '@ckeditor/ckeditor5-core';
-import { ButtonView } from '@ckeditor/ckeditor5-ui';
-import Paragraph from './paragraph';
-const icon = icons.paragraph;
-/**
- * This plugin defines the `'paragraph'` button. It can be used together with
- * {@link module:heading/headingbuttonsui~HeadingButtonsUI} to replace the standard heading dropdown.
- *
- * This plugin is not loaded automatically by the {@link module:paragraph/paragraph~Paragraph} plugin. It must
- * be added manually.
- *
- * ```ts
- * ClassicEditor
- *   .create( {
- *     plugins: [ ..., Heading, Paragraph, HeadingButtonsUI, ParagraphButtonUI ]
- *     toolbar: [ 'paragraph', 'heading1', 'heading2', 'heading3' ]
- *   } )
- *   .then( ... )
- *   .catch( ... );
- * ```
- */
-export default class ParagraphButtonUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [Paragraph];
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const t = editor.t;
-        editor.ui.componentFactory.add('paragraph', locale => {
-            const view = new ButtonView(locale);
-            const command = editor.commands.get('paragraph');
-            view.label = t('Paragraph');
-            view.icon = icon;
-            view.tooltip = true;
-            view.isToggleable = true;
-            view.bind('isEnabled').to(command);
-            view.bind('isOn').to(command, 'value');
-            view.on('execute', () => {
-                editor.execute('paragraph');
-            });
-            return view;
-        });
-    }
-}
+/**
+ * @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 paragraph/paragraphbuttonui
+ */
+import { Plugin, icons } from '@ckeditor/ckeditor5-core';
+import { ButtonView } from '@ckeditor/ckeditor5-ui';
+import Paragraph from './paragraph';
+const icon = icons.paragraph;
+/**
+ * This plugin defines the `'paragraph'` button. It can be used together with
+ * {@link module:heading/headingbuttonsui~HeadingButtonsUI} to replace the standard heading dropdown.
+ *
+ * This plugin is not loaded automatically by the {@link module:paragraph/paragraph~Paragraph} plugin. It must
+ * be added manually.
+ *
+ * ```ts
+ * ClassicEditor
+ *   .create( {
+ *     plugins: [ ..., Heading, Paragraph, HeadingButtonsUI, ParagraphButtonUI ]
+ *     toolbar: [ 'paragraph', 'heading1', 'heading2', 'heading3' ]
+ *   } )
+ *   .then( ... )
+ *   .catch( ... );
+ * ```
+ */
+export default class ParagraphButtonUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [Paragraph];
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.t;
+        editor.ui.componentFactory.add('paragraph', locale => {
+            const view = new ButtonView(locale);
+            const command = editor.commands.get('paragraph');
+            view.label = t('Paragraph');
+            view.icon = icon;
+            view.tooltip = true;
+            view.isToggleable = true;
+            view.bind('isEnabled').to(command);
+            view.bind('isOn').to(command, 'value');
+            view.on('execute', () => {
+                editor.execute('paragraph');
+            });
+            return view;
+        });
+    }
+}

package/src/paragraphcommand.d.ts

@@ -1,38 +1,38 @@
-/**
- * @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 paragraph/paragraphcommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import type { Selection, DocumentSelection } from '@ckeditor/ckeditor5-engine';
-/**
- * The paragraph command.
- */
-export default class ParagraphCommand extends Command {
-    constructor(editor: Editor);
-    /**
-     * The value of the command. Indicates whether the selection start is placed in a paragraph.
-     *
-     * @readonly
-     * @observable
-     */
-    value: boolean;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command. All the blocks (see {@link module:engine/model/schema~Schema}) in the selection
-     * will be turned to paragraphs.
-     *
-     * @fires execute
-     * @param options Options for the executed command.
-     * @param options.selection The selection that the command should be applied to. By default,
-     * if not provided, the command is applied to the {@link module:engine/model/document~Document#selection}.
-     */
-    execute(options?: {
-        selection?: Selection | DocumentSelection;
-    }): 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 paragraph/paragraphcommand
+ */
+import { Command, type Editor } from '@ckeditor/ckeditor5-core';
+import type { Selection, DocumentSelection } from '@ckeditor/ckeditor5-engine';
+/**
+ * The paragraph command.
+ */
+export default class ParagraphCommand extends Command {
+    constructor(editor: Editor);
+    /**
+     * The value of the command. Indicates whether the selection start is placed in a paragraph.
+     *
+     * @readonly
+     * @observable
+     */
+    value: boolean;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command. All the blocks (see {@link module:engine/model/schema~Schema}) in the selection
+     * will be turned to paragraphs.
+     *
+     * @fires execute
+     * @param options Options for the executed command.
+     * @param options.selection The selection that the command should be applied to. By default,
+     * if not provided, the command is applied to the {@link module:engine/model/document~Document#selection}.
+     */
+    execute(options?: {
+        selection?: Selection | DocumentSelection;
+    }): void;
+}