@ckeditor/ckeditor5-code-block 40.0.0 → 40.2.0

package/src/codeblockui.d.ts

@@ -1,29 +1,29 @@
-/**
- * @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 code-block/codeblockui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import '../theme/codeblock.css';
-/**
- * The code block UI plugin.
- *
- * Introduces the `'codeBlock'` dropdown.
- */
-export default class CodeBlockUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CodeBlockUI";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * A helper returning a collection of the `codeBlock` dropdown items representing languages
-     * available for the user to choose from.
-     */
-    private _getLanguageListItemDefinitions;
-}
+/**
+ * @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 code-block/codeblockui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import '../theme/codeblock.css';
+/**
+ * The code block UI plugin.
+ *
+ * Introduces the `'codeBlock'` dropdown.
+ */
+export default class CodeBlockUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "CodeBlockUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * A helper returning a collection of the `codeBlock` dropdown items representing languages
+     * available for the user to choose from.
+     */
+    private _getLanguageListItemDefinitions;
+}

package/src/codeblockui.js

@@ -1,93 +1,93 @@
-/**
- * @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 code-block/codeblockui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Collection } from 'ckeditor5/src/utils';
-import { Model, SplitButtonView, createDropdown, addListToDropdown } from 'ckeditor5/src/ui';
-import { getNormalizedAndLocalizedLanguageDefinitions } from './utils';
-import codeBlockIcon from '../theme/icons/codeblock.svg';
-import '../theme/codeblock.css';
-/**
- * The code block UI plugin.
- *
- * Introduces the `'codeBlock'` dropdown.
- */
-export default class CodeBlockUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'CodeBlockUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const t = editor.t;
-        const componentFactory = editor.ui.componentFactory;
-        const normalizedLanguageDefs = getNormalizedAndLocalizedLanguageDefinitions(editor);
-        componentFactory.add('codeBlock', locale => {
-            const command = editor.commands.get('codeBlock');
-            const dropdownView = createDropdown(locale, SplitButtonView);
-            const splitButtonView = dropdownView.buttonView;
-            const accessibleLabel = t('Insert code block');
-            splitButtonView.set({
-                label: accessibleLabel,
-                tooltip: true,
-                icon: codeBlockIcon,
-                isToggleable: true
-            });
-            splitButtonView.bind('isOn').to(command, 'value', value => !!value);
-            splitButtonView.on('execute', () => {
-                editor.execute('codeBlock', {
-                    usePreviousLanguageChoice: true
-                });
-                editor.editing.view.focus();
-            });
-            dropdownView.on('execute', evt => {
-                editor.execute('codeBlock', {
-                    language: evt.source._codeBlockLanguage,
-                    forceValue: true
-                });
-                editor.editing.view.focus();
-            });
-            dropdownView.class = 'ck-code-block-dropdown';
-            dropdownView.bind('isEnabled').to(command);
-            addListToDropdown(dropdownView, () => this._getLanguageListItemDefinitions(normalizedLanguageDefs), {
-                role: 'menu',
-                ariaLabel: accessibleLabel
-            });
-            return dropdownView;
-        });
-    }
-    /**
-     * A helper returning a collection of the `codeBlock` dropdown items representing languages
-     * available for the user to choose from.
-     */
-    _getLanguageListItemDefinitions(normalizedLanguageDefs) {
-        const editor = this.editor;
-        const command = editor.commands.get('codeBlock');
-        const itemDefinitions = new Collection();
-        for (const languageDef of normalizedLanguageDefs) {
-            const definition = {
-                type: 'button',
-                model: new Model({
-                    _codeBlockLanguage: languageDef.language,
-                    label: languageDef.label,
-                    role: 'menuitemradio',
-                    withText: true
-                })
-            };
-            definition.model.bind('isOn').to(command, 'value', value => {
-                return value === definition.model._codeBlockLanguage;
-            });
-            itemDefinitions.add(definition);
-        }
-        return itemDefinitions;
-    }
-}
+/**
+ * @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 code-block/codeblockui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Collection } from 'ckeditor5/src/utils';
+import { Model, SplitButtonView, createDropdown, addListToDropdown } from 'ckeditor5/src/ui';
+import { getNormalizedAndLocalizedLanguageDefinitions } from './utils';
+import codeBlockIcon from '../theme/icons/codeblock.svg';
+import '../theme/codeblock.css';
+/**
+ * The code block UI plugin.
+ *
+ * Introduces the `'codeBlock'` dropdown.
+ */
+export default class CodeBlockUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'CodeBlockUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.t;
+        const componentFactory = editor.ui.componentFactory;
+        const normalizedLanguageDefs = getNormalizedAndLocalizedLanguageDefinitions(editor);
+        componentFactory.add('codeBlock', locale => {
+            const command = editor.commands.get('codeBlock');
+            const dropdownView = createDropdown(locale, SplitButtonView);
+            const splitButtonView = dropdownView.buttonView;
+            const accessibleLabel = t('Insert code block');
+            splitButtonView.set({
+                label: accessibleLabel,
+                tooltip: true,
+                icon: codeBlockIcon,
+                isToggleable: true
+            });
+            splitButtonView.bind('isOn').to(command, 'value', value => !!value);
+            splitButtonView.on('execute', () => {
+                editor.execute('codeBlock', {
+                    usePreviousLanguageChoice: true
+                });
+                editor.editing.view.focus();
+            });
+            dropdownView.on('execute', evt => {
+                editor.execute('codeBlock', {
+                    language: evt.source._codeBlockLanguage,
+                    forceValue: true
+                });
+                editor.editing.view.focus();
+            });
+            dropdownView.class = 'ck-code-block-dropdown';
+            dropdownView.bind('isEnabled').to(command);
+            addListToDropdown(dropdownView, () => this._getLanguageListItemDefinitions(normalizedLanguageDefs), {
+                role: 'menu',
+                ariaLabel: accessibleLabel
+            });
+            return dropdownView;
+        });
+    }
+    /**
+     * A helper returning a collection of the `codeBlock` dropdown items representing languages
+     * available for the user to choose from.
+     */
+    _getLanguageListItemDefinitions(normalizedLanguageDefs) {
+        const editor = this.editor;
+        const command = editor.commands.get('codeBlock');
+        const itemDefinitions = new Collection();
+        for (const languageDef of normalizedLanguageDefs) {
+            const definition = {
+                type: 'button',
+                model: new Model({
+                    _codeBlockLanguage: languageDef.language,
+                    label: languageDef.label,
+                    role: 'menuitemradio',
+                    withText: true
+                })
+            };
+            definition.model.bind('isOn').to(command, 'value', value => {
+                return value === definition.model._codeBlockLanguage;
+            });
+            itemDefinitions.add(definition);
+        }
+        return itemDefinitions;
+    }
+}

