ckeditor5-elements-schema 49.0.0-alpha.2 → 49.0.0-alpha.4

package/dist/elementSchemaCommands.d.ts

@@ -0,0 +1,83 @@
+import { Plugin } from 'ckeditor5';
+import ElementSchema from './elementSchema.js';
+/**
+ * An element of {@link ElementSchemaCommands}: its command and its button.
+ */
+export interface ElementSchemaCommandDefinition {
+    /**
+     * The model element: of the element schema, or of another plugin. Default: the name of the command.
+     */
+    element?: string;
+    /**
+     * The title of the command, and the label of its button, e.g. `'Bold'`.
+     */
+    title: string;
+    /**
+     * The icon of the command and of its button (an SVG string), e.g. `IconBold` of CKEditor.
+     */
+    icon?: string;
+    /**
+     * The keystroke that executes the command, e.g. `'Ctrl+B'`.
+     */
+    keystroke?: string;
+    /**
+     * The tag of the element in the data and in the editing view, e.g. `'strong'` or `'hr'`. The converters of the plugin
+     * replace the ones of the element schema (`elementSchemaConverters`) in the downcast, and the upcast takes both.
+     * Without it, the element is converted by the schema, or by your converters.
+     */
+    view?: string;
+}
+/**
+ * The `elementSchemaCommands` option: the elements, by the name of their command and of their button.
+ */
+export type ElementSchemaCommandsConfig = Record<string, ElementSchemaCommandDefinition>;
+/**
+ * Commands and toolbar buttons for the elements of the element schema, as CKEditor's features have for theirs: the
+ * command of an element is the one of its kind (see {@link ElementSchemaCommand}).
+ *
+ * | Element                       | Command                     | Works as CKEditor's           |
+ * | ----------------------------- | --------------------------- | ----------------------------- |
+ * | inline `block`                | {@link ElementInlineCommand}    | bold: wraps text              |
+ * | `block`                       | {@link ElementBlockCommand}     | heading: renames blocks       |
+ * | `container`                   | {@link ElementContainerCommand} | block quote: wraps blocks     |
+ * | `empty`, inline `container`   | {@link ElementInsertCommand}    | horizontal line: inserts      |
+ *
+ * ```ts
+ * elementSchema: schema,
+ * elementSchemaCommands: {
+ *   bold: { title: 'Bold', icon: IconBold, keystroke: 'Ctrl+B', view: 'strong' },
+ *   callout: { title: 'Callout', icon: IconQuote },
+ *   divider: { title: 'Divider', icon: IconHorizontalLine, view: 'hr' }
+ * },
+ * toolbar: ['bold', 'callout', 'divider']
+ * ```
+ *
+ * Each key is the name of the command and of its toolbar button. The commands have titles and icons, so they can be
+ * menu items too, e.g. of the context menu.
+ *
+ * At the ends of the inline elements with text, the left and right arrow keys move in two steps, as CKEditor's two-step
+ * caret movement does at the ends of a bold: in the element, then in the text.
+ *
+ * The commands are made when the elements are registered, after `ElementSchema` and the other plugins are initialized.
+ * The editor is not created when an element is unknown.
+ */
+export default class ElementSchemaCommands extends Plugin {
+    static get pluginName(): 'ElementSchemaCommands';
+    static get requires(): readonly [typeof ElementSchema];
+    /**
+     * The commands, by their name.
+     */
+    private readonly _commands;
+    init(): void;
+    /**
+     * Makes the commands of the elements, which are registered then, and their converters.
+     */
+    afterInit(): void;
+    private _getDefinitions;
+    /**
+     * Declares the converters of an element with the tag of its `view`: the downcast with the highest priority, so it
+     * replaces the ones of the element schema, and the upcast.
+     */
+    private _convert;
+}
+//# sourceMappingURL=elementSchemaCommands.d.ts.map

package/dist/elementSchemaCommands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"elementSchemaCommands.d.ts","sourceRoot":"","sources":["../src/elementSchemaCommands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAA+D,MAAM,WAAW,CAAC;AAOhG,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAI/C;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC9C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,MAAM,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAAC;AAEzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,MAAM;IACxD,WAAkB,UAAU,IAAI,uBAAuB,CAEtD;IAED,WAAkB,QAAQ,IAAI,SAAS,CAAC,OAAO,aAAa,CAAC,CAE5D;IAED;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA2C;IAE9D,IAAI,IAAI,IAAI;IA2BnB;;OAEG;IACI,SAAS,IAAI,IAAI;IA0CxB,OAAO,CAAC,eAAe;IAIvB;;;OAGG;IACH,OAAO,CAAC,QAAQ;CAWhB"}

