@ckeditor/ckeditor5-table 0.0.0-nightly-20260118.0 → 0.0.0-nightly-next-20260118.0

package/src/tableproperties/ui/tablepropertiesview.js

@@ -1,520 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module table/tableproperties/ui/tablepropertiesview
- */
-import { addListToDropdown, ButtonView, createLabeledDropdown, createLabeledInputText, FocusCycler, FormRowView, FormHeaderView, LabeledFieldView, LabelView, submitHandler, ToolbarView, View, ViewCollection } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler } from 'ckeditor5/src/utils.js';
-import { IconCancel, IconCheck, IconObjectCenter, IconObjectInlineLeft, IconObjectInlineRight } from 'ckeditor5/src/icons.js';
-import { fillToolbar, getBorderStyleDefinitions, getBorderStyleLabels, getLabeledColorInputCreator } from '../../utils/ui/table-properties.js';
-// eslint-disable-next-line ckeditor5-rules/ckeditor-imports
-import '@ckeditor/ckeditor5-ui/theme/components/form/form.css';
-import '../../../theme/formrow.css';
-import '../../../theme/tableform.css';
-import '../../../theme/tableproperties.css';
-/**
- * The class representing a table properties form, allowing users to customize
- * certain style aspects of a table, for instance, border, background color, alignment, etc..
- */
-export class TablePropertiesView extends View {
-    /**
-     * Options passed to the view. See {@link #constructor} to learn more.
-     */
-    options;
-    /**
-     * Tracks information about the DOM focus in the form.
-     */
-    focusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    keystrokes;
-    /**
-     * A collection of child views in the form.
-     */
-    children;
-    /**
-     * A dropdown that allows selecting the style of the table border.
-     */
-    borderStyleDropdown;
-    /**
-     * An input that allows specifying the width of the table border.
-     */
-    borderWidthInput;
-    /**
-     * An input that allows specifying the color of the table border.
-     */
-    borderColorInput;
-    /**
-     * An input that allows specifying the table background color.
-     */
-    backgroundInput;
-    /**
-     * An input that allows specifying the table width.
-     */
-    widthInput;
-    /**
-     * An input that allows specifying the table height.
-     */
-    heightInput;
-    /**
-     * A toolbar with buttons that allow changing the alignment of an entire table.
-     */
-    alignmentToolbar;
-    /**
-     * The "Save" button view.
-     */
-    saveButtonView;
-    /**
-     * The "Cancel" button view.
-     */
-    cancelButtonView;
-    /**
-     * A collection of views that can be focused in the form.
-     */
-    _focusables;
-    /**
-     * Helps cycling over {@link #_focusables} in the form.
-     */
-    _focusCycler;
-    /**
-     * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
-     * @param options Additional configuration of the view.
-     */
-    constructor(locale, options) {
-        super(locale);
-        this.set({
-            borderStyle: '',
-            borderWidth: '',
-            borderColor: '',
-            backgroundColor: '',
-            width: '',
-            height: '',
-            alignment: ''
-        });
-        this.options = options;
-        const { borderStyleDropdown, borderWidthInput, borderColorInput, borderRowLabel } = this._createBorderFields();
-        const { backgroundRowLabel, backgroundInput } = this._createBackgroundFields();
-        const { widthInput, operatorLabel, heightInput, dimensionsLabel } = this._createDimensionFields();
-        const { alignmentToolbar, alignmentLabel } = this._createAlignmentFields();
-        this.focusTracker = new FocusTracker();
-        this.keystrokes = new KeystrokeHandler();
-        this.children = this.createCollection();
-        this.borderStyleDropdown = borderStyleDropdown;
-        this.borderWidthInput = borderWidthInput;
-        this.borderColorInput = borderColorInput;
-        this.backgroundInput = backgroundInput;
-        this.widthInput = widthInput;
-        this.heightInput = heightInput;
-        this.alignmentToolbar = alignmentToolbar;
-        // Defer creating to make sure other fields are present and the Save button can
-        // bind its #isEnabled to their error messages so there's no way to save unless all
-        // fields are valid.
-        const { saveButtonView, cancelButtonView } = this._createActionButtons();
-        this.saveButtonView = saveButtonView;
-        this.cancelButtonView = cancelButtonView;
-        this._focusables = new ViewCollection();
-        this._focusCycler = new FocusCycler({
-            focusables: this._focusables,
-            focusTracker: this.focusTracker,
-            keystrokeHandler: this.keystrokes,
-            actions: {
-                // Navigate form fields backwards using the Shift + Tab keystroke.
-                focusPrevious: 'shift + tab',
-                // Navigate form fields forwards using the Tab key.
-                focusNext: 'tab'
-            }
-        });
-        // Form header.
-        this.children.add(new FormHeaderView(locale, {
-            label: this.t('Table properties')
-        }));
-        // Border row.
-        this.children.add(new FormRowView(locale, {
-            labelView: borderRowLabel,
-            children: [
-                borderRowLabel,
-                borderStyleDropdown,
-                borderColorInput,
-                borderWidthInput
-            ],
-            class: 'ck-table-form__border-row'
-        }));
-        // Background row.
-        this.children.add(new FormRowView(locale, {
-            labelView: backgroundRowLabel,
-            children: [
-                backgroundRowLabel,
-                backgroundInput
-            ],
-            class: 'ck-table-form__background-row'
-        }));
-        this.children.add(new FormRowView(locale, {
-            children: [
-                // Dimensions row.
-                new FormRowView(locale, {
-                    labelView: dimensionsLabel,
-                    children: [
-                        dimensionsLabel,
-                        widthInput,
-                        operatorLabel,
-                        heightInput
-                    ],
-                    class: 'ck-table-form__dimensions-row'
-                }),
-                // Alignment row.
-                new FormRowView(locale, {
-                    labelView: alignmentLabel,
-                    children: [
-                        alignmentLabel,
-                        alignmentToolbar
-                    ],
-                    class: 'ck-table-properties-form__alignment-row'
-                })
-            ]
-        }));
-        // Action row.
-        this.children.add(new FormRowView(locale, {
-            children: [
-                this.saveButtonView,
-                this.cancelButtonView
-            ],
-            class: 'ck-table-form__action-row'
-        }));
-        this.setTemplate({
-            tag: 'form',
-            attributes: {
-                class: [
-                    'ck',
-                    'ck-form',
-                    'ck-table-form',
-                    'ck-table-properties-form'
-                ],
-                // https://github.com/ckeditor/ckeditor5-link/issues/90
-                tabindex: '-1'
-            },
-            children: this.children
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    render() {
-        super.render();
-        // Enable the "submit" event for this view. It can be triggered by the #saveButtonView
-        // which is of the "submit" DOM "type".
-        submitHandler({
-            view: this
-        });
-        // Maintain continuous focus cycling over views that have focusable children and focus cyclers themselves.
-        [this.borderColorInput, this.backgroundInput].forEach(view => {
-            this._focusCycler.chain(view.fieldView.focusCycler);
-        });
-        [
-            this.borderStyleDropdown,
-            this.borderColorInput,
-            this.borderWidthInput,
-            this.backgroundInput,
-            this.widthInput,
-            this.heightInput,
-            this.alignmentToolbar,
-            this.saveButtonView,
-            this.cancelButtonView
-        ].forEach(view => {
-            // Register the view as focusable.
-            this._focusables.add(view);
-            // Register the view in the focus tracker.
-            this.focusTracker.add(view.element);
-        });
-        // Mainly for closing using "Esc" and navigation using "Tab".
-        this.keystrokes.listenTo(this.element);
-    }
-    /**
-     * @inheritDoc
-     */
-    destroy() {
-        super.destroy();
-        this.focusTracker.destroy();
-        this.keystrokes.destroy();
-    }
-    /**
-     * Focuses the fist focusable field in the form.
-     */
-    focus() {
-        this._focusCycler.focusFirst();
-    }
-    /**
-     * Creates the following form fields:
-     *
-     * * {@link #borderStyleDropdown},
-     * * {@link #borderWidthInput},
-     * * {@link #borderColorInput}.
-     */
-    _createBorderFields() {
-        const defaultTableProperties = this.options.defaultTableProperties;
-        const defaultBorder = {
-            style: defaultTableProperties.borderStyle,
-            width: defaultTableProperties.borderWidth,
-            color: defaultTableProperties.borderColor
-        };
-        const colorInputCreator = getLabeledColorInputCreator({
-            colorConfig: this.options.borderColors,
-            columns: 5,
-            defaultColorValue: defaultBorder.color,
-            colorPickerConfig: this.options.colorPickerConfig
-        });
-        const locale = this.locale;
-        const t = this.t;
-        const accessibleLabel = t('Style');
-        // -- Group label ---------------------------------------------
-        const borderRowLabel = new LabelView(locale);
-        borderRowLabel.text = t('Border');
-        // -- Style ---------------------------------------------------
-        const styleLabels = getBorderStyleLabels(t);
-        const borderStyleDropdown = new LabeledFieldView(locale, createLabeledDropdown);
-        borderStyleDropdown.set({
-            label: accessibleLabel,
-            class: 'ck-table-form__border-style'
-        });
-        borderStyleDropdown.fieldView.buttonView.set({
-            ariaLabel: accessibleLabel,
-            ariaLabelledBy: undefined,
-            isOn: false,
-            withText: true,
-            tooltip: accessibleLabel
-        });
-        borderStyleDropdown.fieldView.buttonView.bind('label').to(this, 'borderStyle', value => {
-            return styleLabels[value ? value : 'none'];
-        });
-        borderStyleDropdown.fieldView.on('execute', evt => {
-            this.borderStyle = evt.source._borderStyleValue;
-        });
-        borderStyleDropdown.bind('isEmpty').to(this, 'borderStyle', value => !value);
-        addListToDropdown(borderStyleDropdown.fieldView, getBorderStyleDefinitions(this, defaultBorder.style), {
-            role: 'menu',
-            ariaLabel: accessibleLabel
-        });
-        // -- Width ---------------------------------------------------
-        const borderWidthInput = new LabeledFieldView(locale, createLabeledInputText);
-        borderWidthInput.set({
-            label: t('Width'),
-            class: 'ck-table-form__border-width'
-        });
-        borderWidthInput.fieldView.bind('value').to(this, 'borderWidth');
-        borderWidthInput.bind('isEnabled').to(this, 'borderStyle', isBorderStyleSet);
-        borderWidthInput.fieldView.on('input', () => {
-            this.borderWidth = borderWidthInput.fieldView.element.value;
-        });
-        // -- Color ---------------------------------------------------
-        const borderColorInput = new LabeledFieldView(locale, colorInputCreator);
-        borderColorInput.set({
-            label: t('Color'),
-            class: 'ck-table-form__border-color'
-        });
-        borderColorInput.fieldView.bind('value').to(this, 'borderColor');
-        borderColorInput.bind('isEnabled').to(this, 'borderStyle', isBorderStyleSet);
-        borderColorInput.fieldView.on('input', () => {
-            this.borderColor = borderColorInput.fieldView.value;
-        });
-        // Reset the border color and width fields depending on the `border-style` value.
-        this.on('change:borderStyle', (evt, name, newValue, oldValue) => {
-            // When removing the border (`border-style:none`), clear the remaining `border-*` properties.
-            // See: https://github.com/ckeditor/ckeditor5/issues/6227.
-            if (!isBorderStyleSet(newValue)) {
-                this.borderColor = '';
-                this.borderWidth = '';
-            }
-            // When setting the `border-style` from `none`, set the default `border-color` and `border-width` properties.
-            if (!isBorderStyleSet(oldValue)) {
-                this.borderColor = defaultBorder.color;
-                this.borderWidth = defaultBorder.width;
-            }
-        });
-        return {
-            borderRowLabel,
-            borderStyleDropdown,
-            borderColorInput,
-            borderWidthInput
-        };
-    }
-    /**
-     * Creates the following form fields:
-     *
-     * * {@link #backgroundInput}.
-     */
-    _createBackgroundFields() {
-        const locale = this.locale;
-        const t = this.t;
-        // -- Group label ---------------------------------------------
-        const backgroundRowLabel = new LabelView(locale);
-        backgroundRowLabel.text = t('Background');
-        // -- Background color input -----------------------------------
-        const backgroundInputCreator = getLabeledColorInputCreator({
-            colorConfig: this.options.backgroundColors,
-            columns: 5,
-            defaultColorValue: this.options.defaultTableProperties.backgroundColor,
-            colorPickerConfig: this.options.colorPickerConfig
-        });
-        const backgroundInput = new LabeledFieldView(locale, backgroundInputCreator);
-        backgroundInput.set({
-            label: t('Color'),
-            class: 'ck-table-properties-form__background'
-        });
-        backgroundInput.fieldView.bind('value').to(this, 'backgroundColor');
-        backgroundInput.fieldView.on('input', () => {
-            this.backgroundColor = backgroundInput.fieldView.value;
-        });
-        return {
-            backgroundRowLabel,
-            backgroundInput
-        };
-    }
-    /**
-     * Creates the following form fields:
-     *
-     * * {@link #widthInput},
-     * * {@link #heightInput}.
-     */
-    _createDimensionFields() {
-        const locale = this.locale;
-        const t = this.t;
-        // -- Label ---------------------------------------------------
-        const dimensionsLabel = new LabelView(locale);
-        dimensionsLabel.text = t('Dimensions');
-        // -- Width ---------------------------------------------------
-        const widthInput = new LabeledFieldView(locale, createLabeledInputText);
-        widthInput.set({
-            label: t('Width'),
-            class: 'ck-table-form__dimensions-row__width'
-        });
-        widthInput.fieldView.bind('value').to(this, 'width');
-        widthInput.fieldView.on('input', () => {
-            this.width = widthInput.fieldView.element.value;
-        });
-        // -- Operator ---------------------------------------------------
-        const operatorLabel = new View(locale);
-        operatorLabel.setTemplate({
-            tag: 'span',
-            attributes: {
-                class: [
-                    'ck-table-form__dimension-operator'
-                ]
-            },
-            children: [
-                { text: '×' }
-            ]
-        });
-        // -- Height ---------------------------------------------------
-        const heightInput = new LabeledFieldView(locale, createLabeledInputText);
-        heightInput.set({
-            label: t('Height'),
-            class: 'ck-table-form__dimensions-row__height'
-        });
-        heightInput.fieldView.bind('value').to(this, 'height');
-        heightInput.fieldView.on('input', () => {
-            this.height = heightInput.fieldView.element.value;
-        });
-        return {
-            dimensionsLabel,
-            widthInput,
-            operatorLabel,
-            heightInput
-        };
-    }
-    /**
-     * Creates the following form fields:
-     *
-     * * {@link #alignmentToolbar}.
-     */
-    _createAlignmentFields() {
-        const locale = this.locale;
-        const t = this.t;
-        // -- Label ---------------------------------------------------
-        const alignmentLabel = new LabelView(locale);
-        alignmentLabel.text = t('Alignment');
-        // -- Toolbar ---------------------------------------------------
-        const alignmentToolbar = new ToolbarView(locale);
-        alignmentToolbar.set({
-            role: 'radiogroup',
-            isCompact: true,
-            ariaLabel: t('Table alignment toolbar')
-        });
-        fillToolbar({
-            view: this,
-            icons: {
-                left: IconObjectInlineLeft,
-                center: IconObjectCenter,
-                right: IconObjectInlineRight
-            },
-            toolbar: alignmentToolbar,
-            labels: this._alignmentLabels,
-            propertyName: 'alignment',
-            defaultValue: this.options.defaultTableProperties.alignment
-        });
-        return {
-            alignmentLabel,
-            alignmentToolbar
-        };
-    }
-    /**
-     * Creates the following form controls:
-     *
-     * * {@link #saveButtonView},
-     * * {@link #cancelButtonView}.
-     */
-    _createActionButtons() {
-        const locale = this.locale;
-        const t = this.t;
-        const saveButtonView = new ButtonView(locale);
-        const cancelButtonView = new ButtonView(locale);
-        const fieldsThatShouldValidateToSave = [
-            this.borderWidthInput,
-            this.borderColorInput,
-            this.backgroundInput,
-            this.widthInput,
-            this.heightInput
-        ];
-        saveButtonView.set({
-            label: t('Save'),
-            icon: IconCheck,
-            class: 'ck-button-save',
-            type: 'submit',
-            withText: true
-        });
-        saveButtonView.bind('isEnabled').toMany(fieldsThatShouldValidateToSave, 'errorText', (...errorTexts) => {
-            return errorTexts.every(errorText => !errorText);
-        });
-        cancelButtonView.set({
-            label: t('Cancel'),
-            icon: IconCancel,
-            class: 'ck-button-cancel',
-            withText: true
-        });
-        cancelButtonView.delegate('execute').to(this, 'cancel');
-        return {
-            saveButtonView, cancelButtonView
-        };
-    }
-    /**
-     * Provides localized labels for {@link #alignmentToolbar} buttons.
-     */
-    get _alignmentLabels() {
-        const locale = this.locale;
-        const t = this.t;
-        const left = t('Align table to the left');
-        const center = t('Center table');
-        const right = t('Align table to the right');
-        // Returns object with a proper order of labels.
-        if (locale.uiLanguageDirection === 'rtl') {
-            return { right, center, left };
-        }
-        else {
-            return { left, center, right };
-        }
-    }
-}
-function isBorderStyleSet(value) {
-    return value !== 'none';
-}