package/src/converters.d.ts

@@ -1,126 +1,126 @@
-/**
- * @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 code-block/converters
- */
-import type { GetCallback } from 'ckeditor5/src/utils';
-import type { DowncastInsertEvent, Model, UpcastElementEvent, UpcastTextEvent, View } from 'ckeditor5/src/engine';
-import type { CodeBlockLanguageDefinition } from './codeblockconfig';
-/**
- * A model-to-view (both editing and data) converter for the `codeBlock` element.
- *
- * Sample input:
- *
- * ```html
- * <codeBlock language="javascript">foo();<softBreak></softBreak>bar();</codeBlock>
- * ```
- *
- * Sample output (editing):
- *
- * ```html
- * <pre data-language="JavaScript"><code class="language-javascript">foo();<br />bar();</code></pre>
- * ```
- *
- * Sample output (data, see {@link module:code-block/converters~modelToDataViewSoftBreakInsertion}):
- *
- * ```html
- * <pre><code class="language-javascript">foo();\nbar();</code></pre>
- * ```
- *
- * @param languageDefs The normalized language configuration passed to the feature.
- * @param useLabels When `true`, the `<pre>` element will get a `data-language` attribute with a
- * human–readable label of the language. Used only in the editing.
- * @returns Returns a conversion callback.
- */
-export declare function modelToViewCodeBlockInsertion(model: Model, languageDefs: Array<CodeBlockLanguageDefinition>, useLabels?: boolean): GetCallback<DowncastInsertEvent>;
-/**
- * A model-to-data view converter for the new line (`softBreak`) separator.
- *
- * Sample input:
- *
- * ```html
- * <codeBlock ...>foo();<softBreak></softBreak>bar();</codeBlock>
- * ```
- *
- * Sample output:
- *
- * ```html
- * <pre><code ...>foo();\nbar();</code></pre>
- * ```
- *
- * @returns Returns a conversion callback.
- */
-export declare function modelToDataViewSoftBreakInsertion(model: Model): GetCallback<DowncastInsertEvent>;
-/**
- * A view-to-model converter for `<pre>` with the `<code>` HTML.
- *
- * Sample input:
- *
- * ```html
- * <pre><code class="language-javascript">foo();bar();</code></pre>
- * ```
- *
- * Sample output:
- *
- * ```html
- * <codeBlock language="javascript">foo();bar();</codeBlock>
- * ```
- *
- * @param languageDefs The normalized language configuration passed to the feature.
- * @returns Returns a conversion callback.
- */
-export declare function dataViewToModelCodeBlockInsertion(editingView: View, languageDefs: Array<CodeBlockLanguageDefinition>): GetCallback<UpcastElementEvent>;
-/**
- * A view-to-model converter for new line characters in `<pre>`.
- *
- * Sample input:
- *
- * ```html
- * <pre><code class="language-javascript">foo();\nbar();</code></pre>
- * ```
- *
- * Sample output:
- *
- * ```html
- * <codeBlock language="javascript">foo();<softBreak></softBreak>bar();</codeBlock>
- * ```
- *
- * @returns {Function} Returns a conversion callback.
- */
-export declare function dataViewToModelTextNewlinesInsertion(): GetCallback<UpcastTextEvent>;
-/**
- * A view-to-model converter that handles orphan text nodes (white spaces, new lines, etc.)
- * that surround `<code>` inside `<pre>`.
- *
- * Sample input:
- *
- * ```html
- * // White spaces
- * <pre> <code>foo()</code> </pre>
- *
- * // White spaces
- * <pre>      <code>foo()</code>      </pre>
- *
- * // White spaces
- * <pre>			<code>foo()</code>			</pre>
- *
- * // New lines
- * <pre>
- * 	<code>foo()</code>
- * </pre>
- *
- * // Redundant text
- * <pre>ABC<code>foo()</code>DEF</pre>
- * ```
- *
- * Unified output for each case:
- *
- * ```html
- * <codeBlock language="plaintext">foo()</codeBlock>
- * ```
- *
- * @returns Returns a conversion callback.
- */
-export declare function dataViewToModelOrphanNodeConsumer(): GetCallback<UpcastElementEvent>;
+/**
+ * @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 code-block/converters
+ */
+import type { GetCallback } from 'ckeditor5/src/utils';
+import type { DowncastInsertEvent, Model, UpcastElementEvent, UpcastTextEvent, View } from 'ckeditor5/src/engine';
+import type { CodeBlockLanguageDefinition } from './codeblockconfig';
+/**
+ * A model-to-view (both editing and data) converter for the `codeBlock` element.
+ *
+ * Sample input:
+ *
+ * ```html
+ * <codeBlock language="javascript">foo();<softBreak></softBreak>bar();</codeBlock>
+ * ```
+ *
+ * Sample output (editing):
+ *
+ * ```html
+ * <pre data-language="JavaScript"><code class="language-javascript">foo();<br />bar();</code></pre>
+ * ```
+ *
+ * Sample output (data, see {@link module:code-block/converters~modelToDataViewSoftBreakInsertion}):
+ *
+ * ```html
+ * <pre><code class="language-javascript">foo();\nbar();</code></pre>
+ * ```
+ *
+ * @param languageDefs The normalized language configuration passed to the feature.
+ * @param useLabels When `true`, the `<pre>` element will get a `data-language` attribute with a
+ * human–readable label of the language. Used only in the editing.
+ * @returns Returns a conversion callback.
+ */
+export declare function modelToViewCodeBlockInsertion(model: Model, languageDefs: Array<CodeBlockLanguageDefinition>, useLabels?: boolean): GetCallback<DowncastInsertEvent>;
+/**
+ * A model-to-data view converter for the new line (`softBreak`) separator.
+ *
+ * Sample input:
+ *
+ * ```html
+ * <codeBlock ...>foo();<softBreak></softBreak>bar();</codeBlock>
+ * ```
+ *
+ * Sample output:
+ *
+ * ```html
+ * <pre><code ...>foo();\nbar();</code></pre>
+ * ```
+ *
+ * @returns Returns a conversion callback.
+ */
+export declare function modelToDataViewSoftBreakInsertion(model: Model): GetCallback<DowncastInsertEvent>;
+/**
+ * A view-to-model converter for `<pre>` with the `<code>` HTML.
+ *
+ * Sample input:
+ *
+ * ```html
+ * <pre><code class="language-javascript">foo();bar();</code></pre>
+ * ```
+ *
+ * Sample output:
+ *
+ * ```html
+ * <codeBlock language="javascript">foo();bar();</codeBlock>
+ * ```
+ *
+ * @param languageDefs The normalized language configuration passed to the feature.
+ * @returns Returns a conversion callback.
+ */
+export declare function dataViewToModelCodeBlockInsertion(editingView: View, languageDefs: Array<CodeBlockLanguageDefinition>): GetCallback<UpcastElementEvent>;
+/**
+ * A view-to-model converter for new line characters in `<pre>`.
+ *
+ * Sample input:
+ *
+ * ```html
+ * <pre><code class="language-javascript">foo();\nbar();</code></pre>
+ * ```
+ *
+ * Sample output:
+ *
+ * ```html
+ * <codeBlock language="javascript">foo();<softBreak></softBreak>bar();</codeBlock>
+ * ```
+ *
+ * @returns {Function} Returns a conversion callback.
+ */
+export declare function dataViewToModelTextNewlinesInsertion(): GetCallback<UpcastTextEvent>;
+/**
+ * A view-to-model converter that handles orphan text nodes (white spaces, new lines, etc.)
+ * that surround `<code>` inside `<pre>`.
+ *
+ * Sample input:
+ *
+ * ```html
+ * // White spaces
+ * <pre> <code>foo()</code> </pre>
+ *
+ * // White spaces
+ * <pre>      <code>foo()</code>      </pre>
+ *
+ * // White spaces
+ * <pre>			<code>foo()</code>			</pre>
+ *
+ * // New lines
+ * <pre>
+ * 	<code>foo()</code>
+ * </pre>
+ *
+ * // Redundant text
+ * <pre>ABC<code>foo()</code>DEF</pre>
+ * ```
+ *
+ * Unified output for each case:
+ *
+ * ```html
+ * <codeBlock language="plaintext">foo()</codeBlock>
+ * ```
+ *
+ * @returns Returns a conversion callback.
+ */
+export declare function dataViewToModelOrphanNodeConsumer(): GetCallback<UpcastElementEvent>;