package/dist/elementSchemaCommands.js

@@ -0,0 +1,137 @@
+import { Plugin } from 'ckeditor5';
+import { ElementOrPositionButtonView } from 'ckeditor5-elements-core';
+import { createInlineTextElement } from './conversion/inlineTextElement.js';
+import ElementBlockCommand from './commands/elementBlockCommand.js';
+import ElementContainerCommand from './commands/elementContainerCommand.js';
+import ElementInlineCommand from './commands/elementInlineCommand.js';
+import ElementInsertCommand from './commands/elementInsertCommand.js';
+import ElementSchema from './elementSchema.js';
+import { enableTwoStepCaretMovement } from './typing/twoStepCaretMovement.js';
+/**
+ * Commands and toolbar buttons for the elements of the element schema, as CKEditor's features have for theirs: the
+ * command of an element is the one of its kind (see {@link ElementSchemaCommand}).
+ *
+ * | Element                       | Command                     | Works as CKEditor's           |
+ * | ----------------------------- | --------------------------- | ----------------------------- |
+ * | inline `block`                | {@link ElementInlineCommand}    | bold: wraps text              |
+ * | `block`                       | {@link ElementBlockCommand}     | heading: renames blocks       |
+ * | `container`                   | {@link ElementContainerCommand} | block quote: wraps blocks     |
+ * | `empty`, inline `container`   | {@link ElementInsertCommand}    | horizontal line: inserts      |
+ *
+ * ```ts
+ * elementSchema: schema,
+ * elementSchemaCommands: {
+ *   bold: { title: 'Bold', icon: IconBold, keystroke: 'Ctrl+B', view: 'strong' },
+ *   callout: { title: 'Callout', icon: IconQuote },
+ *   divider: { title: 'Divider', icon: IconHorizontalLine, view: 'hr' }
+ * },
+ * toolbar: ['bold', 'callout', 'divider']
+ * ```
+ *
+ * Each key is the name of the command and of its toolbar button. The commands have titles and icons, so they can be
+ * menu items too, e.g. of the context menu.
+ *
+ * At the ends of the inline elements with text, the left and right arrow keys move in two steps, as CKEditor's two-step
+ * caret movement does at the ends of a bold: in the element, then in the text.
+ *
+ * The commands are made when the elements are registered, after `ElementSchema` and the other plugins are initialized.
+ * The editor is not created when an element is unknown.
+ */
+export default class ElementSchemaCommands extends Plugin {
+    static get pluginName() {
+        return 'ElementSchemaCommands';
+    }
+    static get requires() {
+        return [ElementSchema];
+    }
+    /**
+     * The commands, by their name.
+     */
+    _commands = new Map();
+    init() {
+        const editor = this.editor;
+        for (const [name, { title, keystroke }] of this._getDefinitions()) {
+            if (keystroke) {
+                editor.keystrokes.set(keystroke, name);
+                editor.accessibility.addKeystrokeInfos({ keystrokes: [{ label: title, keystroke }] });
+            }
+            editor.ui.componentFactory.add(name, locale => {
+                const command = this._commands.get(name);
+                // The commands are made in `afterInit()`, and the toolbars after it.
+                if (!command) {
+                    throw new Error(`elementSchemaCommands.${name}: the button is created before the command.`);
+                }
+                const button = new ElementOrPositionButtonView(locale, command);
+                button.bind('isOn').to(command, 'isOn');
+                button.keystroke = keystroke;
+                return button;
+            });
+        }
+    }
+    /**
+     * Makes the commands of the elements, which are registered then, and their converters.
+     */
+    afterInit() {
+        const editor = this.editor;
+        const schema = editor.model.schema;
+        const inlineNames = new Set();
+        for (const [name, { element, title, icon, view }] of this._getDefinitions()) {
+            const elementName = element ?? name;
+            if (!schema.isRegistered(elementName)) {
+                throw new Error(`elementSchemaCommands.${name}: unknown element "${elementName}". Declare it in the element schema, or ` +
+                    `set "element" to an element of another plugin.`);
+            }
+            const CommandClass = getCommandClass(schema, elementName);
+            const command = new CommandClass(editor, elementName);
+            command.set({ title, icon });
+            editor.commands.add(name, command);
+            this._commands.set(name, command);
+            if (command instanceof ElementInlineCommand) {
+                inlineNames.add(elementName);
+            }
+            if (view) {
+                this._convert(elementName, view, (writer) => {
+                    if (command instanceof ElementInlineCommand) {
+                        return createInlineTextElement(writer, view);
+                    }
+                    return schema.isObject(elementName)
+                        ? writer.createEmptyElement(view)
+                        : writer.createContainerElement(view);
+                });
+            }
+        }
+        enableTwoStepCaretMovement(this, inlineNames);
+    }
+    _getDefinitions() {
+        return Object.entries(this.editor.config.get('elementSchemaCommands') ?? {});
+    }
+    /**
+     * Declares the converters of an element with the tag of its `view`: the downcast with the highest priority, so it
+     * replaces the ones of the element schema, and the upcast.
+     */
+    _convert(elementName, tag, createView) {
+        const conversion = this.editor.conversion;
+        conversion.for('upcast').elementToElement({ view: tag, model: elementName });
+        conversion.for('downcast').elementToElement({
+            model: elementName,
+            view: (_element, { writer }) => createView(writer),
+            // Over the ones of the schema, some of which are `high` already.
+            converterPriority: 'highest'
+        });
+    }
+}
+/**
+ * Returns the command of an element, by its kind: an object, or an inline element with no text, is inserted; an inline
+ * element with text wraps text; a block-level one with text is a block; the others are containers.
+ */
+function getCommandClass(schema, name) {
+    const holdsText = schema.checkChild(name, '$text');
+    if (schema.isObject(name) || (schema.isInline(name) && !holdsText)) {
+        return ElementInsertCommand;
+    }
+    if (schema.isInline(name)) {
+        return ElementInlineCommand;
+    }
+    return holdsText ? ElementBlockCommand : ElementContainerCommand;
+}
+//# sourceMappingURL=elementSchemaCommands.js.map

