@ckeditor/ckeditor5-basic-styles 30.0.0

package/lang/translations/zh-cn.po

@@ -0,0 +1,45 @@
+# Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Chinese (China) (https://www.transifex.com/ckeditor/teams/11143/zh_CN/)\n"
+"Language: zh_CN\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+
+msgctxt "Toolbar button tooltip for the Bold feature."
+msgid "Bold"
+msgstr "加粗"
+
+msgctxt "Toolbar button tooltip for the Italic feature."
+msgid "Italic"
+msgstr "倾斜"
+
+msgctxt "Toolbar button tooltip for the Underline feature."
+msgid "Underline"
+msgstr "下划线"
+
+msgctxt "Toolbar button tooltip for the Code feature."
+msgid "Code"
+msgstr "代码"
+
+msgctxt "Toolbar button tooltip for the Strikethrough feature."
+msgid "Strikethrough"
+msgstr "删除线"
+
+msgctxt "Toolbar button tooltip for the Subscript feature."
+msgid "Subscript"
+msgstr "下标"
+
+msgctxt "Toolbar button tooltip for the Superscript feature."
+msgid "Superscript"
+msgstr "上标"

package/lang/translations/zh.po

@@ -0,0 +1,45 @@
+# Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Chinese (Taiwan) (https://www.transifex.com/ckeditor/teams/11143/zh_TW/)\n"
+"Language: zh_TW\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+
+msgctxt "Toolbar button tooltip for the Bold feature."
+msgid "Bold"
+msgstr "粗體"
+
+msgctxt "Toolbar button tooltip for the Italic feature."
+msgid "Italic"
+msgstr "斜體"
+
+msgctxt "Toolbar button tooltip for the Underline feature."
+msgid "Underline"
+msgstr "底線"
+
+msgctxt "Toolbar button tooltip for the Code feature."
+msgid "Code"
+msgstr "代碼"
+
+msgctxt "Toolbar button tooltip for the Strikethrough feature."
+msgid "Strikethrough"
+msgstr "刪除線"
+
+msgctxt "Toolbar button tooltip for the Subscript feature."
+msgid "Subscript"
+msgstr "下標"
+
+msgctxt "Toolbar button tooltip for the Superscript feature."
+msgid "Superscript"
+msgstr "上標"

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@ckeditor/ckeditor5-basic-styles",
+  "version": "30.0.0",
+  "description": "Basic styles feature for CKEditor 5.",
+  "keywords": [
+    "ckeditor",
+    "ckeditor5",
+    "ckeditor 5",
+    "ckeditor5-feature",
+    "ckeditor5-plugin",
+    "ckeditor5-dll"
+  ],
+  "main": "src/index.js",
+  "dependencies": {
+    "ckeditor5": "^30.0.0"
+  },
+  "devDependencies": {
+    "@ckeditor/ckeditor5-core": "^30.0.0",
+    "@ckeditor/ckeditor5-dev-utils": "^25.4.0",
+    "@ckeditor/ckeditor5-editor-classic": "^30.0.0",
+    "@ckeditor/ckeditor5-engine": "^30.0.0",
+    "@ckeditor/ckeditor5-essentials": "^30.0.0",
+    "@ckeditor/ckeditor5-paragraph": "^30.0.0",
+    "@ckeditor/ckeditor5-theme-lark": "^30.0.0",
+    "@ckeditor/ckeditor5-ui": "^30.0.0",
+    "@ckeditor/ckeditor5-utils": "^30.0.0",
+    "webpack": "^4.43.0",
+    "webpack-cli": "^3.3.11"
+  },
+  "engines": {
+    "node": ">=12.0.0",
+    "npm": ">=5.7.1"
+  },
+  "author": "CKSource (http://cksource.com/)",
+  "license": "GPL-2.0-or-later",
+  "homepage": "https://ckeditor.com/ckeditor-5",
+  "bugs": "https://github.com/ckeditor/ckeditor5/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ckeditor/ckeditor5.git",
+    "directory": "packages/ckeditor5-basic-styles"
+  },
+  "files": [
+    "lang",
+    "src",
+    "theme",
+    "build",
+    "ckeditor5-metadata.json"
+  ],
+  "scripts": {
+    "dll:build": "webpack"
+  }
+}

