@ckeditor/ckeditor5-basic-styles 0.0.0-internal-20241017.0

package/src/italic.js

@@ -0,0 +1,39 @@
+/**
+ * @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 basic-styles/italic
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import ItalicEditing from './italic/italicediting.js';
+import ItalicUI from './italic/italicui.js';
+/**
+ * The italic feature.
+ *
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/italic/italicediting~ItalicEditing} and
+ * {@link module:basic-styles/italic/italicui~ItalicUI} plugins.
+ */
+export default class Italic extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ItalicEditing, ItalicUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Italic';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+}

package/src/strikethrough/strikethroughediting.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @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 basic-styles/strikethrough/strikethroughediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The strikethrough editing feature.
+ *
+ * It registers the `'strikethrough'` command, the <kbd>Ctrl+Shift+X</kbd> keystroke and introduces the
+ * `strikethroughsthrough` attribute in the model which renders to the view
+ * as a `<s>` element.
+ */
+export default class StrikethroughEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "StrikethroughEditing";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/strikethrough/strikethroughediting.js

@@ -0,0 +1,70 @@
+/**
+ * @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 basic-styles/strikethrough/strikethroughediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import AttributeCommand from '../attributecommand.js';
+const STRIKETHROUGH = 'strikethrough';
+/**
+ * The strikethrough editing feature.
+ *
+ * It registers the `'strikethrough'` command, the <kbd>Ctrl+Shift+X</kbd> keystroke and introduces the
+ * `strikethroughsthrough` attribute in the model which renders to the view
+ * as a `<s>` element.
+ */
+export default class StrikethroughEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'StrikethroughEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = this.editor.t;
+        // Allow strikethrough attribute on text nodes.
+        editor.model.schema.extend('$text', { allowAttributes: STRIKETHROUGH });
+        editor.model.schema.setAttributeProperties(STRIKETHROUGH, {
+            isFormatting: true,
+            copyOnEnter: true
+        });
+        editor.conversion.attributeToElement({
+            model: STRIKETHROUGH,
+            view: 's',
+            upcastAlso: [
+                'del',
+                'strike',
+                {
+                    styles: {
+                        'text-decoration': 'line-through'
+                    }
+                }
+            ]
+        });
+        // Create strikethrough command.
+        editor.commands.add(STRIKETHROUGH, new AttributeCommand(editor, STRIKETHROUGH));
+        // Set the Ctrl+Shift+X keystroke.
+        editor.keystrokes.set('CTRL+SHIFT+X', 'strikethrough');
+        // Add the information about the keystroke to the accessibility database.
+        editor.accessibility.addKeystrokeInfos({
+            keystrokes: [
+                {
+                    label: t('Strikethrough text'),
+                    keystroke: 'CTRL+SHIFT+X'
+                }
+            ]
+        });
+    }
+}

package/src/strikethrough/strikethroughui.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @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 basic-styles/strikethrough/strikethroughui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The strikethrough UI feature. It introduces the Strikethrough button.
+ */
+export default class StrikethroughUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "StrikethroughUI";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/strikethrough/strikethroughui.js

@@ -0,0 +1,47 @@
+/**
+ * @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 basic-styles/strikethrough/strikethroughui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { ButtonView, MenuBarMenuListItemButtonView } from 'ckeditor5/src/ui.js';
+import { getButtonCreator } from '../utils.js';
+import strikethroughIcon from '../../theme/icons/strikethrough.svg';
+const STRIKETHROUGH = 'strikethrough';
+/**
+ * The strikethrough UI feature. It introduces the Strikethrough button.
+ */
+export default class StrikethroughUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'StrikethroughUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.locale.t;
+        const createButton = getButtonCreator({
+            editor,
+            commandName: STRIKETHROUGH,
+            plugin: this,
+            icon: strikethroughIcon,
+            keystroke: 'CTRL+SHIFT+X',
+            label: t('Strikethrough')
+        });
+        // Add strikethrough button to feature components.
+        editor.ui.componentFactory.add(STRIKETHROUGH, () => createButton(ButtonView));
+        editor.ui.componentFactory.add('menuBar:' + STRIKETHROUGH, () => createButton(MenuBarMenuListItemButtonView));
+    }
+}