package/dist/elementSchemaCommands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"elementSchemaCommands.js","sourceRoot":"","sources":["../src/elementSchemaCommands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAA+D,MAAM,WAAW,CAAC;AAChG,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AAC5E,OAAO,mBAAmB,MAAM,mCAAmC,CAAC;AACpE,OAAO,uBAAuB,MAAM,uCAAuC,CAAC;AAC5E,OAAO,oBAAoB,MAAM,oCAAoC,CAAC;AACtE,OAAO,oBAAoB,MAAM,oCAAoC,CAAC;AACtE,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAuC9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,MAAM;IACjD,MAAM,KAAK,UAAU;QAC3B,OAAO,uBAAgC,CAAC;IACzC,CAAC;IAEM,MAAM,KAAK,QAAQ;QACzB,OAAO,CAAC,aAAa,CAAU,CAAC;IACjC,CAAC;IAED;;OAEG;IACc,SAAS,GAAG,IAAI,GAAG,EAAgC,CAAC;IAE9D,IAAI;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE3B,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;YACnE,IAAI,SAAS,EAAE,CAAC;gBACf,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;gBACvC,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;YACvF,CAAC;YAED,MAAM,CAAC,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE;gBAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAEzC,qEAAqE;gBACrE,IAAI,CAAC,OAAO,EAAE,CAAC;oBACd,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,6CAA6C,CAAC,CAAC;gBAC7F,CAAC;gBAED,MAAM,MAAM,GAAG,IAAI,2BAA2B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAEhE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;gBACxC,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;gBAE7B,OAAO,MAAM,CAAC;YACf,CAAC,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED;;OAEG;IACI,SAAS;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;QACnC,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;QAEtC,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,IAAI,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;YAC7E,MAAM,WAAW,GAAG,OAAO,IAAI,IAAI,CAAC;YAEpC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC;gBACvC,MAAM,IAAI,KAAK,CACd,yBAAyB,IAAI,sBAAsB,WAAW,0CAA0C;oBACvG,gDAAgD,CACjD,CAAC;YACH,CAAC;YAED,MAAM,YAAY,GAAG,eAAe,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAC1D,MAAM,OAAO,GAAG,IAAI,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;YAEtD,OAAO,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YAC7B,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YACnC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAElC,IAAI,OAAO,YAAY,oBAAoB,EAAE,CAAC;gBAC7C,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC9B,CAAC;YAED,IAAI,IAAI,EAAE,CAAC;gBACV,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,MAA0B,EAAE,EAAE;oBAC/D,IAAI,OAAO,YAAY,oBAAoB,EAAE,CAAC;wBAC7C,OAAO,uBAAuB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;oBAC9C,CAAC;oBAED,OAAO,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC;wBAClC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC;wBACjC,CAAC,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;gBACxC,CAAC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAED,0BAA0B,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAC/C,CAAC;IAEO,eAAe;QACtB,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACK,QAAQ,CAAC,WAAmB,EAAE,GAAW,EAAE,UAAuD;QACzG,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;QAE1C,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;QAC7E,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,gBAAgB,CAAC;YAC3C,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC;YAClD,iEAAiE;YACjE,iBAAiB,EAAE,SAAS;SAC5B,CAAC,CAAC;IACJ,CAAC;CACD;AAED;;;GAGG;AACH,SAAS,eAAe,CAAC,MAAmB,EAAE,IAAY;IACzD,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAEnD,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACpE,OAAO,oBAAoB,CAAC;IAC7B,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,OAAO,oBAAoB,CAAC;IAC7B,CAAC;IAED,OAAO,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,uBAAuB,CAAC;AAClE,CAAC"}

