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

package/src/bold/boldui.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/bold/boldui
+ */
+import { Plugin, icons } from 'ckeditor5/src/core.js';
+import { ButtonView, MenuBarMenuListItemButtonView } from 'ckeditor5/src/ui.js';
+import { getButtonCreator } from '../utils.js';
+const BOLD = 'bold';
+/**
+ * The bold UI feature. It introduces the Bold button.
+ */
+export default class BoldUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'BoldUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.locale.t;
+        const createButton = getButtonCreator({
+            editor,
+            commandName: BOLD,
+            plugin: this,
+            icon: icons.bold,
+            label: t('Bold'),
+            keystroke: 'CTRL+B'
+        });
+        // Add bold button to feature components.
+        editor.ui.componentFactory.add(BOLD, () => createButton(ButtonView));
+        editor.ui.componentFactory.add('menuBar:' + BOLD, () => createButton(MenuBarMenuListItemButtonView));
+    }
+}

package/src/bold.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/bold
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import BoldEditing from './bold/boldediting.js';
+import BoldUI from './bold/boldui.js';
+/**
+ * The bold 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/bold/boldediting~BoldEditing bold editing feature}
+ * and {@link module:basic-styles/bold/boldui~BoldUI bold UI feature}.
+ */
+export default class Bold extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof BoldEditing, typeof BoldUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Bold";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+}

package/src/bold.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/bold
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import BoldEditing from './bold/boldediting.js';
+import BoldUI from './bold/boldui.js';
+/**
+ * The bold 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/bold/boldediting~BoldEditing bold editing feature}
+ * and {@link module:basic-styles/bold/boldui~BoldUI bold UI feature}.
+ */
+export default class Bold extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [BoldEditing, BoldUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Bold';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+}

package/src/code/codeediting.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/code/codeediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { TwoStepCaretMovement } from 'ckeditor5/src/typing.js';
+/**
+ * The code editing feature.
+ *
+ * It registers the `'code'` command and introduces the `code` attribute in the model which renders to the view
+ * as a `<code>` element.
+ */
+export default class CodeEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "CodeEditing";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TwoStepCaretMovement];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/code/codeediting.js

@@ -0,0 +1,78 @@
+/**
+ * @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/code/codeediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { TwoStepCaretMovement, inlineHighlight } from 'ckeditor5/src/typing.js';
+import AttributeCommand from '../attributecommand.js';
+const CODE = 'code';
+const HIGHLIGHT_CLASS = 'ck-code_selected';
+/**
+ * The code editing feature.
+ *
+ * It registers the `'code'` command and introduces the `code` attribute in the model which renders to the view
+ * as a `<code>` element.
+ */
+export default class CodeEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'CodeEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [TwoStepCaretMovement];
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = this.editor.t;
+        // Allow code attribute on text nodes.
+        editor.model.schema.extend('$text', { allowAttributes: CODE });
+        editor.model.schema.setAttributeProperties(CODE, {
+            isFormatting: true,
+            copyOnEnter: false
+        });
+        editor.conversion.attributeToElement({
+            model: CODE,
+            view: 'code',
+            upcastAlso: {
+                styles: {
+                    'word-wrap': 'break-word'
+                }
+            }
+        });
+        // Create code command.
+        editor.commands.add(CODE, new AttributeCommand(editor, CODE));
+        // Enable two-step caret movement for `code` attribute.
+        editor.plugins.get(TwoStepCaretMovement).registerAttribute(CODE);
+        // Setup highlight over selected element.
+        inlineHighlight(editor, CODE, 'code', HIGHLIGHT_CLASS);
+        // Add the information about the keystroke to the accessibility database.
+        editor.accessibility.addKeystrokeInfos({
+            keystrokes: [
+                {
+                    label: t('Move out of an inline code style'),
+                    keystroke: [
+                        ['arrowleft', 'arrowleft'],
+                        ['arrowright', 'arrowright']
+                    ]
+                }
+            ]
+        });
+    }
+}

