@ckeditor/ckeditor5-ui 40.0.0 → 40.2.0

package/src/colorselector/colorpickerfragmentview.d.ts

@@ -1,128 +1,128 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module ui/colorselector/colorpickerfragmentview
- */
-import View from '../view';
-import ButtonView from '../button/buttonview';
-import type ViewCollection from '../viewcollection';
-import { default as ColorPickerView } from '../colorpicker/colorpickerview';
-import type { FocusTracker, KeystrokeHandler, Locale } from '@ckeditor/ckeditor5-utils';
-import type { ColorPickerViewConfig } from '../colorpicker/utils';
-/**
- * One of the fragments of {@link module:ui/colorselector/colorselectorview~ColorSelectorView}.
- *
- * It allows users to select a color from a color picker.
- *
- * It consists of the following sub–components:
- *
- * * A color picker saturation and hue sliders,
- * * A text input accepting colors in HEX format,
- * * "Save" and "Cancel" action buttons.
- */
-export default class ColorPickerFragmentView extends View {
-    /**
-     * A collection of component's children.
-     */
-    readonly items: ViewCollection;
-    /**
-     * A view with saturation and hue sliders and color input.
-     */
-    colorPickerView?: ColorPickerView;
-    /**
-     * The "Save" button view.
-     */
-    saveButtonView: ButtonView;
-    /**
-     * The "Cancel" button view.
-     */
-    cancelButtonView: ButtonView;
-    /**
-     * The action bar where are "Save" button and "Cancel" button.
-     */
-    actionBarView: View;
-    /**
-     * Tracks information about the DOM focus in the list.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Indicates whether the component is visible or not.
-     */
-    isVisible: boolean;
-    /**
-     * Keeps the value of the command associated with the component for the current selection.
-     */
-    selectedColor?: string;
-    /**
-     * A collection of views that can be focused in the view.
-     *
-     * @readonly
-     */
-    protected _focusables: ViewCollection;
-    /**
-     * A reference to the configuration of {@link #colorPickerView}. `false` when the view was
-     * configured without a color picker.
-     *
-     * @readonly
-     */
-    private _colorPickerViewConfig;
-    /**
-     * Creates an instance of the view.
-     *
-     * @param locale The localization services instance.
-     * @param focusTracker Tracks information about the DOM focus in the list.
-     * @param focusables A collection of views that can be focused in the view..
-     * @param keystrokes An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     * @param colorPickerViewConfig The configuration of color picker feature. If set to `false`, the color picker
-     * will not be rendered.
-     */
-    constructor(locale: Locale, { focusTracker, focusables, keystrokes, colorPickerViewConfig }: {
-        focusTracker: FocusTracker;
-        focusables: ViewCollection;
-        keystrokes: KeystrokeHandler;
-        colorPickerViewConfig: ColorPickerViewConfig | false;
-    });
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Focuses the color picker.
-     */
-    focus(): void;
-    /**
-     * When color picker is focused and "enter" is pressed it executes command.
-     */
-    private _executeOnEnterPress;
-    /**
-     * Removes default behavior of arrow keys in dropdown.
-     */
-    private _stopPropagationOnArrowsKeys;
-    /**
-     * Adds color picker elements to focus tracker.
-     */
-    private _addColorPickersElementsToFocusTracker;
-    /**
-     * Creates bar containing "Save" and "Cancel" buttons.
-     */
-    private _createActionBarView;
-    /**
-     * Creates "Save" and "Cancel" buttons.
-     */
-    private _createActionButtons;
-    /**
-     * Fires the `execute` event if color in color picker has been changed
-     * by the user.
-     */
-    private _executeUponColorChange;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module ui/colorselector/colorpickerfragmentview
+ */
+import View from '../view';
+import ButtonView from '../button/buttonview';
+import type ViewCollection from '../viewcollection';
+import { default as ColorPickerView } from '../colorpicker/colorpickerview';
+import type { FocusTracker, KeystrokeHandler, Locale } from '@ckeditor/ckeditor5-utils';
+import type { ColorPickerViewConfig } from '../colorpicker/utils';
+/**
+ * One of the fragments of {@link module:ui/colorselector/colorselectorview~ColorSelectorView}.
+ *
+ * It allows users to select a color from a color picker.
+ *
+ * It consists of the following sub–components:
+ *
+ * * A color picker saturation and hue sliders,
+ * * A text input accepting colors in HEX format,
+ * * "Save" and "Cancel" action buttons.
+ */
+export default class ColorPickerFragmentView extends View {
+    /**
+     * A collection of component's children.
+     */
+    readonly items: ViewCollection;
+    /**
+     * A view with saturation and hue sliders and color input.
+     */
+    colorPickerView?: ColorPickerView;
+    /**
+     * The "Save" button view.
+     */
+    saveButtonView: ButtonView;
+    /**
+     * The "Cancel" button view.
+     */
+    cancelButtonView: ButtonView;
+    /**
+     * The action bar where are "Save" button and "Cancel" button.
+     */
+    actionBarView: View;
+    /**
+     * Tracks information about the DOM focus in the list.
+     */
+    readonly focusTracker: FocusTracker;
+    /**
+     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+     */
+    readonly keystrokes: KeystrokeHandler;
+    /**
+     * Indicates whether the component is visible or not.
+     */
+    isVisible: boolean;
+    /**
+     * Keeps the value of the command associated with the component for the current selection.
+     */
+    selectedColor?: string;
+    /**
+     * A collection of views that can be focused in the view.
+     *
+     * @readonly
+     */
+    protected _focusables: ViewCollection;
+    /**
+     * A reference to the configuration of {@link #colorPickerView}. `false` when the view was
+     * configured without a color picker.
+     *
+     * @readonly
+     */
+    private _colorPickerViewConfig;
+    /**
+     * Creates an instance of the view.
+     *
+     * @param locale The localization services instance.
+     * @param focusTracker Tracks information about the DOM focus in the list.
+     * @param focusables A collection of views that can be focused in the view..
+     * @param keystrokes An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+     * @param colorPickerViewConfig The configuration of color picker feature. If set to `false`, the color picker
+     * will not be rendered.
+     */
+    constructor(locale: Locale, { focusTracker, focusables, keystrokes, colorPickerViewConfig }: {
+        focusTracker: FocusTracker;
+        focusables: ViewCollection;
+        keystrokes: KeystrokeHandler;
+        colorPickerViewConfig: ColorPickerViewConfig | false;
+    });
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Focuses the color picker.
+     */
+    focus(): void;
+    /**
+     * When color picker is focused and "enter" is pressed it executes command.
+     */
+    private _executeOnEnterPress;
+    /**
+     * Removes default behavior of arrow keys in dropdown.
+     */
+    private _stopPropagationOnArrowsKeys;
+    /**
+     * Adds color picker elements to focus tracker.
+     */
+    private _addColorPickersElementsToFocusTracker;
+    /**
+     * Creates bar containing "Save" and "Cancel" buttons.
+     */
+    private _createActionBarView;
+    /**
+     * Creates "Save" and "Cancel" buttons.
+     */
+    private _createActionButtons;
+    /**
+     * Fires the `execute` event if color in color picker has been changed
+     * by the user.
+     */
+    private _executeUponColorChange;
+}

package/src/colorselector/colorpickerfragmentview.js

@@ -1,205 +1,205 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module ui/colorselector/colorpickerfragmentview
- */
-import View from '../view';
-import ButtonView from '../button/buttonview';
-import { default as ColorPickerView } from '../colorpicker/colorpickerview';
-import checkButtonIcon from '@ckeditor/ckeditor5-core/theme/icons/check.svg';
-import cancelButtonIcon from '@ckeditor/ckeditor5-core/theme/icons/cancel.svg';
-/**
- * One of the fragments of {@link module:ui/colorselector/colorselectorview~ColorSelectorView}.
- *
- * It allows users to select a color from a color picker.
- *
- * It consists of the following sub–components:
- *
- * * A color picker saturation and hue sliders,
- * * A text input accepting colors in HEX format,
- * * "Save" and "Cancel" action buttons.
- */
-export default class ColorPickerFragmentView extends View {
-    /**
-     * Creates an instance of the view.
-     *
-     * @param locale The localization services instance.
-     * @param focusTracker Tracks information about the DOM focus in the list.
-     * @param focusables A collection of views that can be focused in the view..
-     * @param keystrokes An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     * @param colorPickerViewConfig The configuration of color picker feature. If set to `false`, the color picker
-     * will not be rendered.
-     */
-    constructor(locale, { focusTracker, focusables, keystrokes, colorPickerViewConfig }) {
-        super(locale);
-        this.items = this.createCollection();
-        this.focusTracker = focusTracker;
-        this.keystrokes = keystrokes;
-        this.set('isVisible', false);
-        this.set('selectedColor', undefined);
-        this._focusables = focusables;
-        this._colorPickerViewConfig = colorPickerViewConfig;
-        const bind = this.bindTemplate;
-        const { saveButtonView, cancelButtonView } = this._createActionButtons();
-        this.saveButtonView = saveButtonView;
-        this.cancelButtonView = cancelButtonView;
-        this.actionBarView = this._createActionBarView({ saveButtonView, cancelButtonView });
-        this.setTemplate({
-            tag: 'div',
-            attributes: {
-                class: [
-                    'ck-color-picker-fragment',
-                    bind.if('isVisible', 'ck-hidden', value => !value)
-                ]
-            },
-            children: this.items
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    render() {
-        super.render();
-        const colorPickerView = new ColorPickerView(this.locale, {
-            ...this._colorPickerViewConfig
-        });
-        this.colorPickerView = colorPickerView;
-        this.colorPickerView.render();
-        if (this.selectedColor) {
-            colorPickerView.color = this.selectedColor;
-        }
-        this.listenTo(this, 'change:selectedColor', (evt, name, value) => {
-            colorPickerView.color = value;
-        });
-        this.items.add(this.colorPickerView);
-        this.items.add(this.actionBarView);
-        this._addColorPickersElementsToFocusTracker();
-        this._stopPropagationOnArrowsKeys();
-        this._executeOnEnterPress();
-        this._executeUponColorChange();
-    }
-    /**
-     * @inheritDoc
-     */
-    destroy() {
-        super.destroy();
-    }
-    /**
-     * Focuses the color picker.
-     */
-    focus() {
-        this.colorPickerView.focus();
-    }
-    /**
-     * When color picker is focused and "enter" is pressed it executes command.
-     */
-    _executeOnEnterPress() {
-        this.keystrokes.set('enter', evt => {
-            if (this.isVisible && this.focusTracker.focusedElement !== this.cancelButtonView.element) {
-                this.fire('execute', {
-                    value: this.selectedColor
-                });
-                evt.stopPropagation();
-                evt.preventDefault();
-            }
-        });
-    }
-    /**
-     * Removes default behavior of arrow keys in dropdown.
-     */
-    _stopPropagationOnArrowsKeys() {
-        const stopPropagation = (data) => data.stopPropagation();
-        this.keystrokes.set('arrowright', stopPropagation);
-        this.keystrokes.set('arrowleft', stopPropagation);
-        this.keystrokes.set('arrowup', stopPropagation);
-        this.keystrokes.set('arrowdown', stopPropagation);
-    }
-    /**
-     * Adds color picker elements to focus tracker.
-     */
-    _addColorPickersElementsToFocusTracker() {
-        for (const slider of this.colorPickerView.slidersView) {
-            this.focusTracker.add(slider.element);
-            this._focusables.add(slider);
-        }
-        const input = this.colorPickerView.hexInputRow.children.get(1);
-        if (input.element) {
-            this.focusTracker.add(input.element);
-            this._focusables.add(input);
-        }
-        this.focusTracker.add(this.saveButtonView.element);
-        this._focusables.add(this.saveButtonView);
-        this.focusTracker.add(this.cancelButtonView.element);
-        this._focusables.add(this.cancelButtonView);
-    }
-    /**
-     * Creates bar containing "Save" and "Cancel" buttons.
-     */
-    _createActionBarView({ saveButtonView, cancelButtonView }) {
-        const actionBarRow = new View();
-        const children = this.createCollection();
-        children.add(saveButtonView);
-        children.add(cancelButtonView);
-        actionBarRow.setTemplate({
-            tag: 'div',
-            attributes: {
-                class: [
-                    'ck',
-                    'ck-color-selector_action-bar'
-                ]
-            },
-            children
-        });
-        return actionBarRow;
-    }
-    /**
-     * Creates "Save" and "Cancel" buttons.
-     */
-    _createActionButtons() {
-        const locale = this.locale;
-        const t = locale.t;
-        const saveButtonView = new ButtonView(locale);
-        const cancelButtonView = new ButtonView(locale);
-        saveButtonView.set({
-            icon: checkButtonIcon,
-            class: 'ck-button-save',
-            type: 'button',
-            withText: false,
-            label: t('Accept')
-        });
-        cancelButtonView.set({
-            icon: cancelButtonIcon,
-            class: 'ck-button-cancel',
-            type: 'button',
-            withText: false,
-            label: t('Cancel')
-        });
-        saveButtonView.on('execute', () => {
-            this.fire('execute', {
-                source: 'colorPickerSaveButton',
-                value: this.selectedColor
-            });
-        });
-        cancelButtonView.on('execute', () => {
-            this.fire('colorPicker:cancel');
-        });
-        return {
-            saveButtonView, cancelButtonView
-        };
-    }
-    /**
-     * Fires the `execute` event if color in color picker has been changed
-     * by the user.
-     */
-    _executeUponColorChange() {
-        this.colorPickerView.on('colorSelected', (evt, data) => {
-            this.fire('execute', {
-                value: data.color,
-                source: 'colorPicker'
-            });
-            this.set('selectedColor', data.color);
-        });
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module ui/colorselector/colorpickerfragmentview
+ */
+import View from '../view';
+import ButtonView from '../button/buttonview';
+import { default as ColorPickerView } from '../colorpicker/colorpickerview';
+import checkButtonIcon from '@ckeditor/ckeditor5-core/theme/icons/check.svg';
+import cancelButtonIcon from '@ckeditor/ckeditor5-core/theme/icons/cancel.svg';
+/**
+ * One of the fragments of {@link module:ui/colorselector/colorselectorview~ColorSelectorView}.
+ *
+ * It allows users to select a color from a color picker.
+ *
+ * It consists of the following sub–components:
+ *
+ * * A color picker saturation and hue sliders,
+ * * A text input accepting colors in HEX format,
+ * * "Save" and "Cancel" action buttons.
+ */
+export default class ColorPickerFragmentView extends View {
+    /**
+     * Creates an instance of the view.
+     *
+     * @param locale The localization services instance.
+     * @param focusTracker Tracks information about the DOM focus in the list.
+     * @param focusables A collection of views that can be focused in the view..
+     * @param keystrokes An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+     * @param colorPickerViewConfig The configuration of color picker feature. If set to `false`, the color picker
+     * will not be rendered.
+     */
+    constructor(locale, { focusTracker, focusables, keystrokes, colorPickerViewConfig }) {
+        super(locale);
+        this.items = this.createCollection();
+        this.focusTracker = focusTracker;
+        this.keystrokes = keystrokes;
+        this.set('isVisible', false);
+        this.set('selectedColor', undefined);
+        this._focusables = focusables;
+        this._colorPickerViewConfig = colorPickerViewConfig;
+        const bind = this.bindTemplate;
+        const { saveButtonView, cancelButtonView } = this._createActionButtons();
+        this.saveButtonView = saveButtonView;
+        this.cancelButtonView = cancelButtonView;
+        this.actionBarView = this._createActionBarView({ saveButtonView, cancelButtonView });
+        this.setTemplate({
+            tag: 'div',
+            attributes: {
+                class: [
+                    'ck-color-picker-fragment',
+                    bind.if('isVisible', 'ck-hidden', value => !value)
+                ]
+            },
+            children: this.items
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    render() {
+        super.render();
+        const colorPickerView = new ColorPickerView(this.locale, {
+            ...this._colorPickerViewConfig
+        });
+        this.colorPickerView = colorPickerView;
+        this.colorPickerView.render();
+        if (this.selectedColor) {
+            colorPickerView.color = this.selectedColor;
+        }
+        this.listenTo(this, 'change:selectedColor', (evt, name, value) => {
+            colorPickerView.color = value;
+        });
+        this.items.add(this.colorPickerView);
+        this.items.add(this.actionBarView);
+        this._addColorPickersElementsToFocusTracker();
+        this._stopPropagationOnArrowsKeys();
+        this._executeOnEnterPress();
+        this._executeUponColorChange();
+    }
+    /**
+     * @inheritDoc
+     */
+    destroy() {
+        super.destroy();
+    }
+    /**
+     * Focuses the color picker.
+     */
+    focus() {
+        this.colorPickerView.focus();
+    }
+    /**
+     * When color picker is focused and "enter" is pressed it executes command.
+     */
+    _executeOnEnterPress() {
+        this.keystrokes.set('enter', evt => {
+            if (this.isVisible && this.focusTracker.focusedElement !== this.cancelButtonView.element) {
+                this.fire('execute', {
+                    value: this.selectedColor
+                });
+                evt.stopPropagation();
+                evt.preventDefault();
+            }
+        });
+    }
+    /**
+     * Removes default behavior of arrow keys in dropdown.
+     */
+    _stopPropagationOnArrowsKeys() {
+        const stopPropagation = (data) => data.stopPropagation();
+        this.keystrokes.set('arrowright', stopPropagation);
+        this.keystrokes.set('arrowleft', stopPropagation);
+        this.keystrokes.set('arrowup', stopPropagation);
+        this.keystrokes.set('arrowdown', stopPropagation);
+    }
+    /**
+     * Adds color picker elements to focus tracker.
+     */
+    _addColorPickersElementsToFocusTracker() {
+        for (const slider of this.colorPickerView.slidersView) {
+            this.focusTracker.add(slider.element);
+            this._focusables.add(slider);
+        }
+        const input = this.colorPickerView.hexInputRow.children.get(1);
+        if (input.element) {
+            this.focusTracker.add(input.element);
+            this._focusables.add(input);
+        }
+        this.focusTracker.add(this.saveButtonView.element);
+        this._focusables.add(this.saveButtonView);
+        this.focusTracker.add(this.cancelButtonView.element);
+        this._focusables.add(this.cancelButtonView);
+    }
+    /**
+     * Creates bar containing "Save" and "Cancel" buttons.
+     */
+    _createActionBarView({ saveButtonView, cancelButtonView }) {
+        const actionBarRow = new View();
+        const children = this.createCollection();
+        children.add(saveButtonView);
+        children.add(cancelButtonView);
+        actionBarRow.setTemplate({
+            tag: 'div',
+            attributes: {
+                class: [
+                    'ck',
+                    'ck-color-selector_action-bar'
+                ]
+            },
+            children
+        });
+        return actionBarRow;
+    }
+    /**
+     * Creates "Save" and "Cancel" buttons.
+     */
+    _createActionButtons() {
+        const locale = this.locale;
+        const t = locale.t;
+        const saveButtonView = new ButtonView(locale);
+        const cancelButtonView = new ButtonView(locale);
+        saveButtonView.set({
+            icon: checkButtonIcon,
+            class: 'ck-button-save',
+            type: 'button',
+            withText: false,
+            label: t('Accept')
+        });
+        cancelButtonView.set({
+            icon: cancelButtonIcon,
+            class: 'ck-button-cancel',
+            type: 'button',
+            withText: false,
+            label: t('Cancel')
+        });
+        saveButtonView.on('execute', () => {
+            this.fire('execute', {
+                source: 'colorPickerSaveButton',
+                value: this.selectedColor
+            });
+        });
+        cancelButtonView.on('execute', () => {
+            this.fire('colorPicker:cancel');
+        });
+        return {
+            saveButtonView, cancelButtonView
+        };
+    }
+    /**
+     * Fires the `execute` event if color in color picker has been changed
+     * by the user.
+     */
+    _executeUponColorChange() {
+        this.colorPickerView.on('colorSelected', (evt, data) => {
+            this.fire('execute', {
+                value: data.color,
+                source: 'colorPicker'
+            });
+            this.set('selectedColor', data.color);
+        });
+    }
+}