package/src/attributecommand.js

@@ -0,0 +1,138 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module basic-styles/attributecommand
+ */
+
+import { Command } from 'ckeditor5/src/core';
+
+/**
+ * An extension of the base {@link module:core/command~Command} class, which provides utilities for a command
+ * that toggles a single attribute on a text or an element.
+ *
+ * `AttributeCommand` uses {@link module:engine/model/document~Document#selection}
+ * to decide which nodes (if any) should be changed, and applies or removes the attribute from them.
+ *
+ * The command checks the {@link module:engine/model/model~Model#schema} to decide if it can be enabled
+ * for the current selection and to which nodes the attribute can be applied.
+ *
+ * @extends module:core/command~Command
+ */
+export default class AttributeCommand extends Command {
+	/**
+	 * @param {module:core/editor/editor~Editor} editor
+	 * @param {String} attributeKey Attribute that will be set by the command.
+	 */
+	constructor( editor, attributeKey ) {
+		super( editor );
+
+		/**
+		 * The attribute that will be set by the command.
+		 *
+		 * @readonly
+		 * @member {String}
+		 */
+		this.attributeKey = attributeKey;
+
+		/**
+		 * Flag indicating whether the command is active. The command is active when the
+		 * {@link module:engine/model/selection~Selection#hasAttribute selection has the attribute} which means that:
+		 *
+		 * * If the selection is not empty – That the attribute is set on the first node in the selection that allows this attribute.
+		 * * If the selection is empty – That the selection has the attribute itself (which means that newly typed
+		 * text will have this attribute, too).
+		 *
+		 * @observable
+		 * @readonly
+		 * @member {Boolean} #value
+		 */
+	}
+
+	/**
+	 * Updates the command's {@link #value} and {@link #isEnabled} based on the current selection.
+	 */
+	refresh() {
+		const model = this.editor.model;
+		const doc = model.document;
+
+		this.value = this._getValueFromFirstAllowedNode();
+		this.isEnabled = model.schema.checkAttributeInSelection( doc.selection, this.attributeKey );
+	}
+
+	/**
+	 * Executes the command — applies the attribute to the selection or removes it from the selection.
+	 *
+	 * If the command is active (`value == true`), it will remove attributes. Otherwise, it will set attributes.
+	 *
+	 * The execution result differs, depending on the {@link module:engine/model/document~Document#selection}:
+	 *
+	 * * If the selection is on a range, the command applies the attribute to all nodes in that range
+	 * (if they are allowed to have this attribute by the {@link module:engine/model/schema~Schema schema}).
+	 * * If the selection is collapsed in a non-empty node, the command applies the attribute to the
+	 * {@link module:engine/model/document~Document#selection} itself (note that typed characters copy attributes from the selection).
+	 * * If the selection is collapsed in an empty node, the command applies the attribute to the parent node of the selection (note
+	 * that the selection inherits all attributes from a node if it is in an empty node).
+	 *
+	 * @fires execute
+	 * @param {Object} [options] Command options.
+	 * @param {Boolean} [options.forceValue] If set, it will force the command behavior. If `true`, the command will apply the attribute,
+	 * otherwise the command will remove the attribute.
+	 * If not set, the command will look for its current value to decide what it should do.
+	 */
+	execute( options = {} ) {
+		const model = this.editor.model;
+		const doc = model.document;
+		const selection = doc.selection;
+		const value = ( options.forceValue === undefined ) ? !this.value : options.forceValue;
+
+		model.change( writer => {
+			if ( selection.isCollapsed ) {
+				if ( value ) {
+					writer.setSelectionAttribute( this.attributeKey, true );
+				} else {
+					writer.removeSelectionAttribute( this.attributeKey );
+				}
+			} else {
+				const ranges = model.schema.getValidRanges( selection.getRanges(), this.attributeKey );
+
+				for ( const range of ranges ) {
+					if ( value ) {
+						writer.setAttribute( this.attributeKey, value, range );
+					} else {
+						writer.removeAttribute( this.attributeKey, range );
+					}
+				}
+			}
+		} );
+	}
+
+	/**
+	 * Checks the attribute value of the first node in the selection that allows the attribute.
+	 * For the collapsed selection returns the selection attribute.
+	 *
+	 * @private
+	 * @returns {Boolean} The attribute value.
+	 */
+	_getValueFromFirstAllowedNode() {
+		const model = this.editor.model;
+		const schema = model.schema;
+		const selection = model.document.selection;
+
+		if ( selection.isCollapsed ) {
+			return selection.hasAttribute( this.attributeKey );
+		}
+
+		for ( const range of selection.getRanges() ) {
+			for ( const item of range.getItems() ) {
+				if ( schema.checkAttribute( item, this.attributeKey ) ) {
+					return item.hasAttribute( this.attributeKey );
+				}
+			}
+		}
+
+		return false;
+	}
+}