package/src/code/codeui.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @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/code/codeui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import '../../theme/code.css';
+/**
+ * The code UI feature. It introduces the Code button.
+ */
+export default class CodeUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "CodeUI";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/code/codeui.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/code/codeui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { ButtonView, MenuBarMenuListItemButtonView } from 'ckeditor5/src/ui.js';
+import { getButtonCreator } from '../utils.js';
+import codeIcon from '../../theme/icons/code.svg';
+import '../../theme/code.css';
+const CODE = 'code';
+/**
+ * The code UI feature. It introduces the Code button.
+ */
+export default class CodeUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'CodeUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.locale.t;
+        const createButton = getButtonCreator({
+            editor,
+            commandName: CODE,
+            plugin: this,
+            icon: codeIcon,
+            label: t('Code')
+        });
+        // Add code button to feature components.
+        editor.ui.componentFactory.add(CODE, () => createButton(ButtonView));
+        editor.ui.componentFactory.add('menuBar:' + CODE, () => createButton(MenuBarMenuListItemButtonView));
+    }
+}

package/src/code.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
+ */
+/**
+ * @module basic-styles/code
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import CodeEditing from './code/codeediting.js';
+import CodeUI from './code/codeui.js';
+import '../theme/code.css';
+/**
+ * The code 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/code/codeediting~CodeEditing code editing feature}
+ * and {@link module:basic-styles/code/codeui~CodeUI code UI feature}.
+ */
+export default class Code extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof CodeEditing, typeof CodeUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Code";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+}

package/src/code.js

