@ckeditor/ckeditor5-alignment 0.0.0-internal-20241017.0 → 0.0.0-internal-20241206.0

package/LICENSE.md

@@ -1,10 +1,15 @@
 Software License Agreement
 ==========================
 
-**CKEditor&nbsp;5 text alignment feature** – https://github.com/ckeditor/ckeditor5-alignment <br>
+**CKEditor&nbsp;5 Text alignment feature** (https://github.com/ckeditor/ckeditor5)<br>
 Copyright (c) 2003–2024, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
 
-Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).
+Licensed under a dual-license model, this software is available under:
+
+* the [GNU General Public License Version 2 or later](https://www.gnu.org/licenses/gpl.html),
+* or commercial license terms from CKSource Holding sp. z o.o.
+
+For more information, see: [https://ckeditor.com/legal/ckeditor-licensing-options](https://ckeditor.com/legal/ckeditor-licensing-options).
 
 Sources of Intellectual Property Included in CKEditor
 -----------------------------------------------------

package/README.md

@@ -3,10 +3,22 @@ CKEditor 5 text alignment feature
 
 [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-alignment.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-alignment)
 [![Coverage Status](https://coveralls.io/repos/github/ckeditor/ckeditor5/badge.svg?branch=master)](https://coveralls.io/github/ckeditor/ckeditor5?branch=master)
-[![Build Status](https://travis-ci.com/ckeditor/ckeditor5.svg?branch=master)](https://app.travis-ci.com/github/ckeditor/ckeditor5)
+[![CircleCI](https://circleci.com/gh/ckeditor/ckeditor5.svg?style=shield)](https://app.circleci.com/pipelines/github/ckeditor/ckeditor5?branch=master)
 
 This package implements text alignment support for CKEditor 5.
 
+## Installation
+
+This plugin is part of the `ckeditor5` package. Install the whole package to use it.
+
+```bash
+npm install ckeditor5
+```
+
+## Create free account
+
+If you want to check full CKEditor 5 capabilities, sign up for a [free non-commitment 14-day trial](https://portal.ckeditor.com/checkout?plan=free).
+
 ## Demo
 
 Check out the [demo in the text alignment feature guide](https://ckeditor.com/docs/ckeditor5/latest/features/text-alignment.html#demo).
@@ -15,12 +27,11 @@ Check out the [demo in the text alignment feature guide](https://ckeditor.com/do
 
 See the [`@ckeditor/ckeditor5-alignment` package](https://ckeditor.com/docs/ckeditor5/latest/api/alignment.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
 
-## Installation
+## License
 
-```bash
-npm install ckeditor5
-```
+Licensed under a dual-license model, this software is available under:
 
-## License
+* the [GNU General Public License Version 2 or later](https://www.gnu.org/licenses/gpl.html),
+* or commercial license terms from CKSource Holding sp. z o.o.
 
-Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the `LICENSE.md` file or [https://ckeditor.com/legal/ckeditor-oss-license](https://ckeditor.com/legal/ckeditor-oss-license).
+For more information, see: [https://ckeditor.com/legal/ckeditor-licensing-options](https://ckeditor.com/legal/ckeditor-licensing-options).

package/build/translations/ast.js

@@ -0,0 +1 @@
+!function(n){const t=n.ast=n.ast||{};t.dictionary=Object.assign(t.dictionary||{},{"Align center":"","Align left":"","Align right":"",Justify:"","Text alignment":"","Text alignment toolbar":""})}(window.CKEDITOR_TRANSLATIONS||(window.CKEDITOR_TRANSLATIONS={}));

package/build/translations/eo.js

@@ -0,0 +1 @@
+!function(n){const i=n.eo=n.eo||{};i.dictionary=Object.assign(i.dictionary||{},{"Align center":"","Align left":"","Align right":"",Justify:"","Text alignment":"","Text alignment toolbar":""})}(window.CKEDITOR_TRANSLATIONS||(window.CKEDITOR_TRANSLATIONS={}));

package/build/translations/eu.js

@@ -0,0 +1 @@
+!function(n){const i=n.eu=n.eu||{};i.dictionary=Object.assign(i.dictionary||{},{"Align center":"","Align left":"","Align right":"",Justify:"","Text alignment":"","Text alignment toolbar":""})}(window.CKEDITOR_TRANSLATIONS||(window.CKEDITOR_TRANSLATIONS={}));

package/build/translations/gu.js

@@ -0,0 +1 @@
+!function(n){const i=n.gu=n.gu||{};i.dictionary=Object.assign(i.dictionary||{},{"Align center":"","Align left":"","Align right":"",Justify:"","Text alignment":"","Text alignment toolbar":""})}(window.CKEDITOR_TRANSLATIONS||(window.CKEDITOR_TRANSLATIONS={}));

package/build/translations/hy.js

@@ -0,0 +1 @@
+!function(n){const i=n.hy=n.hy||{};i.dictionary=Object.assign(i.dictionary||{},{"Align center":"","Align left":"","Align right":"",Justify:"","Text alignment":"","Text alignment toolbar":""})}(window.CKEDITOR_TRANSLATIONS||(window.CKEDITOR_TRANSLATIONS={}));

package/build/translations/kn.js

@@ -0,0 +1 @@
+!function(n){const i=n.kn=n.kn||{};i.dictionary=Object.assign(i.dictionary||{},{"Align center":"","Align left":"","Align right":"",Justify:"","Text alignment":"","Text alignment toolbar":""})}(window.CKEDITOR_TRANSLATIONS||(window.CKEDITOR_TRANSLATIONS={}));

package/build/translations/oc.js

@@ -0,0 +1 @@
+!function(n){const i=n.oc=n.oc||{};i.dictionary=Object.assign(i.dictionary||{},{"Align center":"","Align left":"","Align right":"",Justify:"","Text alignment":"","Text alignment toolbar":""})}(window.CKEDITOR_TRANSLATIONS||(window.CKEDITOR_TRANSLATIONS={}));

package/build/translations/si.js

@@ -0,0 +1 @@
+!function(i){const n=i.si=i.si||{};n.dictionary=Object.assign(n.dictionary||{},{"Align center":"","Align left":"","Align right":"",Justify:"","Text alignment":"","Text alignment toolbar":""})}(window.CKEDITOR_TRANSLATIONS||(window.CKEDITOR_TRANSLATIONS={}));

package/dist/index.js

@@ -63,12 +63,12 @@ import { ButtonView, createDropdown, addToolbarToDropdown, MenuBarMenuView, Menu
         const isNameValid = supportedOptions.includes(option.name);
         if (!isNameValid) {
             /**
-				 * The `name` in one of the `alignment.options` is not recognized.
-				 * The available options are: `'left'`, `'right'`, `'center'` and `'justify'`.
-				 *
-				 * @error alignment-config-name-not-recognized
-				 * @param option Options with unknown value of the `name` property.
-				 */ logWarning('alignment-config-name-not-recognized', {
+             * The `name` in one of the `alignment.options` is not recognized.
+             * The available options are: `'left'`, `'right'`, `'center'` and `'justify'`.
+             *
+             * @error alignment-config-name-not-recognized
+             * @param option Options with unknown value of the `name` property.
+             */ logWarning('alignment-config-name-not-recognized', {
                 option
             });
         }
@@ -78,11 +78,11 @@ import { ButtonView, createDropdown, addToolbarToDropdown, MenuBarMenuView, Menu
     // We either use classes for all styling options or for none.
     if (classNameCount && classNameCount < normalizedOptions.length) {
         /**
-		 * The `className` property has to be defined for all options once at least one option declares `className`.
-		 *
-		 * @error alignment-config-classnames-are-missing
-		 * @param configuredOptions Contents of `alignment.options`.
-		 */ throw new CKEditorError('alignment-config-classnames-are-missing', {
+         * The `className` property has to be defined for all options once at least one option declares `className`.
+         *
+         * @error alignment-config-classnames-are-missing
+         * @param configuredOptions Contents of `alignment.options`.
+         */ throw new CKEditorError('alignment-config-classnames-are-missing', {
             configuredOptions
         });
     }
@@ -92,13 +92,13 @@ import { ButtonView, createDropdown, addToolbarToDropdown, MenuBarMenuView, Menu
         const nameAlreadyExists = succeedingOptions.some((item)=>item.name == option.name);
         if (nameAlreadyExists) {
             /**
-			 * The same `name` in one of the `alignment.options` was already declared.
-			 * Each `name` representing one alignment option can be set exactly once.
-			 *
-			 * @error alignment-config-name-already-defined
-			 * @param option First option that declares given `name`.
-			 * @param configuredOptions Contents of `alignment.options`.
-			 */ throw new CKEditorError('alignment-config-name-already-defined', {
+             * The same `name` in one of the `alignment.options` was already declared.
+             * Each `name` representing one alignment option can be set exactly once.
+             *
+             * @error alignment-config-name-already-defined
+             * @param option First option that declares given `name`.
+             * @param configuredOptions Contents of `alignment.options`.
+             */ throw new CKEditorError('alignment-config-name-already-defined', {
                 option,
                 configuredOptions
             });
@@ -108,13 +108,13 @@ import { ButtonView, createDropdown, addToolbarToDropdown, MenuBarMenuView, Menu
             const classNameAlreadyExists = succeedingOptions.some((item)=>item.className == option.className);
             if (classNameAlreadyExists) {
                 /**
-				 * The same `className` in one of the `alignment.options` was already declared.
-				 *
-				 * @error alignment-config-classname-already-defined
-				 * @param option First option that declares given `className`.
-				 * @param configuredOptions
-				 * Contents of `alignment.options`.
-				 */ throw new CKEditorError('alignment-config-classname-already-defined', {
+                 * The same `className` in one of the `alignment.options` was already declared.
+                 *
+                 * @error alignment-config-classname-already-defined
+                 * @param option First option that declares given `className`.
+                 * @param configuredOptions
+                 * Contents of `alignment.options`.
+                 */ throw new CKEditorError('alignment-config-classname-already-defined', {
                     option,
                     configuredOptions
                 });
@@ -129,8 +129,8 @@ const ALIGNMENT = 'alignment';
  * The alignment command plugin.
  */ class AlignmentCommand extends Command {
     /**
-	 * @inheritDoc
-	 */ refresh() {
+     * @inheritDoc
+     */ refresh() {
         const editor = this.editor;
         const locale = editor.locale;
         const firstBlock = first(this.editor.model.document.selection.getSelectedBlocks());
@@ -143,14 +143,14 @@ const ALIGNMENT = 'alignment';
         }
     }
     /**
-	 * Executes the command. Applies the alignment `value` to the selected blocks.
-	 * If no `value` is passed, the `value` is the default one or it is equal to the currently selected block's alignment attribute,
-	 * the command will remove the attribute from the selected blocks.
-	 *
-	 * @param options Options for the executed command.
-	 * @param options.value The value to apply.
-	 * @fires execute
-	 */ execute(options = {}) {
+     * Executes the command. Applies the alignment `value` to the selected blocks.
+     * If no `value` is passed, the `value` is the default one or it is equal to the currently selected block's alignment attribute,
+     * the command will remove the attribute from the selected blocks.
+     *
+     * @param options Options for the executed command.
+     * @param options.value The value to apply.
+     * @fires execute
+     */ execute(options = {}) {
         const editor = this.editor;
         const locale = editor.locale;
         const model = editor.model;
@@ -173,10 +173,10 @@ const ALIGNMENT = 'alignment';
         });
     }
     /**
-	 * Checks whether a block can have alignment set.
-	 *
-	 * @param block The block to be checked.
-	 */ _canBeAligned(block) {
+     * Checks whether a block can have alignment set.
+     *
+     * @param block The block to be checked.
+     */ _canBeAligned(block) {
         return this.editor.model.schema.checkAttribute(block, ALIGNMENT);
     }
 }
@@ -200,18 +200,18 @@ const ALIGNMENT = 'alignment';
  * the `alignment` attribute for block elements in the {@link module:engine/model/model~Model model}.
  */ class AlignmentEditing extends Plugin {
     /**
-	 * @inheritDoc
-	 */ static get pluginName() {
+     * @inheritDoc
+     */ static get pluginName() {
         return 'AlignmentEditing';
     }
     /**
-	 * @inheritDoc
-	 */ static get isOfficialPlugin() {
+     * @inheritDoc
+     */ static get isOfficialPlugin() {
         return true;
     }
     /**
-	 * @inheritDoc
-	 */ constructor(editor){
+     * @inheritDoc
+     */ constructor(editor){
         super(editor);
         editor.config.define('alignment', {
             options: supportedOptions.map((option)=>({
@@ -220,8 +220,8 @@ const ALIGNMENT = 'alignment';
         });
     }
     /**
-	 * @inheritDoc
-	 */ init() {
+     * @inheritDoc
+     */ init() {
         const editor = this.editor;
         const locale = editor.locale;
         const schema = editor.model.schema;
@@ -360,18 +360,18 @@ const iconsMap = /* #__PURE__ */ (()=>new Map([
  * and the `'alignment'` dropdown.
  */ class AlignmentUI extends Plugin {
     /**
-	 * Returns the localized option titles provided by the plugin.
-	 *
-	 * The following localized titles corresponding with
-	 * {@link module:alignment/alignmentconfig~AlignmentConfig#options} are available:
-	 *
-	 * * `'left'`,
-	 * * `'right'`,
-	 * * `'center'`,
-	 * * `'justify'`.
-	 *
-	 * @readonly
-	 */ get localizedOptionTitles() {
+     * Returns the localized option titles provided by the plugin.
+     *
+     * The following localized titles corresponding with
+     * {@link module:alignment/alignmentconfig~AlignmentConfig#options} are available:
+     *
+     * * `'left'`,
+     * * `'right'`,
+     * * `'center'`,
+     * * `'justify'`.
+     *
+     * @readonly
+     */ get localizedOptionTitles() {
         const t = this.editor.t;
         return {
             'left': t('Align left'),
@@ -381,18 +381,18 @@ const iconsMap = /* #__PURE__ */ (()=>new Map([
         };
     }
     /**
-	 * @inheritDoc
-	 */ static get pluginName() {
+     * @inheritDoc
+     */ static get pluginName() {
         return 'AlignmentUI';
     }
     /**
-	 * @inheritDoc
-	 */ static get isOfficialPlugin() {
+     * @inheritDoc
+     */ static get isOfficialPlugin() {
         return true;
     }
     /**
-	 * @inheritDoc
-	 */ init() {
+     * @inheritDoc
+     */ init() {
         const editor = this.editor;
         const options = normalizeAlignmentOptions(editor.config.get('alignment.options'));
         options.map((option)=>option.name).filter(isSupported).forEach((option)=>this._addButton(option));
@@ -400,20 +400,20 @@ const iconsMap = /* #__PURE__ */ (()=>new Map([
         this._addMenuBarMenu(options);
     }
     /**
-	 * Helper method for initializing the button and linking it with an appropriate command.
-	 *
-	 * @param option The name of the alignment option for which the button is added.
-	 */ _addButton(option) {
+     * Helper method for initializing the button and linking it with an appropriate command.
+     *
+     * @param option The name of the alignment option for which the button is added.
+     */ _addButton(option) {
         const editor = this.editor;
         editor.ui.componentFactory.add(`alignment:${option}`, (locale)=>this._createButton(locale, option));
     }
     /**
-	 * Helper method for creating the button view element.
-	 *
-	 * @param locale Editor locale.
-	 * @param option The name of the alignment option for which the button is added.
-	 * @param buttonAttrs Optional parameters passed to button view instance.
-	 */ _createButton(locale, option, buttonAttrs = {}) {
+     * Helper method for creating the button view element.
+     *
+     * @param locale Editor locale.
+     * @param option The name of the alignment option for which the button is added.
+     * @param buttonAttrs Optional parameters passed to button view instance.
+     */ _createButton(locale, option, buttonAttrs = {}) {
         const editor = this.editor;
         const command = editor.commands.get('alignment');
         const buttonView = new ButtonView(locale);
@@ -437,10 +437,10 @@ const iconsMap = /* #__PURE__ */ (()=>new Map([
         return buttonView;
     }
     /**
-	 * Helper method for initializing the toolnar dropdown and linking it with an appropriate command.
-	 *
-	 * @param option The name of the alignment option for which the button is added.
-	 */ _addToolbarDropdown(options) {
+     * Helper method for initializing the toolnar dropdown and linking it with an appropriate command.
+     *
+     * @param option The name of the alignment option for which the button is added.
+     */ _addToolbarDropdown(options) {
         const editor = this.editor;
         const factory = editor.ui.componentFactory;
         factory.add('alignment', (locale)=>{
@@ -481,10 +481,10 @@ const iconsMap = /* #__PURE__ */ (()=>new Map([
         });
     }
     /**
-	 * Creates a menu for all alignment options to use either in menu bar.
-	 *
-	 * @param options Normalized alignment options from config.
-	 */ _addMenuBarMenu(options) {
+     * Creates a menu for all alignment options to use either in menu bar.
+     *
+     * @param options Normalized alignment options from config.
+     */ _addMenuBarMenu(options) {
         const editor = this.editor;
         editor.ui.componentFactory.add('menuBar:alignment', (locale)=>{
             const command = editor.commands.get('alignment');
@@ -536,21 +536,21 @@ const iconsMap = /* #__PURE__ */ (()=>new Map([
  * {@link module:alignment/alignmentui~AlignmentUI} plugins.
  */ class Alignment extends Plugin {
     /**
-	 * @inheritDoc
-	 */ static get requires() {
+     * @inheritDoc
+     */ static get requires() {
         return [
             AlignmentEditing,
             AlignmentUI
         ];
     }
     /**
-	 * @inheritDoc
-	 */ static get pluginName() {
+     * @inheritDoc
+     */ static get pluginName() {
         return 'Alignment';
     }
     /**
-	 * @inheritDoc
-	 */ static get isOfficialPlugin() {
+     * @inheritDoc
+     */ static get isOfficialPlugin() {
         return true;
     }
 }