@ckeditor/ckeditor5-indent 41.3.1 → 41.4.0

package/dist/types/indentconfig.d.ts

@@ -0,0 +1,76 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, 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>;
+}

package/dist/types/indentediting.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+/**
+ * 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/dist/types/indentui.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, 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 'ckeditor5/src/core.js';
+/**
+ * The indent UI feature.
+ *
+ * This plugin registers the `'indent'` and `'outdent'` buttons.
+ *
+ * **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 IndentUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "IndentUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Defines UI buttons for both toolbar and menu bar.
+     */
+    private _defineButton;
+    /**
+     * Creates a button to use either in toolbar or in menu bar.
+     */
+    private _createButton;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module indent
+ */
+export { default as Indent } from './indent.js';
+export { default as IndentEditing } from './indentediting.js';
+export { default as IndentUI } from './indentui.js';
+export { default as IndentBlock } from './indentblock.js';
+export type { IndentBlockConfig } from './indentconfig.js';
+export type { default as IndentBlockCommand } from './indentblockcommand.js';
+import './augmentation.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-indent",
-  "version": "41.3.1",
+  "version": "41.4.0",
   "description": "Block indentation feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,7 +13,7 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "41.3.1"
+    "ckeditor5": "41.4.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",
@@ -25,6 +25,7 @@
     "directory": "packages/ckeditor5-indent"
   },
   "files": [
+    "dist",
     "lang",
     "src/**/*.js",
     "src/**/*.d.ts",