@@ -0,0 +1,40 @@
+/**
+ * @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/code
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import CodeEditing from './code/codeediting.js';
+import CodeUI from './code/codeui.js';
+import '../theme/code.css';
+/**
+ * The code 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/code/codeediting~CodeEditing code editing feature}
+ * and {@link module:basic-styles/code/codeui~CodeUI code UI feature}.
+ */
+export default class Code extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [CodeEditing, CodeUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Code';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+}

package/src/index.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
+ */
+export { default as Bold } from './bold.js';
+export { default as BoldEditing } from './bold/boldediting.js';
+export { default as BoldUI } from './bold/boldui.js';
+export { default as Code } from './code.js';
+export { default as CodeEditing } from './code/codeediting.js';
+export { default as CodeUI } from './code/codeui.js';
+export { default as Italic } from './italic.js';
+export { default as ItalicEditing } from './italic/italicediting.js';
+export { default as ItalicUI } from './italic/italicui.js';
+export { default as Strikethrough } from './strikethrough.js';
+export { default as StrikethroughEditing } from './strikethrough/strikethroughediting.js';
+export { default as StrikethroughUI } from './strikethrough/strikethroughui.js';
+export { default as Subscript } from './subscript.js';
+export { default as SubscriptEditing } from './subscript/subscriptediting.js';
+export { default as SubscriptUI } from './subscript/subscriptui.js';
+export { default as Superscript } from './superscript.js';
+export { default as SuperscriptEditing } from './superscript/superscriptediting.js';
+export { default as SuperscriptUI } from './superscript/superscriptui.js';
+export { default as Underline } from './underline.js';
+export { default as UnderlineEditing } from './underline/underlineediting.js';
+export { default as UnderlineUI } from './underline/underlineui.js';
+export { default as AttributeCommand } from './attributecommand.js';
+import './augmentation.js';

package/src/index.js

@@ -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
+ */
+export { default as Bold } from './bold.js';
+export { default as BoldEditing } from './bold/boldediting.js';
+export { default as BoldUI } from './bold/boldui.js';
+export { default as Code } from './code.js';
+export { default as CodeEditing } from './code/codeediting.js';
+export { default as CodeUI } from './code/codeui.js';
+export { default as Italic } from './italic.js';
+export { default as ItalicEditing } from './italic/italicediting.js';
+export { default as ItalicUI } from './italic/italicui.js';
+export { default as Strikethrough } from './strikethrough.js';
+export { default as StrikethroughEditing } from './strikethrough/strikethroughediting.js';
+export { default as StrikethroughUI } from './strikethrough/strikethroughui.js';
+export { default as Subscript } from './subscript.js';
+export { default as SubscriptEditing } from './subscript/subscriptediting.js';
+export { default as SubscriptUI } from './subscript/subscriptui.js';
+export { default as Superscript } from './superscript.js';
+export { default as SuperscriptEditing } from './superscript/superscriptediting.js';
+export { default as SuperscriptUI } from './superscript/superscriptui.js';
+export { default as Underline } from './underline.js';
+export { default as UnderlineEditing } from './underline/underlineediting.js';
+export { default as UnderlineUI } from './underline/underlineui.js';
+export { default as AttributeCommand } from './attributecommand.js';
+import './augmentation.js';

package/src/italic/italicediting.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/italic/italicediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The italic editing feature.
+ *
+ * It registers the `'italic'` command, the <kbd>Ctrl+I</kbd> keystroke and introduces the `italic` attribute in the model
+ * which renders to the view as an `<i>` element.
+ */
+export default class ItalicEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ItalicEditing";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/italic/italicediting.js

@@ -0,0 +1,68 @@
+/**
+ * @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/italicediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import AttributeCommand from '../attributecommand.js';
+const ITALIC = 'italic';
+/**
+ * The italic editing feature.
+ *
+ * It registers the `'italic'` command, the <kbd>Ctrl+I</kbd> keystroke and introduces the `italic` attribute in the model
+ * which renders to the view as an `<i>` element.
+ */
+export default class ItalicEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ItalicEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = this.editor.t;
+        // Allow italic attribute on text nodes.
+        editor.model.schema.extend('$text', { allowAttributes: ITALIC });
+        editor.model.schema.setAttributeProperties(ITALIC, {
+            isFormatting: true,
+            copyOnEnter: true
+        });
+        editor.conversion.attributeToElement({
+            model: ITALIC,
+            view: 'i',
+            upcastAlso: [
+                'em',
+                {
+                    styles: {
+                        'font-style': 'italic'
+                    }
+                }
+            ]
+        });
+        // Create italic command.
+        editor.commands.add(ITALIC, new AttributeCommand(editor, ITALIC));
+        // Set the Ctrl+I keystroke.
+        editor.keystrokes.set('CTRL+I', ITALIC);
+        // Add the information about the keystroke to the accessibility database.
+        editor.accessibility.addKeystrokeInfos({
+            keystrokes: [
+                {
+                    label: t('Italic text'),
+                    keystroke: 'CTRL+I'
+                }
+            ]
+        });
+    }
+}

package/src/italic/italicui.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/italic/italicui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The italic UI feature. It introduces the Italic button.
+ */
+export default class ItalicUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ItalicUI";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/italic/italicui.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/italic/italicui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { MenuBarMenuListItemButtonView, ButtonView } from 'ckeditor5/src/ui.js';
+import { getButtonCreator } from '../utils.js';
+import italicIcon from '../../theme/icons/italic.svg';
+const ITALIC = 'italic';
+/**
+ * The italic UI feature. It introduces the Italic button.
+ */
+export default class ItalicUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ItalicUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.locale.t;
+        const createButton = getButtonCreator({
+            editor,
+            commandName: ITALIC,
+            plugin: this,
+            icon: italicIcon,
+            keystroke: 'CTRL+I',
+            label: t('Italic')
+        });
+        // Add bold button to feature components.
+        editor.ui.componentFactory.add(ITALIC, () => createButton(ButtonView));
+        editor.ui.componentFactory.add('menuBar:' + ITALIC, () => createButton(MenuBarMenuListItemButtonView));
+    }
+}

package/src/italic.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/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(): readonly [typeof ItalicEditing, typeof ItalicUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Italic";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+}