package/dist/index.d.ts

@@ -1,10 +1,18 @@
 /**
  * Element schema: declare elements in the model schema from a simple definition, e.g. a JSON file, with three types of
- * elements (`empty`, `block`, `container`), and a validation that rejects contradictory definitions.
+ * elements (`empty`, `block`, `container`), and a validation that rejects contradictory definitions. `ElementSchemaCommands`
+ * makes commands and buttons for its elements.
  *
  * @module ckeditor5-elements-schema
  */
 export { default as ElementSchema } from './elementSchema.js';
+export { default as ElementSchemaCommands, type ElementSchemaCommandDefinition, type ElementSchemaCommandsConfig } from './elementSchemaCommands.js';
+export { default as ElementSchemaCommand } from './commands/elementSchemaCommand.js';
+export { default as ElementInlineCommand } from './commands/elementInlineCommand.js';
+export { default as ElementBlockCommand } from './commands/elementBlockCommand.js';
+export { default as ElementContainerCommand } from './commands/elementContainerCommand.js';
+export { default as ElementInsertCommand } from './commands/elementInsertCommand.js';
+export { withoutBlockFiller } from './conversion/inlineTextElement.js';
 export * from './validate.js';
 import './augmentation.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAG9D,cAAc,eAAe,CAAC;AAE9B,OAAO,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EACN,OAAO,IAAI,qBAAqB,EAChC,KAAK,8BAA8B,EACnC,KAAK,2BAA2B,EAChC,MAAM,4BAA4B,CAAC;AAGpC,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AACrF,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AACrF,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACnF,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAC3F,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAGrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAGvE,cAAc,eAAe,CAAC;AAE9B,OAAO,mBAAmB,CAAC"}

package/dist/index.js

@@ -1,11 +1,21 @@
 /**
  * Element schema: declare elements in the model schema from a simple definition, e.g. a JSON file, with three types of
- * elements (`empty`, `block`, `container`), and a validation that rejects contradictory definitions.
+ * elements (`empty`, `block`, `container`), and a validation that rejects contradictory definitions. `ElementSchemaCommands`
+ * makes commands and buttons for its elements.
  *
  * @module ckeditor5-elements-schema
  */
 // Plugins.
 export { default as ElementSchema } from './elementSchema.js';
+export { default as ElementSchemaCommands } from './elementSchemaCommands.js';
+// Commands.
+export { default as ElementSchemaCommand } from './commands/elementSchemaCommand.js';
+export { default as ElementInlineCommand } from './commands/elementInlineCommand.js';
+export { default as ElementBlockCommand } from './commands/elementBlockCommand.js';
+export { default as ElementContainerCommand } from './commands/elementContainerCommand.js';
+export { default as ElementInsertCommand } from './commands/elementInsertCommand.js';
+// Utils.
+export { withoutBlockFiller } from './conversion/inlineTextElement.js';
 // Validation and compiling, which do not need an editor (also in `validate.ts`, for Node.js).
 export * from './validate.js';
 import './augmentation.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,WAAW;AACX,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAE9D,8FAA8F;AAC9F,cAAc,eAAe,CAAC;AAE9B,OAAO,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,WAAW;AACX,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EACN,OAAO,IAAI,qBAAqB,EAGhC,MAAM,4BAA4B,CAAC;AAEpC,YAAY;AACZ,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AACrF,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AACrF,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACnF,OAAO,EAAE,OAAO,IAAI,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAC3F,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAErF,SAAS;AACT,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAEvE,8FAA8F;AAC9F,cAAc,eAAe,CAAC;AAE9B,OAAO,mBAAmB,CAAC"}

package/dist/typing/twoStepCaretMovement.d.ts

