@ckeditor/ckeditor5-block-quote 41.3.1 → 41.4.0

package/dist/types/blockquote.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @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 block-quote/blockquote
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import BlockQuoteEditing from './blockquoteediting.js';
+import BlockQuoteUI from './blockquoteui.js';
+/**
+ * The block quote plugin.
+ *
+ * For more information about this feature check the {@glink api/block-quote package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:block-quote/blockquoteediting~BlockQuoteEditing block quote editing feature}
+ * and {@link module:block-quote/blockquoteui~BlockQuoteUI block quote UI feature}.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class BlockQuote extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof BlockQuoteEditing, typeof BlockQuoteUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "BlockQuote";
+}

package/dist/types/blockquotecommand.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @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 block-quote/blockquotecommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+/**
+ * The block quote command plugin.
+ *
+ * @extends module:core/command~Command
+ */
+export default class BlockQuoteCommand extends Command {
+    /**
+     * Whether the selection starts in a block quote.
+     *
+     * @observable
+     * @readonly
+     */
+    value: boolean;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command. When the command {@link #value is on}, all top-most block quotes within
+     * the selection will be removed. If it is off, all selected blocks will be wrapped with
+     * a block quote.
+     *
+     * @fires execute
+     * @param options Command options.
+     * @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply a block quote,
+     * otherwise the command will remove the block quote. If not set, the command will act basing on its current value.
+     */
+    execute(options?: {
+        forceValue?: boolean;
+    }): void;
+    /**
+     * Checks the command's {@link #value}.
+     */
+    private _getValue;
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    private _checkEnabled;
+    /**
+     * Removes the quote from given blocks.
+     *
+     * If blocks which are supposed to be "unquoted" are in the middle of a quote,
+     * start it or end it, then the quote will be split (if needed) and the blocks
+     * will be moved out of it, so other quoted blocks remained quoted.
+     */
+    private _removeQuote;
+    /**
+     * Applies the quote to given blocks.
+     */
+    private _applyQuote;
+}

package/dist/types/blockquoteediting.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
+ */
+/**
+ * @module block-quote/blockquoteediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { Enter } from 'ckeditor5/src/enter.js';
+import { Delete } from 'ckeditor5/src/typing.js';
+/**
+ * The block quote editing.
+ *
+ * Introduces the `'blockQuote'` command and the `'blockQuote'` model element.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class BlockQuoteEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "BlockQuoteEditing";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof Enter, typeof Delete];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/dist/types/blockquoteui.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @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 block-quote/blockquoteui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import '../theme/blockquote.css';
+/**
+ * The block quote UI plugin.
+ *
+ * It introduces the `'blockQuote'` button.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class BlockQuoteUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "BlockQuoteUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Creates a button for block quote command to use either in toolbar or in menu bar.
+     */
+    private _createButton;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @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 block-quote
+ */
+export { default as BlockQuote } from './blockquote.js';
+export { default as BlockQuoteEditing } from './blockquoteediting.js';
+export { default as BlockQuoteUI } from './blockquoteui.js';
+export type { default as BlockQuoteCommand } from './blockquotecommand.js';
+import './augmentation.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-block-quote",
-  "version": "41.3.1",
+  "version": "41.4.0",
   "description": "Block quote 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-block-quote"
   },
   "files": [
+    "dist",
     "lang",
     "src/**/*.js",
     "src/**/*.d.ts",