@ckeditor/ckeditor5-code-block 48.2.0-alpha.7 → 48.3.0-alpha.0

package/dist/augmentation.d.ts

@@ -1,25 +1,25 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import type { CodeBlock, CodeBlockCommand, CodeBlockConfig, CodeBlockEditing, CodeBlockUI, IndentCodeBlockCommand, OutdentCodeBlockCommand } from './index.js';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the {@link module:code-block/codeblock~CodeBlock} feature.
-         *
-         * Read more in {@link module:code-block/codeblockconfig~CodeBlockConfig}.
-         */
-        codeBlock?: CodeBlockConfig;
-    }
-    interface PluginsMap {
-        [CodeBlock.pluginName]: CodeBlock;
-        [CodeBlockEditing.pluginName]: CodeBlockEditing;
-        [CodeBlockUI.pluginName]: CodeBlockUI;
-    }
-    interface CommandsMap {
-        codeBlock: CodeBlockCommand;
-        indentCodeBlock: IndentCodeBlockCommand;
-        outdentCodeBlock: OutdentCodeBlockCommand;
-    }
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+import type { CodeBlock, CodeBlockCommand, CodeBlockConfig, CodeBlockEditing, CodeBlockUI, IndentCodeBlockCommand, OutdentCodeBlockCommand } from "./index.js";
+declare module "@ckeditor/ckeditor5-core" {
+	interface EditorConfig {
+		/**
+		* The configuration of the {@link module:code-block/codeblock~CodeBlock} feature.
+		*
+		* Read more in {@link module:code-block/codeblockconfig~CodeBlockConfig}.
+		*/
+		codeBlock?: CodeBlockConfig;
+	}
+	interface PluginsMap {
+		[CodeBlock.pluginName]: CodeBlock;
+		[CodeBlockEditing.pluginName]: CodeBlockEditing;
+		[CodeBlockUI.pluginName]: CodeBlockUI;
+	}
+	interface CommandsMap {
+		codeBlock: CodeBlockCommand;
+		indentCodeBlock: IndentCodeBlockCommand;
+		outdentCodeBlock: OutdentCodeBlockCommand;
+	}
 }

package/dist/codeblock.d.ts

@@ -1,33 +1,33 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module code-block/codeblock
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { CodeBlockEditing } from './codeblockediting.js';
-import { CodeBlockUI } from './codeblockui.js';
+* @module code-block/codeblock
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { CodeBlockEditing } from "./codeblockediting.js";
+import { CodeBlockUI } from "./codeblockui.js";
 /**
- * The code block plugin.
- *
- * For more information about this feature check the {@glink api/code-block package page} and the
- * {@glink features/code-blocks code block} feature guide.
- *
- * This is a "glue" plugin that loads the {@link module:code-block/codeblockediting~CodeBlockEditing code block editing feature}
- * and the {@link module:code-block/codeblockui~CodeBlockUI code block UI feature}.
- */
+* The code block plugin.
+*
+* For more information about this feature check the {@glink api/code-block package page} and the
+* {@glink features/code-blocks code block} feature guide.
+*
+* This is a "glue" plugin that loads the {@link module:code-block/codeblockediting~CodeBlockEditing code block editing feature}
+* and the {@link module:code-block/codeblockui~CodeBlockUI code block UI feature}.
+*/
 export declare class CodeBlock extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CodeBlockEditing, typeof CodeBlockUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CodeBlock";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[CodeBlockEditing, CodeBlockUI]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "CodeBlock";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
 }

package/dist/codeblockcommand.d.ts