package/src/strikethrough.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @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 basic-styles/strikethrough
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import StrikethroughEditing from './strikethrough/strikethroughediting.js';
+import StrikethroughUI from './strikethrough/strikethroughui.js';
+/**
+ * The strikethrough feature.
+ *
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/strikethrough/strikethroughediting~StrikethroughEditing} and
+ * {@link module:basic-styles/strikethrough/strikethroughui~StrikethroughUI} plugins.
+ */
+export default class Strikethrough extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof StrikethroughEditing, typeof StrikethroughUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Strikethrough";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+}

package/src/strikethrough.js

@@ -0,0 +1,39 @@
+/**
+ * @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 basic-styles/strikethrough
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import StrikethroughEditing from './strikethrough/strikethroughediting.js';
+import StrikethroughUI from './strikethrough/strikethroughui.js';
+/**
+ * The strikethrough feature.
+ *
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
+ * and the {@glink api/basic-styles package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:basic-styles/strikethrough/strikethroughediting~StrikethroughEditing} and
+ * {@link module:basic-styles/strikethrough/strikethroughui~StrikethroughUI} plugins.
+ */
+export default class Strikethrough extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [StrikethroughEditing, StrikethroughUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Strikethrough';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+}

package/src/subscript/subscriptediting.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @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 basic-styles/subscript/subscriptediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The subscript editing feature.
+ *
+ * It registers the `sub` command and introduces the `sub` attribute in the model which renders to the view
+ * as a `<sub>` element.
+ */
+export default class SubscriptEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "SubscriptEditing";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/subscript/subscriptediting.js

@@ -0,0 +1,56 @@
+/**
+ * @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 basic-styles/subscript/subscriptediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import AttributeCommand from '../attributecommand.js';
+const SUBSCRIPT = 'subscript';
+/**
+ * The subscript editing feature.
+ *
+ * It registers the `sub` command and introduces the `sub` attribute in the model which renders to the view
+ * as a `<sub>` element.
+ */
+export default class SubscriptEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'SubscriptEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        // Allow sub attribute on text nodes.
+        editor.model.schema.extend('$text', { allowAttributes: SUBSCRIPT });
+        editor.model.schema.setAttributeProperties(SUBSCRIPT, {
+            isFormatting: true,
+            copyOnEnter: true
+        });
+        // Build converter from model to view for data and editing pipelines.
+        editor.conversion.attributeToElement({
+            model: SUBSCRIPT,
+            view: 'sub',
+            upcastAlso: [
+                {
+                    styles: {
+                        'vertical-align': 'sub'
+                    }
+                }
+            ]
+        });
+        // Create sub command.
+        editor.commands.add(SUBSCRIPT, new AttributeCommand(editor, SUBSCRIPT));
+    }
+}

package/src/subscript/subscriptui.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @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 basic-styles/subscript/subscriptui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The subscript UI feature. It introduces the Subscript button.
+ */
+export default class SubscriptUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "SubscriptUI";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/subscript/subscriptui.js

@@ -0,0 +1,46 @@
+/**
+ * @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 basic-styles/subscript/subscriptui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { ButtonView, MenuBarMenuListItemButtonView } from 'ckeditor5/src/ui.js';
+import { getButtonCreator } from '../utils.js';
+import subscriptIcon from '../../theme/icons/subscript.svg';
+const SUBSCRIPT = 'subscript';
+/**
+ * The subscript UI feature. It introduces the Subscript button.
+ */
+export default class SubscriptUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'SubscriptUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.locale.t;
+        const createButton = getButtonCreator({
+            editor,
+            commandName: SUBSCRIPT,
+            plugin: this,
+            icon: subscriptIcon,
+            label: t('Subscript')
+        });
+        // Add subscript button to feature components.
+        editor.ui.componentFactory.add(SUBSCRIPT, () => createButton(ButtonView));
+        editor.ui.componentFactory.add('menuBar:' + SUBSCRIPT, () => createButton(MenuBarMenuListItemButtonView));
+    }
+}