@@ -0,0 +1,11 @@
+import { type Plugin } from 'ckeditor5';
+/**
+ * Makes the left and right arrow keys move in two steps at the ends of inline elements, as CKEditor's two-step caret
+ * movement does at the ends of a bold: the first step goes into the element (or out of it), where the cursor looks the
+ * same, the next one moves in the text. `a[]<b>bc</b>` is `a<b>[]bc</b>`, then `a<b>b[]c</b>`. The browser would move by
+ * a character at once, and the positions on both sides of the end of an element would be out of reach.
+ *
+ * What is typed then goes where the cursor is. The listeners are the plugin's.
+ */
+export declare function enableTwoStepCaretMovement(plugin: Plugin, names: ReadonlySet<string>): void;
+//# sourceMappingURL=twoStepCaretMovement.d.ts.map

package/dist/typing/twoStepCaretMovement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"twoStepCaretMovement.d.ts","sourceRoot":"","sources":["../../src/typing/twoStepCaretMovement.ts"],"names":[],"mappings":"AAAA,OAAO,EAON,KAAK,MAAM,EAGX,MAAM,WAAW,CAAC;AAEnB;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CA8C3F"}

package/dist/typing/twoStepCaretMovement.js

@@ -0,0 +1,76 @@
+import { isForwardArrowKeyCode, keyCodes } from 'ckeditor5';
+/**
+ * Makes the left and right arrow keys move in two steps at the ends of inline elements, as CKEditor's two-step caret
+ * movement does at the ends of a bold: the first step goes into the element (or out of it), where the cursor looks the
+ * same, the next one moves in the text. `a[]<b>bc</b>` is `a<b>[]bc</b>`, then `a<b>b[]c</b>`. The browser would move by
+ * a character at once, and the positions on both sides of the end of an element would be out of reach.
+ *
+ * What is typed then goes where the cursor is. The listeners are the plugin's.
+ */
+export function enableTwoStepCaretMovement(plugin, names) {
+    const editor = plugin.editor;
+    const viewDocument = editor.editing.view.document;
+    const isElement = (node) => !!node?.is('element') && names.has(node.name);
+    // Before the other features: e.g. `ElementSelectable` selects an inline object that the cursor reaches, and it may
+    // be just after the end of an element.
+    plugin.listenTo(viewDocument, 'keydown', (evt, data) => {
+        const isPlain = !data.shiftKey && !data.ctrlKey && !data.altKey && !data.metaKey;
+        const isHorizontal = data.keyCode === keyCodes.arrowleft || data.keyCode === keyCodes.arrowright;
+        const isForward = isForwardArrowKeyCode(data.keyCode, editor.locale.contentLanguageDirection);
+        const position = isPlain && isHorizontal ? getStep(editor, isForward, isElement) : null;
+        if (position) {
+            editor.model.change(writer => {
+                writer.setSelection(position);
+            });
+            data.preventDefault();
+            evt.stop();
+        }
+    }, { priority: 'highest' });
+    // The browser types at a place of its own at an end of an element, e.g. at the end of the text before it, whichever
+    // side of the end the cursor is on. When that place differs from the cursor only by ends of elements, the text goes
+    // where the cursor is: at the view selection, which is the model one. The browser must not type it at its place, as
+    // CKEditor does for a fake selection; a composition is left to the browser.
+    plugin.listenTo(viewDocument, 'insertText', (evt, data) => {
+        const target = data.selection?.rangeCount === 1 ? data.selection.getFirstRange() : null;
+        const position = target?.isCollapsed ? editor.editing.mapper.toModelPosition(target.start) : null;
+        if (position && !data.isComposing && isAtCursor(editor, position, isElement)) {
+            data.selection = viewDocument.selection;
+            data.preventDefault();
+        }
+    }, { priority: 'high' });
+}
+/**
+ * Returns where the cursor goes with one step in the direction, when it is at an end of an element: into the element
+ * next to it, or out of the element it is in. `null` elsewhere, or for a selection that is not collapsed.
+ */
+function getStep(editor, isForward, isElement) {
+    const model = editor.model;
+    const selection = model.document.selection;
+    const position = selection.getFirstPosition();
+    if (!selection.isCollapsed || !position) {
+        return null;
+    }
+    const next = isForward ? position.nodeAfter : position.nodeBefore;
+    if (isElement(next)) {
+        return model.createPositionAt(next, isForward ? 0 : 'end');
+    }
+    if ((isForward ? position.isAtEnd : position.isAtStart) && isElement(position.parent)) {
+        return isForward ? model.createPositionAfter(position.parent) : model.createPositionBefore(position.parent);
+    }
+    return null;
+}
+/**
+ * Whether a position differs from the cursor only by ends of elements: `a[]<b>c</b>` and `a<b>[]c</b>` look the same.
+ */
+function isAtCursor(editor, position, isElement) {
+    const model = editor.model;
+    const selection = model.document.selection;
+    const cursor = selection.getFirstPosition();
+    // Where the cursor is exactly, the browser types as usual.
+    if (!selection.isCollapsed || !cursor || cursor.isEqual(position)) {
+        return false;
+    }
+    const range = cursor.isBefore(position) ? model.createRange(cursor, position) : model.createRange(position, cursor);
+    return Array.from(range.getWalker()).every(({ item }) => item.is('element') && isElement(item));
+}
+//# sourceMappingURL=twoStepCaretMovement.js.map