package/src/bold/boldediting.js

@@ -0,0 +1,73 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module basic-styles/bold/boldediting
+ */
+
+import { Plugin } from 'ckeditor5/src/core';
+import AttributeCommand from '../attributecommand';
+
+const BOLD = 'bold';
+
+/**
+ * The bold editing feature.
+ *
+ * It registers the `'bold'` command and introduces the `bold` attribute in the model which renders to the view
+ * as a `<strong>` element.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class BoldEditing extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	static get pluginName() {
+		return 'BoldEditing';
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	init() {
+		const editor = this.editor;
+		// Allow bold attribute on text nodes.
+		editor.model.schema.extend( '$text', { allowAttributes: BOLD } );
+		editor.model.schema.setAttributeProperties( BOLD, {
+			isFormatting: true,
+			copyOnEnter: true
+		} );
+
+		// Build converter from model to view for data and editing pipelines.
+		editor.conversion.attributeToElement( {
+			model: BOLD,
+			view: 'strong',
+			upcastAlso: [
+				'b',
+				viewElement => {
+					const fontWeight = viewElement.getStyle( 'font-weight' );
+
+					if ( !fontWeight ) {
+						return null;
+					}
+
+					// Value of the `font-weight` attribute can be defined as a string or a number.
+					if ( fontWeight == 'bold' || Number( fontWeight ) >= 600 ) {
+						return {
+							name: true,
+							styles: [ 'font-weight' ]
+						};
+					}
+				}
+			]
+		} );
+
+		// Create bold command.
+		editor.commands.add( BOLD, new AttributeCommand( editor, BOLD ) );
+
+		// Set the Ctrl+B keystroke.
+		editor.keystrokes.set( 'CTRL+B', BOLD );
+	}
+}

package/src/bold/boldui.js

@@ -0,0 +1,61 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module basic-styles/bold/boldui
+ */
+
+import { Plugin } from 'ckeditor5/src/core';
+import { ButtonView } from 'ckeditor5/src/ui';
+
+import boldIcon from '../../theme/icons/bold.svg';
+
+const BOLD = 'bold';
+
+/**
+ * The bold UI feature. It introduces the Bold button.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class BoldUI extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	static get pluginName() {
+		return 'BoldUI';
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	init() {
+		const editor = this.editor;
+		const t = editor.t;
+
+		// Add bold button to feature components.
+		editor.ui.componentFactory.add( BOLD, locale => {
+			const command = editor.commands.get( BOLD );
+			const view = new ButtonView( locale );
+
+			view.set( {
+				label: t( 'Bold' ),
+				icon: boldIcon,
+				keystroke: 'CTRL+B',
+				tooltip: true,
+				isToggleable: true
+			} );
+
+			view.bind( 'isOn', 'isEnabled' ).to( command, 'value', 'isEnabled' );
+
+			// Execute command.
+			this.listenTo( view, 'execute', () => {
+				editor.execute( BOLD );
+				editor.editing.view.focus();
+			} );
+
+			return view;
+		} );
+	}
+}

package/src/bold.js

@@ -0,0 +1,39 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. 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';
+import BoldEditing from './bold/boldediting';
+import BoldUI from './bold/boldui';
+
+/**
+ * The bold feature.
+ *
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature documentation}
+ * 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}.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class Bold extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	static get requires() {
+		return [ BoldEditing, BoldUI ];
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	static get pluginName() {
+		return 'Bold';
+	}
+}

package/src/code/codeediting.js

@@ -0,0 +1,73 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. 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';
+import { TwoStepCaretMovement, inlineHighlight } from 'ckeditor5/src/typing';
+
+import AttributeCommand from '../attributecommand';
+
+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.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class CodeEditing extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	static get pluginName() {
+		return 'CodeEditing';
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	static get requires() {
+		return [ TwoStepCaretMovement ];
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	init() {
+		const editor = this.editor;
+
+		// 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 );
+	}
+}

package/src/code/codeui.js

@@ -0,0 +1,62 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. 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';
+import { ButtonView } from 'ckeditor5/src/ui';
+
+import codeIcon from '../../theme/icons/code.svg';
+
+import '../../theme/code.css';
+
+const CODE = 'code';
+
+/**
+ * The code UI feature. It introduces the Code button.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class CodeUI extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	static get pluginName() {
+		return 'CodeUI';
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	init() {
+		const editor = this.editor;
+		const t = editor.t;
+
+		// Add code button to feature components.
+		editor.ui.componentFactory.add( CODE, locale => {
+			const command = editor.commands.get( CODE );
+			const view = new ButtonView( locale );
+
+			view.set( {
+				label: t( 'Code' ),
+				icon: codeIcon,
+				tooltip: true,
+				isToggleable: true
+			} );
+
+			view.bind( 'isOn', 'isEnabled' ).to( command, 'value', 'isEnabled' );
+
+			// Execute command.
+			this.listenTo( view, 'execute', () => {
+				editor.execute( CODE );
+				editor.editing.view.focus();
+			} );
+
+			return view;
+		} );
+	}
+}

package/src/code.js

@@ -0,0 +1,41 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. 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';
+import CodeEditing from './code/codeediting';
+import CodeUI from './code/codeui';
+
+import '../theme/code.css';
+
+/**
+ * The code feature.
+ *
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature documentation}
+ * 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}.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class Code extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
+	static get requires() {
+		return [ CodeEditing, CodeUI ];
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	static get pluginName() {
+		return 'Code';
+	}
+}

package/src/index.js

@@ -0,0 +1,30 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. 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';
+export { default as BoldEditing } from './bold/boldediting';
+export { default as BoldUI } from './bold/boldui';
+export { default as Code } from './code';
+export { default as CodeEditing } from './code/codeediting';
+export { default as CodeUI } from './code/codeui';
+export { default as Italic } from './italic';
+export { default as ItalicEditing } from './italic/italicediting';
+export { default as ItalicUI } from './italic/italicui';
+export { default as Strikethrough } from './strikethrough';
+export { default as StrikethroughEditing } from './strikethrough/strikethroughediting';
+export { default as StrikethroughUI } from './strikethrough/strikethroughui';
+export { default as Subscript } from './subscript';
+export { default as SubscriptEditing } from './subscript/subscriptediting';
+export { default as SubscriptUI } from './subscript/subscriptui';
+export { default as Superscript } from './superscript';
+export { default as SuperscriptEditing } from './superscript/superscriptediting';
+export { default as SuperscriptUI } from './superscript/superscriptui';
+export { default as Underline } from './underline';
+export { default as UnderlineEditing } from './underline/underlineediting';
+export { default as UnderlineUI } from './underline/underlineui';