@@ -1,60 +1,60 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
 /**
- * The code block command plugin.
- */
+* The code block command plugin.
+*/
 export declare class CodeBlockCommand extends Command {
-    /**
-     * Contains the last used language.
-     */
-    private _lastLanguage;
-    /**
-     * Contains language if any is selected, false otherwise.
-     * @observable
-     * @readonly
-     */
-    value: string | false;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command. When the command {@link #value is on}, all topmost code blocks within
-     * the selection will be removed. If it is off, all selected blocks will be flattened and
-     * wrapped by a code block.
-     *
-     * @fires execute
-     * @param options Command options.
-     * @param options.language The code block language.
-     * @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply a code block,
-     * otherwise the command will remove the code block. If not set, the command will act basing on its current value.
-     * @param options.usePreviousLanguageChoice If set on `true` and the `options.language` is not specified, the command
-     * will apply the previous language (if the command was already executed) when inserting the `codeBlock` element.
-     */
-    execute(options?: {
-        language?: string;
-        forceValue?: boolean;
-        usePreviousLanguageChoice?: boolean;
-    }): void;
-    /**
-     * Checks the command's {@link #value}.
-     *
-     * @returns The current value.
-     */
-    private _getValue;
-    /**
-     * Checks whether the command can be enabled in the current context.
-     *
-     * @returns Whether the command should be enabled.
-     */
-    private _checkEnabled;
-    private _applyCodeBlock;
-    private _removeCodeBlock;
+	/**
+	* Contains the last used language.
+	*/
+	private _lastLanguage;
+	/**
+	* Contains language if any is selected, false otherwise.
+	* @observable
+	* @readonly
+	*/
+	value: string | false;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* Executes the command. When the command {@link #value is on}, all topmost code blocks within
+	* the selection will be removed. If it is off, all selected blocks will be flattened and
+	* wrapped by a code block.
+	*
+	* @fires execute
+	* @param options Command options.
+	* @param options.language The code block language.
+	* @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply a code block,
+	* otherwise the command will remove the code block. If not set, the command will act basing on its current value.
+	* @param options.usePreviousLanguageChoice If set on `true` and the `options.language` is not specified, the command
+	* will apply the previous language (if the command was already executed) when inserting the `codeBlock` element.
+	*/
+	override execute(options?: {
+		language?: string;
+		forceValue?: boolean;
+		usePreviousLanguageChoice?: boolean;
+	}): void;
+	/**
+	* Checks the command's {@link #value}.
+	*
+	* @returns The current value.
+	*/
+	private _getValue;
+	/**
+	* Checks whether the command can be enabled in the current context.
+	*
+	* @returns Whether the command should be enabled.
+	*/
+	private _checkEnabled;
+	private _applyCodeBlock;
+	private _removeCodeBlock;
 }

package/dist/codeblockconfig.d.ts

@@ -1,150 +1,150 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module code-block/codeblockconfig
- */
+* @module code-block/codeblockconfig
+*/
 /**
- * The configuration of the {@link module:code-block/codeblock~CodeBlock code block feature}.
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		attachTo: editorElement,
- * 		codeBlock:  ... // The code block feature configuration.
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
+* The configuration of the {@link module:code-block/codeblock~CodeBlock code block feature}.
+*
+* ```ts
+* ClassicEditor
+* 	.create( {
+* 		attachTo: editorElement,
+* 		codeBlock:  ... // The code block feature configuration.
+* 	} )
+* 	.then( ... )
+* 	.catch( ... );
+* ```
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+*/
 export interface CodeBlockConfig {
-    /**
-     * The list of code languages available in the user interface to choose for a particular code block.
-     *
-     * The language of the code block is represented as a CSS class (by default prefixed by "language-") set on the
-     * `<code>` element, both when editing and in the editor data. The CSS class associated with the language
-     * can be used by third–party code syntax highlighters to detect and apply the correct highlighting.
-     *
-     * For instance, this language configuration:
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( {
-     * 		attachTo: document.querySelector( '#editor' ),
-     * 		codeBlock: {
-     * 			languages: [
-     * 				// ...
-     * 				{ language: 'javascript', label: 'JavaScript' },
-     * 				// ...
-     * 			]
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     *
-     * will result in the following structure of JavaScript code blocks in the editor editing and data:
-     *
-     * ```html
-     * <pre><code class="language-javascript">window.alert( 'Hello world!' )</code></pre>
-     * ```
-     *
-     * You can customize the CSS class by specifying an optional `class` property in the language definition.
-     * You can set **multiple classes** but **only the first one** will be used as defining language class:
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( {
-     * 		attachTo: document.querySelector( '#editor' ),
-     * 		codeBlock: {
-     * 			languages: [
-     * 				// Do not render the CSS class for the plain text code blocks.
-     * 				{ language: 'plaintext', label: 'Plain text', class: '' },
-     *
-     * 				// Use the "php-code" class for PHP code blocks.
-     * 				{ language: 'php', label: 'PHP', class: 'php-code' },
-     *
-     * 				// Use the "js" class for JavaScript code blocks.
-     * 				// Note that only the first ("js") class will determine the language of the block when loading data.
-     * 				{ language: 'javascript', label: 'JavaScript', class: 'js javascript js-code' },
-     *
-     * 				// Python code blocks will have the default "language-python" CSS class.
-     * 				{ language: 'python', label: 'Python' }
-     * 			]
-     * 		}
-     * } )
-     * .then( ... )
-     * .catch( ... );
-     * ```
-     *
-     * The default value of the language configuration is as follows:
-     *
-     * ```ts
-     * languages: [
-     * 	{ language: 'plaintext', label: 'Plain text' }, // The default language.
-     * 	{ language: 'c', label: 'C' },
-     * 	{ language: 'cs', label: 'C#' },
-     * 	{ language: 'cpp', label: 'C++' },
-     * 	{ language: 'css', label: 'CSS' },
-     * 	{ language: 'diff', label: 'Diff' },
-     * 	{ language: 'go', label: 'Go' },
-     * 	{ language: 'html', label: 'HTML' },
-     * 	{ language: 'java', label: 'Java' },
-     * 	{ language: 'javascript', label: 'JavaScript' },
-     * 	{ language: 'php', label: 'PHP' },
-     * 	{ language: 'python', label: 'Python' },
-     * 	{ language: 'ruby', label: 'Ruby' },
-     * 	{ language: 'typescript', label: 'TypeScript' },
-     * 	{ language: 'xml', label: 'XML' }
-     * ]
-     * ```
-     *
-     * **Note**: The first language defined in the configuration is considered the default one. This means it will be
-     * applied to code blocks loaded from the data that have no CSS `class` specified (or no matching `class` in the configuration).
-     * It will also be used when creating new code blocks using the main UI button. By default it is "Plain text".
-     */
-    languages?: Array<CodeBlockLanguageDefinition>;
-    /**
-     * A sequence of characters inserted or removed from the code block lines when its indentation
-     * is changed by the user, for instance, using <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> keys.
-     *
-     * The default value is a single tab character ("	", `\u0009` in Unicode).
-     *
-     * This configuration is used by `indentCodeBlock` and `outdentCodeBlock` commands (instances of
-     * {@link module:code-block/indentcodeblockcommand~IndentCodeBlockCommand}).
-     *
-     * **Note**: Setting this configuration to `false` will disable the code block indentation commands
-     * and associated keystrokes.
-     *
-     */
-    indentSequence?: string;
+	/**
+	* The list of code languages available in the user interface to choose for a particular code block.
+	*
+	* The language of the code block is represented as a CSS class (by default prefixed by "language-") set on the
+	* `<code>` element, both when editing and in the editor data. The CSS class associated with the language
+	* can be used by third–party code syntax highlighters to detect and apply the correct highlighting.
+	*
+	* For instance, this language configuration:
+	*
+	* ```ts
+	* ClassicEditor
+	* 	.create( {
+	* 		attachTo: document.querySelector( '#editor' ),
+	* 		codeBlock: {
+	* 			languages: [
+	* 				// ...
+	* 				{ language: 'javascript', label: 'JavaScript' },
+	* 				// ...
+	* 			]
+	* 		}
+	* 	} )
+	* 	.then( ... )
+	* 	.catch( ... );
+	* ```
+	*
+	* will result in the following structure of JavaScript code blocks in the editor editing and data:
+	*
+	* ```html
+	* <pre><code class="language-javascript">window.alert( 'Hello world!' )</code></pre>
+	* ```
+	*
+	* You can customize the CSS class by specifying an optional `class` property in the language definition.
+	* You can set **multiple classes** but **only the first one** will be used as defining language class:
+	*
+	* ```ts
+	* ClassicEditor
+	* 	.create( {
+	* 		attachTo: document.querySelector( '#editor' ),
+	* 		codeBlock: {
+	* 			languages: [
+	* 				// Do not render the CSS class for the plain text code blocks.
+	* 				{ language: 'plaintext', label: 'Plain text', class: '' },
+	*
+	* 				// Use the "php-code" class for PHP code blocks.
+	* 				{ language: 'php', label: 'PHP', class: 'php-code' },
+	*
+	* 				// Use the "js" class for JavaScript code blocks.
+	* 				// Note that only the first ("js") class will determine the language of the block when loading data.
+	* 				{ language: 'javascript', label: 'JavaScript', class: 'js javascript js-code' },
+	*
+	* 				// Python code blocks will have the default "language-python" CSS class.
+	* 				{ language: 'python', label: 'Python' }
+	* 			]
+	* 		}
+	* } )
+	* .then( ... )
+	* .catch( ... );
+	* ```
+	*
+	* The default value of the language configuration is as follows:
+	*
+	* ```ts
+	* languages: [
+	* 	{ language: 'plaintext', label: 'Plain text' }, // The default language.
+	* 	{ language: 'c', label: 'C' },
+	* 	{ language: 'cs', label: 'C#' },
+	* 	{ language: 'cpp', label: 'C++' },
+	* 	{ language: 'css', label: 'CSS' },
+	* 	{ language: 'diff', label: 'Diff' },
+	* 	{ language: 'go', label: 'Go' },
+	* 	{ language: 'html', label: 'HTML' },
+	* 	{ language: 'java', label: 'Java' },
+	* 	{ language: 'javascript', label: 'JavaScript' },
+	* 	{ language: 'php', label: 'PHP' },
+	* 	{ language: 'python', label: 'Python' },
+	* 	{ language: 'ruby', label: 'Ruby' },
+	* 	{ language: 'typescript', label: 'TypeScript' },
+	* 	{ language: 'xml', label: 'XML' }
+	* ]
+	* ```
+	*
+	* **Note**: The first language defined in the configuration is considered the default one. This means it will be
+	* applied to code blocks loaded from the data that have no CSS `class` specified (or no matching `class` in the configuration).
+	* It will also be used when creating new code blocks using the main UI button. By default it is "Plain text".
+	*/
+	languages?: Array<CodeBlockLanguageDefinition>;
+	/**
+	* A sequence of characters inserted or removed from the code block lines when its indentation
+	* is changed by the user, for instance, using <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> keys.
+	*
+	* The default value is a single tab character ("	", `\u0009` in Unicode).
+	*
+	* This configuration is used by `indentCodeBlock` and `outdentCodeBlock` commands (instances of
+	* {@link module:code-block/indentcodeblockcommand~IndentCodeBlockCommand}).
+	*
+	* **Note**: Setting this configuration to `false` will disable the code block indentation commands
+	* and associated keystrokes.
+	*
+	*/
+	indentSequence?: string;
 }
 /**
- * The code block language descriptor. See {@link module:code-block/codeblockconfig~CodeBlockConfig#languages} to learn more.
- *
- * ```ts
- * {
- * 	language: 'javascript',
- * 	label: 'JavaScript'
- * }
- * ```
- */
+* The code block language descriptor. See {@link module:code-block/codeblockconfig~CodeBlockConfig#languages} to learn more.
+*
+* ```ts
+* {
+* 	language: 'javascript',
+* 	label: 'JavaScript'
+* }
+* ```
+*/
 export interface CodeBlockLanguageDefinition {
-    /**
-     * The name of the language that will be stored in the model attribute. Also, when `class`
-     * is not specified, it will be used to create the CSS class associated with the language (prefixed by "language-").
-     */
-    language: string;
-    /**
-     * The human–readable label associated with the language and displayed in the UI.
-     */
-    label: string;
-    /**
-     * The CSS class associated with the language. When not specified the `language`
-     * property is used to create a class prefixed by "language-".
-     */
-    class?: string;
+	/**
+	* The name of the language that will be stored in the model attribute. Also, when `class`
+	* is not specified, it will be used to create the CSS class associated with the language (prefixed by "language-").
+	*/
+	language: string;
+	/**
+	* The human–readable label associated with the language and displayed in the UI.
+	*/
+	label: string;
+	/**
+	* The CSS class associated with the language. When not specified the `language`
+	* property is used to create a class prefixed by "language-".
+	*/
+	class?: string;
 }

package/dist/codeblockediting.d.ts

@@ -1,47 +1,47 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module code-block/codeblockediting
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { ShiftEnter } from '@ckeditor/ckeditor5-enter';
+* @module code-block/codeblockediting
+*/
+import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { ShiftEnter } from "@ckeditor/ckeditor5-enter";
 /**
- * The editing part of the code block feature.
- *
- * Introduces the `'codeBlock'` command and the `'codeBlock'` model element.
- */
+* The editing part of the code block feature.
+*
+* Introduces the `'codeBlock'` command and the `'codeBlock'` model element.
+*/
 export declare class CodeBlockEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CodeBlockEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ShiftEnter];
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Observe when user enters or leaves code block and set proper aria value in global live announcer.
-     * This allows screen readers to indicate when the user has entered and left the specified code block.
-     *
-     * @internal
-     */
-    private _initAriaAnnouncements;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "CodeBlockEditing";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[ShiftEnter]>;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
+	/**
+	* Observe when user enters or leaves code block and set proper aria value in global live announcer.
+	* This allows screen readers to indicate when the user has entered and left the specified code block.
+	*
+	* @internal
+	*/
+	private _initAriaAnnouncements;
 }