package/dist/typing/twoStepCaretMovement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"twoStepCaretMovement.js","sourceRoot":"","sources":["../../src/typing/twoStepCaretMovement.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,qBAAqB,EACrB,QAAQ,EAQR,MAAM,WAAW,CAAC;AAEnB;;;;;;;GAOG;AACH,MAAM,UAAU,0BAA0B,CAAC,MAAc,EAAE,KAA0B;IACpF,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7B,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;IAClD,MAAM,SAAS,GAAG,CAAC,IAA8C,EAAqB,EAAE,CACvF,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE/C,mHAAmH;IACnH,uCAAuC;IACvC,MAAM,CAAC,QAAQ,CACd,YAAY,EACZ,SAAS,EACT,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACb,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;QACjF,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,KAAK,QAAQ,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,QAAQ,CAAC,UAAU,CAAC;QACjG,MAAM,SAAS,GAAG,qBAAqB,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;QAC9F,MAAM,QAAQ,GAAG,OAAO,IAAI,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAExF,IAAI,QAAQ,EAAE,CAAC;YACd,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;gBAC5B,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,GAAG,CAAC,IAAI,EAAE,CAAC;QACZ,CAAC;IACF,CAAC,EACD,EAAE,QAAQ,EAAE,SAAS,EAAE,CACvB,CAAC;IAEF,oHAAoH;IACpH,oHAAoH;IACpH,oHAAoH;IACpH,4EAA4E;IAC5E,MAAM,CAAC,QAAQ,CACd,YAAY,EACZ,YAAY,EACZ,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;QACb,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QACxF,MAAM,QAAQ,GAAG,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAElG,IAAI,QAAQ,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,CAAC;YAC9E,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC;YACxC,IAAI,CAAC,cAAc,EAAE,CAAC;QACvB,CAAC;IACF,CAAC,EACD,EAAE,QAAQ,EAAE,MAAM,EAAE,CACpB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,OAAO,CACf,MAAc,EACd,SAAkB,EAClB,SAAgF;IAEhF,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAC3B,MAAM,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;IAC3C,MAAM,QAAQ,GAAG,SAAS,CAAC,gBAAgB,EAAE,CAAC;IAE9C,IAAI,CAAC,SAAS,CAAC,WAAW,IAAI,CAAC,QAAQ,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;IAElE,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC,gBAAgB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACvF,OAAO,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7G,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;GAEG;AACH,SAAS,UAAU,CAClB,MAAc,EACd,QAAuB,EACvB,SAAsE;IAEtE,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAC3B,MAAM,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;IAC3C,MAAM,MAAM,GAAG,SAAS,CAAC,gBAAgB,EAAE,CAAC;IAE5C,2DAA2D;IAC3D,IAAI,CAAC,SAAS,CAAC,WAAW,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnE,OAAO,KAAK,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAEpH,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;AACjG,CAAC"}

package/dist/validate.d.ts

@@ -5,8 +5,8 @@
  *
  * @module ckeditor5-elements-schema/validate
  */
-export { validateElementSchema } from './validateElementSchema.js';
-export { compileElementSchema, type CompiledElementSchema } from './compileElementSchema.js';
-export { default as ElementSchemaError } from './elementSchemaError.js';
-export type { ElementSchemaDefinition, ElementSchemaElement, ElementSchemaInput, ElementSchemaIssue, ElementSchemaKind, ElementSchemaType, ValidateElementSchemaOptions } from './types.js';
+export { validateElementSchema } from './definition/validateElementSchema.js';
+export { compileElementSchema, type CompiledElementSchema } from './definition/compileElementSchema.js';
+export { default as ElementSchemaError } from './definition/elementSchemaError.js';
+export type { ElementSchemaDefinition, ElementSchemaElement, ElementSchemaInput, ElementSchemaIssue, ElementSchemaKind, ElementSchemaType, ValidateElementSchemaOptions } from './definition/types.js';
 //# sourceMappingURL=validate.d.ts.map