package/src/subscript.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
+ */
+/**
+ * @module basic-styles/subscript
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import SubscriptEditing from './subscript/subscriptediting.js';
+import SubscriptUI from './subscript/subscriptui.js';
+/**
+ * The subscript feature.
+ *
+ * It loads the {@link module:basic-styles/subscript/subscriptediting~SubscriptEditing} and
+ * {@link module:basic-styles/subscript/subscriptui~SubscriptUI} plugins.
+ */
+export default class Subscript extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof SubscriptEditing, typeof SubscriptUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Subscript";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+}

package/src/subscript.js

@@ -0,0 +1,36 @@
+/**
+ * @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 basic-styles/subscript
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import SubscriptEditing from './subscript/subscriptediting.js';
+import SubscriptUI from './subscript/subscriptui.js';
+/**
+ * The subscript feature.
+ *
+ * It loads the {@link module:basic-styles/subscript/subscriptediting~SubscriptEditing} and
+ * {@link module:basic-styles/subscript/subscriptui~SubscriptUI} plugins.
+ */
+export default class Subscript extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [SubscriptEditing, SubscriptUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Subscript';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+}

package/src/superscript/superscriptediting.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @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 basic-styles/superscript/superscriptediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The superscript editing feature.
+ *
+ * It registers the `super` command and introduces the `super` attribute in the model which renders to the view
+ * as a `<super>` element.
+ */
+export default class SuperscriptEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "SuperscriptEditing";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/superscript/superscriptediting.js

@@ -0,0 +1,56 @@
+/**
+ * @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 basic-styles/superscript/superscriptediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import AttributeCommand from '../attributecommand.js';
+const SUPERSCRIPT = 'superscript';
+/**
+ * The superscript editing feature.
+ *
+ * It registers the `super` command and introduces the `super` attribute in the model which renders to the view
+ * as a `<super>` element.
+ */
+export default class SuperscriptEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'SuperscriptEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        // Allow super attribute on text nodes.
+        editor.model.schema.extend('$text', { allowAttributes: SUPERSCRIPT });
+        editor.model.schema.setAttributeProperties(SUPERSCRIPT, {
+            isFormatting: true,
+            copyOnEnter: true
+        });
+        // Build converter from model to view for data and editing pipelines.
+        editor.conversion.attributeToElement({
+            model: SUPERSCRIPT,
+            view: 'sup',
+            upcastAlso: [
+                {
+                    styles: {
+                        'vertical-align': 'super'
+                    }
+                }
+            ]
+        });
+        // Create super command.
+        editor.commands.add(SUPERSCRIPT, new AttributeCommand(editor, SUPERSCRIPT));
+    }
+}

package/src/superscript/superscriptui.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @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 basic-styles/superscript/superscriptui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The superscript UI feature. It introduces the Superscript button.
+ */
+export default class SuperscriptUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "SuperscriptUI";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/superscript/superscriptui.js

@@ -0,0 +1,46 @@
+/**
+ * @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 basic-styles/superscript/superscriptui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { ButtonView, MenuBarMenuListItemButtonView } from 'ckeditor5/src/ui.js';
+import { getButtonCreator } from '../utils.js';
+import superscriptIcon from '../../theme/icons/superscript.svg';
+const SUPERSCRIPT = 'superscript';
+/**
+ * The superscript UI feature. It introduces the Superscript button.
+ */
+export default class SuperscriptUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'SuperscriptUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.locale.t;
+        const createButton = getButtonCreator({
+            editor,
+            commandName: SUPERSCRIPT,
+            plugin: this,
+            icon: superscriptIcon,
+            label: t('Superscript')
+        });
+        // Add superscript button to feature components.
+        editor.ui.componentFactory.add(SUPERSCRIPT, () => createButton(ButtonView));
+        editor.ui.componentFactory.add('menuBar:' + SUPERSCRIPT, () => createButton(MenuBarMenuListItemButtonView));
+    }
+}