@ckeditor/ckeditor5-indent 36.0.1 → 37.0.0-alpha.0

package/src/indentblockcommand.js

@@ -2,14 +2,11 @@
  * @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 indent/indentblockcommand
  */
-
 import { Command } from 'ckeditor5/src/core';
 import { first } from 'ckeditor5/src/utils';
-
 /**
  * The indent block command.
  *
@@ -18,105 +15,64 @@ import { first } from 'ckeditor5/src/utils';
  *
  * To increase block indentation at the current selection, execute the command:
  *
- *		editor.execute( 'indentBlock' );
+ * ```ts
+ * editor.execute( 'indentBlock' );
+ * ```
  *
  * To decrease block indentation at the current selection, execute the command:
  *
- *		editor.execute( 'outdentBlock' );
- *
- * @extends module:core/command~Command
+ * ```ts
+ * editor.execute( 'outdentBlock' );
+ * ```
  */
 export default class IndentBlockCommand extends Command {
-	/**
-	 * Creates an instance of the command.
-	 *
-	 * @param {module:core/editor/editor~Editor} editor The editor instance.
-	 * @param {module:indent/indentblockcommand~IndentBehavior} indentBehavior
-	 */
-	constructor( editor, indentBehavior ) {
-		super( editor );
-
-		/**
-		 * The command's indentation behavior.
-		 *
-		 * @type {module:indent/indentblockcommand~IndentBehavior}
-		 * @private
-		 */
-		this._indentBehavior = indentBehavior;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	refresh() {
-		// Check whether any of the position's ancestors is a list item.
-		const editor = this.editor;
-		const model = editor.model;
-
-		const block = first( model.document.selection.getSelectedBlocks() );
-
-		if ( !block || !model.schema.checkAttribute( block, 'blockIndent' ) ) {
-			this.isEnabled = false;
-
-			return;
-		}
-
-		this.isEnabled = this._indentBehavior.checkEnabled( block.getAttribute( 'blockIndent' ) );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	execute() {
-		const model = this.editor.model;
-
-		const blocksToChange = getBlocksToChange( model );
-
-		model.change( writer => {
-			for ( const block of blocksToChange ) {
-				const currentIndent = block.getAttribute( 'blockIndent' );
-
-				const nextIndent = this._indentBehavior.getNextIndent( currentIndent );
-
-				if ( nextIndent ) {
-					writer.setAttribute( 'blockIndent', nextIndent, block );
-				} else {
-					writer.removeAttribute( 'blockIndent', block );
-				}
-			}
-		} );
-	}
-}
-
-// Returns blocks from selection that should have blockIndent selection set.
-//
-// @param {module:engine/model/model~model} model A model.
-function getBlocksToChange( model ) {
-	const selection = model.document.selection;
-	const schema = model.schema;
-	const blocksInSelection = Array.from( selection.getSelectedBlocks() );
-
-	return blocksInSelection.filter( block => schema.checkAttribute( block, 'blockIndent' ) );
+    /**
+     * Creates an instance of the command.
+     */
+    constructor(editor, indentBehavior) {
+        super(editor);
+        this._indentBehavior = indentBehavior;
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        // Check whether any of the position's ancestors is a list item.
+        const editor = this.editor;
+        const model = editor.model;
+        const block = first(model.document.selection.getSelectedBlocks());
+        if (!block || !model.schema.checkAttribute(block, 'blockIndent')) {
+            this.isEnabled = false;
+            return;
+        }
+        this.isEnabled = this._indentBehavior.checkEnabled(block.getAttribute('blockIndent'));
+    }
+    /**
+     * @inheritDoc
+     */
+    execute() {
+        const model = this.editor.model;
+        const blocksToChange = getBlocksToChange(model);
+        model.change(writer => {
+            for (const block of blocksToChange) {
+                const currentIndent = block.getAttribute('blockIndent');
+                const nextIndent = this._indentBehavior.getNextIndent(currentIndent);
+                if (nextIndent) {
+                    writer.setAttribute('blockIndent', nextIndent, block);
+                }
+                else {
+                    writer.removeAttribute('blockIndent', block);
+                }
+            }
+        });
+    }
 }
-
-/**
- * Provides indentation behavior to {@link module:indent/indentblockcommand~IndentBlockCommand}.
- *
- * @interface module:indent/indentblockcommand~IndentBehavior
- */
-
 /**
- * Checks if the command should be enabled.
- *
- * @method #checkEnabled
- * @param {String} indentAttributeValue The current indent attribute value.
- * @returns {Boolean}
- */
-
-/**
- * Returns a new indent attribute value based on the current indent. This method returns `undefined` when the indentation should be removed.
- *
- * @method #getNextIndent
- * @param {String} indentAttributeValue The current indent attribute value.
- * @returns {String|undefined}
+ * Returns blocks from selection that should have blockIndent selection set.
  */
+function getBlocksToChange(model) {
+    const selection = model.document.selection;
+    const schema = model.schema;
+    const blocksInSelection = Array.from(selection.getSelectedBlocks());
+    return blocksInSelection.filter(block => schema.checkAttribute(block, 'blockIndent'));
+}

package/src/indentcommandbehavior/indentbehavior.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 indent/indentcommandbehavior/indentbehavior
+ */
+/**
+ * Provides indentation behavior to {@link module:indent/indentblockcommand~IndentBlockCommand}.
+ */
+export interface IndentBehavior {
+    /**
+     * Checks if the command should be enabled.
+     */
+    checkEnabled: (indentAttributeValue: string) => boolean;
+    /**
+     * Returns a new indent attribute value based on the current indent.
+     * This method returns `undefined` when the indentation should be removed.
+     */
+    getNextIndent: (indentAttributeValue: string) => string | undefined;
+}

package/src/indentcommandbehavior/indentbehavior.js

@@ -0,0 +1,5 @@
+/**
+ * @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
+ */
+export {};

package/src/indentcommandbehavior/indentusingclasses.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @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 indent/indentcommandbehavior/indentusingclasses
+ */
+import type { IndentBehavior } from './indentbehavior';
+/**
+ * The block indentation behavior that uses classes to set indentation.
+ */
+export default class IndentUsingClasses implements IndentBehavior {
+    /**
+     * The direction of indentation.
+     */
+    isForward: boolean;
+    /**
+     * A list of classes used for indentation.
+     */
+    classes: Array<string>;
+    /**
+     * Creates an instance of the indentation behavior.
+     *
+     * @param config.direction The direction of indentation.
+     * @param config.classes A list of classes used for indentation.
+     */
+    constructor(config: {
+        direction: 'forward' | 'backward';
+        classes: Array<string>;
+    });
+    /**
+     * @inheritDoc
+     */
+    checkEnabled(indentAttributeValue: string): boolean;
+    /**
+     * @inheritDoc
+     */
+    getNextIndent(indentAttributeValue: string): string | undefined;
+}

package/src/indentcommandbehavior/indentusingclasses.js

@@ -2,60 +2,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 indent/indentcommandbehavior/indentusingclasses
- */
-
 /**
  * The block indentation behavior that uses classes to set indentation.
- *
- * @implements module:indent/indentblockcommand~IndentBehavior
  */
 export default class IndentUsingClasses {
-	/**
-	 * Creates an instance of the indentation behavior.
-	 *
-	 * @param {Object} config
-	 * @param {String} config.direction The direction of indentation.
-	 * @param {Array.<String>} config.classes A list of classes used for indentation.
-	 */
-	constructor( config ) {
-		/**
-		 * The direction of indentation.
-		 *
-		 * @type {Boolean}
-		 */
-		this.isForward = config.direction === 'forward';
-
-		/**
-		 * A list of classes used for indentation.
-		 *
-		 * @type {Array.<String>}
-		 */
-		this.classes = config.classes;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	checkEnabled( indentAttributeValue ) {
-		const currentIndex = this.classes.indexOf( indentAttributeValue );
-
-		if ( this.isForward ) {
-			return currentIndex < this.classes.length - 1;
-		} else {
-			return currentIndex >= 0;
-		}
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	getNextIndent( indentAttributeValue ) {
-		const currentIndex = this.classes.indexOf( indentAttributeValue );
-		const indexStep = this.isForward ? 1 : -1;
-
-		return this.classes[ currentIndex + indexStep ];
-	}
+    /**
+     * Creates an instance of the indentation behavior.
+     *
+     * @param config.direction The direction of indentation.
+     * @param config.classes A list of classes used for indentation.
+     */
+    constructor(config) {
+        this.isForward = config.direction === 'forward';
+        this.classes = config.classes;
+    }
+    /**
+     * @inheritDoc
+     */
+    checkEnabled(indentAttributeValue) {
+        const currentIndex = this.classes.indexOf(indentAttributeValue);
+        if (this.isForward) {
+            return currentIndex < this.classes.length - 1;
+        }
+        else {
+            return currentIndex >= 0;
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    getNextIndent(indentAttributeValue) {
+        const currentIndex = this.classes.indexOf(indentAttributeValue);
+        const indexStep = this.isForward ? 1 : -1;
+        return this.classes[currentIndex + indexStep];
+    }
 }

package/src/indentcommandbehavior/indentusingoffset.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @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 indent/indentcommandbehavior/indentusingoffset
+ */
+import type { IndentBehavior } from './indentbehavior';
+/**
+ * The block indentation behavior that uses offsets to set indentation.
+ */
+export default class IndentUsingOffset implements IndentBehavior {
+    /**
+     * The direction of indentation.
+     */
+    isForward: boolean;
+    /**
+     * The offset of the next indentation step.
+     */
+    offset: number;
+    /**
+     * Indentation unit.
+     */
+    unit: string;
+    /**
+     * Creates an instance of the indentation behavior.
+     *
+     * @param config.direction The direction of indentation.
+     * @param config.offset The offset of the next indentation step.
+     * @param config.unit Indentation unit.
+     */
+    constructor(config: {
+        direction: 'forward' | 'backward';
+        offset: number;
+        unit: string;
+    });
+    /**
+     * @inheritDoc
+     */
+    checkEnabled(indentAttributeValue: string): boolean;
+    /**
+     * @inheritDoc
+     */
+    getNextIndent(indentAttributeValue: string): string | undefined;
+}

package/src/indentcommandbehavior/indentusingoffset.js

@@ -2,73 +2,41 @@
  * @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 indent/indentcommandbehavior/indentusingoffset
- */
-
 /**
  * The block indentation behavior that uses offsets to set indentation.
- *
- * @implements module:indent/indentblockcommand~IndentBehavior
  */
 export default class IndentUsingOffset {
-	/**
-	 * Creates an instance of the indentation behavior.
-	 *
-	 * @param {Object} config
-	 * @param {String} config.direction The direction of indentation.
-	 * @param {Number} config.offset The offset of the next indentation step.
-	 * @param {String} config.unit Indentation unit.
-	 */
-	constructor( config ) {
-		/**
-		 * The direction of indentation.
-		 *
-		 * @type {Boolean}
-		 */
-		this.isForward = config.direction === 'forward';
-
-		/**
-		 * The offset of the next indentation step.
-		 *
-		 * @type {Number}
-		 */
-		this.offset = config.offset;
-
-		/**
-		 * Indentation unit.
-		 *
-		 * @type {String}
-		 */
-		this.unit = config.unit;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	checkEnabled( indentAttributeValue ) {
-		const currentOffset = parseFloat( indentAttributeValue || 0 );
-
-		// The command is always enabled for forward indentation.
-		return this.isForward || currentOffset > 0;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	getNextIndent( indentAttributeValue ) {
-		const currentOffset = parseFloat( indentAttributeValue || 0 );
-		const isSameUnit = !indentAttributeValue || indentAttributeValue.endsWith( this.unit );
-
-		if ( !isSameUnit ) {
-			return this.isForward ? this.offset + this.unit : undefined;
-		}
-
-		const nextOffset = this.isForward ? this.offset : -this.offset;
-
-		const offsetToSet = currentOffset + nextOffset;
-
-		return offsetToSet > 0 ? offsetToSet + this.unit : undefined;
-	}
+    /**
+     * Creates an instance of the indentation behavior.
+     *
+     * @param config.direction The direction of indentation.
+     * @param config.offset The offset of the next indentation step.
+     * @param config.unit Indentation unit.
+     */
+    constructor(config) {
+        this.isForward = config.direction === 'forward';
+        this.offset = config.offset;
+        this.unit = config.unit;
+    }
+    /**
+     * @inheritDoc
+     */
+    checkEnabled(indentAttributeValue) {
+        const currentOffset = parseFloat(indentAttributeValue || '0');
+        // The command is always enabled for forward indentation.
+        return this.isForward || currentOffset > 0;
+    }
+    /**
+     * @inheritDoc
+     */
+    getNextIndent(indentAttributeValue) {
+        const currentOffset = parseFloat(indentAttributeValue || '0');
+        const isSameUnit = !indentAttributeValue || indentAttributeValue.endsWith(this.unit);
+        if (!isSameUnit) {
+            return this.isForward ? this.offset + this.unit : undefined;
+        }
+        const nextOffset = this.isForward ? this.offset : -this.offset;
+        const offsetToSet = currentOffset + nextOffset;
+        return offsetToSet > 0 ? offsetToSet + this.unit : undefined;
+    }
 }

package/src/indentconfig.d.ts

@@ -0,0 +1,82 @@
+/**
+ * @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 indent/indentconfig
+ */
+/**
+ * The configuration of the block indentation feature.
+ *
+ * If no {@link module:indent/indentconfig~IndentBlockConfig#classes} are set, the block indentation feature will use
+ * {@link module:indent/indentconfig~IndentBlockConfig#offset} and {@link module:indent/indentconfig~IndentBlockConfig#unit} to
+ * create indentation steps.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		indentBlock: {
+ * 			offset: 2,
+ * 			unit: 'em'
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * Alternatively, the block indentation feature may set one of defined {@link module:indent/indentconfig~IndentBlockConfig#classes} as
+ * indentation steps:
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		indentBlock: {
+ * 			classes: [
+ * 				'indent-a', // The first step - smallest indentation.
+ * 				'indent-b',
+ * 				'indent-c',
+ * 				'indent-d',
+ * 				'indent-e' // The last step - biggest indentation.
+ * 			]
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * In the example above only 5 indentation steps will be available.
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface IndentBlockConfig {
+    /**
+     * The size of indentation {@link module:indent/indentconfig~IndentBlockConfig#unit units} for each indentation step.
+     *
+     * @default 40
+     */
+    offset?: number;
+    /**
+     * The unit used for indentation {@link module:indent/indentconfig~IndentBlockConfig#offset}.
+     *
+     * @default 'px'
+     */
+    unit?: string;
+    /**
+     * An optional list of classes to use for indenting the editor content. If not set or set to an empty array, no classes will be used.
+     * The {@link module:indent/indentconfig~IndentBlockConfig#unit `indentBlock.unit`} and
+     * {@link module:indent/indentconfig~IndentBlockConfig#offset `indentBlock.offset`} properties will be used instead.
+     *
+     * @default undefined
+     */
+    classes?: Array<string>;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:indent/indentblock~IndentBlock block indentation feature}.
+         *
+         * Read more in {@link module:indent/indentconfig~IndentBlockConfig}.
+         */
+        indentBlock?: IndentBlockConfig;
+    }
+}

package/src/indentconfig.js

@@ -0,0 +1,5 @@
+/**
+ * @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
+ */
+export {};

package/src/indentediting.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @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 indent/indentediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * The indent editing feature.
+ *
+ * This plugin registers the `'indent'` and `'outdent'` commands.
+ *
+ * **Note**: In order for the commands to work, at least one of the compatible features is required. Read more in the
+ * {@link module:indent/indent~Indent indent feature} API documentation.
+ */
+export default class IndentEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'IndentEditing';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/indentediting.js

@@ -2,13 +2,10 @@
  * @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 indent/indentediting
  */
-
 import { Plugin, MultiCommand } from 'ckeditor5/src/core';
-
 /**
  * The indent editing feature.
  *
@@ -16,24 +13,20 @@ import { Plugin, MultiCommand } from 'ckeditor5/src/core';
  *
  * **Note**: In order for the commands to work, at least one of the compatible features is required. Read more in the
  * {@link module:indent/indent~Indent indent feature} API documentation.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class IndentEditing extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'IndentEditing';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-
-		editor.commands.add( 'indent', new MultiCommand( editor ) );
-		editor.commands.add( 'outdent', new MultiCommand( editor ) );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'IndentEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        editor.commands.add('indent', new MultiCommand(editor));
+        editor.commands.add('outdent', new MultiCommand(editor));
+    }
 }