package/dist/validate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,KAAK,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAC7F,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AACxE,YAAY,EACX,uBAAuB,EACvB,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,4BAA4B,EAC5B,MAAM,YAAY,CAAC"}
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAAE,KAAK,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AACxG,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACnF,YAAY,EACX,uBAAuB,EACvB,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,4BAA4B,EAC5B,MAAM,uBAAuB,CAAC"}

package/dist/validate.js

@@ -5,7 +5,7 @@
  *
  * @module ckeditor5-elements-schema/validate
  */
-export { validateElementSchema } from './validateElementSchema.js';
-export { compileElementSchema } from './compileElementSchema.js';
-export { default as ElementSchemaError } from './elementSchemaError.js';
+export { validateElementSchema } from './definition/validateElementSchema.js';
+export { compileElementSchema } from './definition/compileElementSchema.js';
+export { default as ElementSchemaError } from './definition/elementSchemaError.js';
 //# sourceMappingURL=validate.js.map

package/dist/validate.js.map

@@ -1 +1 @@
-{"version":3,"file":"validate.js","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAA8B,MAAM,2BAA2B,CAAC;AAC7F,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,oBAAoB,EAA8B,MAAM,sCAAsC,CAAC;AACxG,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,oCAAoC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ckeditor5-elements-schema",
-  "version": "49.0.0-alpha.2",
+  "version": "49.0.0-alpha.4",
   "description": "Element schema for CKEditor 5: declare elements in the model schema from a simple definition, e.g. a JSON file, with three types of elements and a validation.",
   "keywords": [
     "ckeditor",
@@ -41,7 +41,7 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "ckeditor5-elements-core": "49.0.0-alpha.2"
+    "ckeditor5-elements-core": "49.0.0-alpha.4"
   },
   "peerDependencies": {
     "ckeditor5": "^49.0.0"

package/src/augmentation.ts

@@ -1,8 +1,9 @@
-import type { ElementSchema, ElementSchemaInput } from './index.js';
+import type { ElementSchema, ElementSchemaCommands, ElementSchemaCommandsConfig, ElementSchemaInput } from './index.js';
 
 declare module 'ckeditor5' {
 	interface PluginsMap {
 		[ElementSchema.pluginName]: ElementSchema;
+		[ElementSchemaCommands.pluginName]: ElementSchemaCommands;
 	}
 
 	interface EditorConfig {
@@ -17,5 +18,11 @@ declare module 'ckeditor5' {
 		 * element sets another tag for the editing view. See {@link ElementSchema}. Default: `false`.
 		 */
 		elementSchemaConverters?: boolean;
+
+		/**
+		 * The commands and the buttons of elements of the schema, as CKEditor's bold, heading, block quote or horizontal
+		 * line, by the name of the command. See {@link ElementSchemaCommands}.
+		 */
+		elementSchemaCommands?: ElementSchemaCommandsConfig;
 	}
 }

package/src/commands/elementBlockCommand.ts

@@ -0,0 +1,87 @@
+import type { ModelElement } from 'ckeditor5';
+import type { ElementOrPosition } from 'ckeditor5-elements-core';
+import ElementSchemaCommand from './elementSchemaCommand.js';
+
+/**
+ * Turns blocks into the element, as CKEditor's heading command does, e.g. a `title` that is a `block` of the element
+ * schema: the selected blocks, or the block of the target, are renamed, and keep their content.
+ *
+ * ```ts
+ * editor.execute('title'); // The blocks of the selection.
+ * editor.commands.get('title').executeFor(paragraph);
+ * ```
+ *
+ * When all the blocks are the element already, it turns them back into paragraphs (the {@link defaultElement}). The
+ * blocks that cannot be renamed, e.g. where the element is not allowed, are left as they are.
+ *
+ * It is "on" when all the blocks are the element.
+ */
+export default class ElementBlockCommand extends ElementSchemaCommand {
+	public override isToggleable = true;
+
+	/**
+	 * The element the blocks are turned back into.
+	 */
+	public defaultElement = 'paragraph';
+
+	/**
+	 * Renames the blocks of the target: to the element, or back to the {@link defaultElement} when they are all the
+	 * element.
+	 */
+	public override execute(elementOrPosition?: ElementOrPosition): void {
+		const name = this._getNewName(elementOrPosition);
+		const schema = this.editor.model.schema;
+
+		this.editor.model.change(writer => {
+			for (const block of this._getBlocks(elementOrPosition)) {
+				if (this._canRename(block, name)) {
+					writer.rename(block, name);
+					schema.removeDisallowedAttributes([block], writer);
+				}
+			}
+		});
+	}
+
+	/**
+	 * Enabled when the target can be edited, and one of its blocks can be renamed.
+	 */
+	protected override _isEnabledFor(elementOrPosition?: ElementOrPosition): boolean {
+		const name = this._getNewName(elementOrPosition);
+
+		return (
+			super._isEnabledFor(elementOrPosition) &&
+			this._getBlocks(elementOrPosition).some(block => this._canRename(block, name))
+		);
+	}
+
+	/**
+	 * "On" when all the blocks of the target are the element.
+	 */
+	protected override _isOnFor(elementOrPosition?: ElementOrPosition): boolean {
+		const blocks = this._getBlocks(elementOrPosition);
+
+		return blocks.length > 0 && blocks.every(block => this.isElement(block));
+	}
+
+	/**
+	 * Returns the name the blocks get: the element, or the {@link defaultElement} when they are the element already.
+	 */
+	private _getNewName(elementOrPosition?: ElementOrPosition): string {
+		return this._isOnFor(elementOrPosition) ? this.defaultElement : this.elementName;
+	}
+
+	/**
+	 * Whether a block can be renamed: it is not an object, nor the name already, and the schema allows it with its
+	 * content.
+	 */
+	private _canRename(block: ModelElement, name: string): boolean {
+		const schema = this.editor.model.schema;
+
+		return (
+			block.name !== name &&
+			!schema.isObject(block) &&
+			schema.isRegistered(name) &&
+			this._canHold(this.editor.model.createPositionBefore(block), block.getChildren(), name)
+		);
+	}
+}

package/src/commands/elementContainerCommand.ts

@@ -0,0 +1,83 @@
+import type { ModelElement, ModelRange } from 'ckeditor5';
+import type { ElementOrPosition } from 'ckeditor5-elements-core';
+import ElementSchemaCommand from './elementSchemaCommand.js';
+
+/**
+ * Wraps blocks with the element, as CKEditor's block quote command does, e.g. a `callout` that is a `container` of the
+ * element schema: the selected blocks, or the block-level element of the target, go in a new element.
+ *
+ * ```ts
+ * editor.execute('callout'); // The blocks of the selection.
+ * editor.commands.get('callout').executeFor(paragraph);
+ * ```
+ *
+ * In the element, it unwraps it: the whole element, not only the selected blocks.
+ *
+ * It is "on" when the target is in the element.
+ */
+export default class ElementContainerCommand extends ElementSchemaCommand {
+	public override isToggleable = true;
+
+	/**
+	 * Unwraps the element the target is in, or wraps the blocks of the target with a new one.
+	 */
+	public override execute(elementOrPosition?: ElementOrPosition): void {
+		const element = this._findElement(elementOrPosition);
+		const range = element ? null : this._getWrapRange(elementOrPosition);
+
+		this.editor.model.change(writer => {
+			if (element) {
+				writer.unwrap(element);
+			} else if (range) {
+				writer.wrap(range, this.elementName);
+			}
+		});
+	}
+
+	/**
+	 * Enabled when the target can be edited, and the element it is in can be unwrapped, or its blocks can be wrapped.
+	 */
+	protected override _isEnabledFor(elementOrPosition?: ElementOrPosition): boolean {
+		const element = this._findElement(elementOrPosition);
+
+		return (
+			super._isEnabledFor(elementOrPosition) &&
+			(element ? this._canUnwrap(element) : !!this._getWrapRange(elementOrPosition))
+		);
+	}
+
+	/**
+	 * "On" when the target is in the element.
+	 */
+	protected override _isOnFor(elementOrPosition?: ElementOrPosition): boolean {
+		return !!this._findElement(elementOrPosition);
+	}
+
+	/**
+	 * Returns the range to wrap: from the first block of the target to the last, as siblings: the blocks themselves, or
+	 * their ancestors in the parent they share. `null` when the schema does not allow the element there.
+	 */
+	private _getWrapRange(elementOrPosition?: ElementOrPosition): ModelRange | null {
+		const model = this.editor.model;
+		const blocks = this._getBlocks(elementOrPosition);
+		const first = blocks[0] as ModelElement | undefined;
+		const last = blocks.at(-1);
+
+		if (!first || !last) {
+			return null;
+		}
+
+		const parent = first === last ? first.parent : first.getCommonAncestor(last);
+		const [start, end] = [first, last].map(block =>
+			block.getAncestors({ includeSelf: true }).find((node): node is ModelElement => node.parent === parent)
+		);
+
+		if (!start || !end) {
+			return null;
+		}
+
+		const range = model.createRange(model.createPositionBefore(start), model.createPositionAfter(end));
+
+		return this._canHold(range.start, range.getItems({ shallow: true })) ? range : null;
+	}
+}