@ckeditor/ckeditor5-ui 39.0.1 → 40.0.0

package/src/index.js

@@ -1,62 +1,70 @@
-/**
- * @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
- */
-export { default as clickOutsideHandler } from './bindings/clickoutsidehandler';
-export { default as injectCssTransitionDisabler } from './bindings/injectcsstransitiondisabler';
-export { default as CssTransitionDisablerMixin } from './bindings/csstransitiondisablermixin';
-export { default as submitHandler } from './bindings/submithandler';
-export { default as addKeyboardHandlingForGrid } from './bindings/addkeyboardhandlingforgrid';
-export { default as BodyCollection } from './editorui/bodycollection';
-export { default as ButtonView } from './button/buttonview';
-export { default as SwitchButtonView } from './button/switchbuttonview';
-export * from './colorgrid/utils';
-export { default as ColorGridView } from './colorgrid/colorgridview';
-export { default as ColorTileView } from './colorgrid/colortileview';
-export { default as ColorPickerView } from './colorpicker/colorpickerview';
-export { default as ColorSelectorView } from './colorselector/colorselectorview';
-export { default as ComponentFactory } from './componentfactory';
-export { default as DropdownView } from './dropdown/dropdownview';
-export { default as DropdownPanelView } from './dropdown/dropdownpanelview';
-export { default as DropdownButtonView } from './dropdown/button/dropdownbuttonview';
-export { default as SplitButtonView } from './dropdown/button/splitbuttonview';
-export * from './dropdown/utils';
-export { default as EditorUI } from './editorui/editorui';
-export { default as EditorUIView } from './editorui/editoruiview';
-export { default as BoxedEditorUIView } from './editorui/boxed/boxededitoruiview';
-export { default as InlineEditableUIView } from './editableui/inline/inlineeditableuiview';
-export { default as FormHeaderView } from './formheader/formheaderview';
-export { default as FocusCycler } from './focuscycler';
-export { default as IconView } from './icon/iconview';
-export { default as InputView } from './input/inputview';
-export { default as InputTextView } from './inputtext/inputtextview';
-export { default as InputNumberView } from './inputnumber/inputnumberview';
-export { default as IframeView } from './iframe/iframeview';
-export { default as LabelView } from './label/labelview';
-export { default as LabeledFieldView } from './labeledfield/labeledfieldview';
-export * from './labeledfield/utils';
-export { default as ListItemView } from './list/listitemview';
-export { default as ListView } from './list/listview';
-export { default as Notification } from './notification/notification';
-export { default as Model } from './model';
-export { default as BalloonPanelView } from './panel/balloon/balloonpanelview';
-export { default as ContextualBalloon } from './panel/balloon/contextualballoon';
-export { default as StickyPanelView } from './panel/sticky/stickypanelview';
-export { default as TooltipManager } from './tooltipmanager';
-export { default as Template } from './template';
-export { default as ToolbarView } from './toolbar/toolbarview';
-export { default as ToolbarLineBreakView } from './toolbar/toolbarlinebreakview';
-export { default as ToolbarSeparatorView } from './toolbar/toolbarseparatorview';
-export { default as normalizeToolbarConfig } from './toolbar/normalizetoolbarconfig';
-export { default as BalloonToolbar } from './toolbar/balloon/balloontoolbar';
-export { default as BlockToolbar } from './toolbar/block/blocktoolbar';
-export { default as View } from './view';
-export { default as ViewCollection } from './viewcollection';
-import { default as colorPaletteIcon } from '../theme/icons/color-palette.svg';
-export const icons = {
-    colorPaletteIcon
-};
-import './augmentation';
+/**
+ * @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
+ */
+export { default as clickOutsideHandler } from './bindings/clickoutsidehandler';
+export { default as injectCssTransitionDisabler } from './bindings/injectcsstransitiondisabler';
+export { default as CssTransitionDisablerMixin } from './bindings/csstransitiondisablermixin';
+export { default as submitHandler } from './bindings/submithandler';
+export { default as addKeyboardHandlingForGrid } from './bindings/addkeyboardhandlingforgrid';
+export { default as BodyCollection } from './editorui/bodycollection';
+export { default as ButtonView } from './button/buttonview';
+export { default as ButtonLabelView } from './button/buttonlabelview';
+export { default as SwitchButtonView } from './button/switchbuttonview';
+export * from './colorgrid/utils';
+export { default as ColorGridView } from './colorgrid/colorgridview';
+export { default as ColorTileView } from './colorgrid/colortileview';
+export { default as ColorPickerView } from './colorpicker/colorpickerview';
+export { default as ColorSelectorView } from './colorselector/colorselectorview';
+export { default as ComponentFactory } from './componentfactory';
+export { default as DropdownView } from './dropdown/dropdownview';
+export { default as DropdownPanelView } from './dropdown/dropdownpanelview';
+export { default as DropdownButtonView } from './dropdown/button/dropdownbuttonview';
+export { default as SplitButtonView } from './dropdown/button/splitbuttonview';
+export * from './dropdown/utils';
+export { default as EditorUI } from './editorui/editorui';
+export { default as EditorUIView } from './editorui/editoruiview';
+export { default as BoxedEditorUIView } from './editorui/boxed/boxededitoruiview';
+export { default as InlineEditableUIView } from './editableui/inline/inlineeditableuiview';
+export { default as FormHeaderView } from './formheader/formheaderview';
+export { default as FocusCycler } from './focuscycler';
+export { default as IconView } from './icon/iconview';
+export { default as InputView } from './input/inputview';
+export { default as InputTextView } from './inputtext/inputtextview';
+export { default as InputNumberView } from './inputnumber/inputnumberview';
+export { default as TextareaView } from './textarea/textareaview';
+export { default as IframeView } from './iframe/iframeview';
+export { default as LabelView } from './label/labelview';
+export { default as LabeledFieldView } from './labeledfield/labeledfieldview';
+export * from './labeledfield/utils';
+export { default as ListItemGroupView } from './list/listitemgroupview';
+export { default as ListItemView } from './list/listitemview';
+export { default as ListView } from './list/listview';
+export { default as Notification } from './notification/notification';
+export { default as Model } from './model';
+export { default as BalloonPanelView } from './panel/balloon/balloonpanelview';
+export { default as ContextualBalloon } from './panel/balloon/contextualballoon';
+export { default as StickyPanelView } from './panel/sticky/stickypanelview';
+export { default as AutocompleteView } from './autocomplete/autocompleteview';
+export { default as SearchTextView } from './search/text/searchtextview';
+export { default as SearchInfoView } from './search/searchinfoview';
+export { default as HighlightedTextView } from './highlightedtext/highlightedtextview';
+export { default as TooltipManager } from './tooltipmanager';
+export { default as Template } from './template';
+export { default as SpinnerView } from './spinner/spinnerview';
+export { default as ToolbarView } from './toolbar/toolbarview';
+export { default as ToolbarLineBreakView } from './toolbar/toolbarlinebreakview';
+export { default as ToolbarSeparatorView } from './toolbar/toolbarseparatorview';
+export { default as normalizeToolbarConfig } from './toolbar/normalizetoolbarconfig';
+export { default as BalloonToolbar } from './toolbar/balloon/balloontoolbar';
+export { default as BlockToolbar } from './toolbar/block/blocktoolbar';
+export { default as View } from './view';
+export { default as ViewCollection } from './viewcollection';
+import { default as colorPaletteIcon } from '../theme/icons/color-palette.svg';
+export const icons = {
+    colorPaletteIcon
+};
+import './augmentation';

package/src/input/inputbase.d.ts

@@ -0,0 +1,107 @@
+/**
+ * @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/input/inputbase
+ */
+import View from '../view';
+import { FocusTracker, type Locale } from '@ckeditor/ckeditor5-utils';
+/**
+ * The base input view class.
+ */
+export default abstract class InputBase<TElement extends HTMLInputElement | HTMLTextAreaElement = HTMLInputElement> extends View<TElement> {
+    /**
+     * Stores information about the editor UI focus and propagates it so various plugins and components
+     * are unified as a focus group.
+     */
+    readonly focusTracker: FocusTracker;
+    /**
+     * The value of the input.
+     *
+     * @observable
+     */
+    value: string | undefined;
+    /**
+     * The `id` attribute of the input (i.e. to pair with a `<label>` element).
+     *
+     * @observable
+     */
+    id: string | undefined;
+    /**
+     * The `placeholder` attribute of the input.
+     *
+     * @observable
+     */
+    placeholder: string | undefined;
+    /**
+     * Controls whether the input view is in read-only mode.
+     *
+     * @observable
+     */
+    isReadOnly: boolean;
+    /**
+     * Set to `true` when the field has some error. Usually controlled via
+     * {@link module:ui/labeledinput/labeledinputview~LabeledInputView#errorText}.
+     *
+     * @observable
+     */
+    hasError: boolean;
+    /**
+     * The `id` of the element describing this field, e.g. when it has
+     * some error; it helps screen readers read the error text.
+     *
+     * @observable
+     */
+    ariaDescribedById: string | undefined;
+    /**
+     * An observable flag set to `true` when the input is currently focused by the user.
+     * Set to `false` otherwise.
+     *
+     * @readonly
+     * @observable
+     * @default false
+     */
+    isFocused: boolean;
+    /**
+     * An observable flag set to `true` when the input contains no text, i.e.
+     * when {@link #value} is `''`, `null`, or `false`.
+     *
+     * @readonly
+     * @observable
+     * @default true
+     */
+    isEmpty: boolean;
+    /**
+     * @inheritDoc
+     */
+    constructor(locale?: Locale);
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Moves the focus to the input and selects the value.
+     */
+    select(): void;
+    /**
+     * Focuses the input.
+     */
+    focus(): void;
+    /**
+     * Resets the value of the input
+     */
+    reset(): void;
+    /**
+     * Updates the {@link #isEmpty} property value on demand.
+     */
+    protected _updateIsEmpty(): void;
+    /**
+     * Sets the `value` property of the {@link #element DOM element} on demand.
+     */
+    private _setDomElementValue;
+}

package/src/input/inputbase.js

@@ -0,0 +1,110 @@
+/**
+ * @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/input/inputbase
+ */
+import View from '../view';
+import { FocusTracker } from '@ckeditor/ckeditor5-utils';
+/**
+ * The base input view class.
+ */
+export default class InputBase extends View {
+    /**
+     * @inheritDoc
+     */
+    constructor(locale) {
+        super(locale);
+        this.set('value', undefined);
+        this.set('id', undefined);
+        this.set('placeholder', undefined);
+        this.set('isReadOnly', false);
+        this.set('hasError', false);
+        this.set('ariaDescribedById', undefined);
+        this.focusTracker = new FocusTracker();
+        this.bind('isFocused').to(this.focusTracker);
+        this.set('isEmpty', true);
+        const bind = this.bindTemplate;
+        this.setTemplate({
+            tag: 'input',
+            attributes: {
+                class: [
+                    'ck',
+                    'ck-input',
+                    bind.if('isFocused', 'ck-input_focused'),
+                    bind.if('isEmpty', 'ck-input-text_empty'),
+                    bind.if('hasError', 'ck-error')
+                ],
+                id: bind.to('id'),
+                placeholder: bind.to('placeholder'),
+                readonly: bind.to('isReadOnly'),
+                'aria-invalid': bind.if('hasError', true),
+                'aria-describedby': bind.to('ariaDescribedById')
+            },
+            on: {
+                input: bind.to((...args) => {
+                    this.fire('input', ...args);
+                    this._updateIsEmpty();
+                }),
+                change: bind.to(this._updateIsEmpty.bind(this))
+            }
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    render() {
+        super.render();
+        this.focusTracker.add(this.element);
+        this._setDomElementValue(this.value);
+        this._updateIsEmpty();
+        // Bind `this.value` to the DOM element's value.
+        // We cannot use `value` DOM attribute because removing it on Edge does not clear the DOM element's value property.
+        this.on('change:value', (evt, name, value) => {
+            this._setDomElementValue(value);
+            this._updateIsEmpty();
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    destroy() {
+        super.destroy();
+        this.focusTracker.destroy();
+    }
+    /**
+     * Moves the focus to the input and selects the value.
+     */
+    select() {
+        this.element.select();
+    }
+    /**
+     * Focuses the input.
+     */
+    focus() {
+        this.element.focus();
+    }
+    /**
+     * Resets the value of the input
+     */
+    reset() {
+        this.value = this.element.value = '';
+        this._updateIsEmpty();
+    }
+    /**
+     * Updates the {@link #isEmpty} property value on demand.
+     */
+    _updateIsEmpty() {
+        this.isEmpty = isInputElementEmpty(this.element);
+    }
+    /**
+     * Sets the `value` property of the {@link #element DOM element} on demand.
+     */
+    _setDomElementValue(value) {
+        this.element.value = (!value && value !== 0) ? '' : value;
+    }
+}
+function isInputElementEmpty(domElement) {
+    return !domElement.value;
+}

package/src/input/inputview.d.ts

@@ -1,121 +1,36 @@
-/**
- * @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/input/inputview
- */
-import View from '../view';
-import { FocusTracker, type Locale } from '@ckeditor/ckeditor5-utils';
-import '../../theme/components/input/input.css';
-/**
- * The base input view class.
- */
-export default class InputView extends View<HTMLInputElement> {
-    /**
-     * Stores information about the editor UI focus and propagates it so various plugins and components
-     * are unified as a focus group.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * The value of the input.
-     *
-     * @observable
-     */
-    value: string | undefined;
-    /**
-     * The `id` attribute of the input (i.e. to pair with a `<label>` element).
-     *
-     * @observable
-     */
-    id: string | undefined;
-    /**
-     * The `placeholder` attribute of the input.
-     *
-     * @observable
-     */
-    placeholder: string | undefined;
-    /**
-     * Controls whether the input view is in read-only mode.
-     *
-     * @observable
-     */
-    isReadOnly: boolean;
-    /**
-     * Set to `true` when the field has some error. Usually controlled via
-     * {@link module:ui/labeledinput/labeledinputview~LabeledInputView#errorText}.
-     *
-     * @observable
-     */
-    hasError: boolean;
-    /**
-     * The `id` of the element describing this field, e.g. when it has
-     * some error; it helps screen readers read the error text.
-     *
-     * @observable
-     */
-    ariaDescribedById: string | undefined;
-    /**
-     * An observable flag set to `true` when the input is currently focused by the user.
-     * Set to `false` otherwise.
-     *
-     * @readonly
-     * @observable
-     * @default false
-     */
-    isFocused: boolean;
-    /**
-     * An observable flag set to `true` when the input contains no text, i.e.
-     * when {@link #value} is `''`, `null`, or `false`.
-     *
-     * @readonly
-     * @observable
-     * @default true
-     */
-    isEmpty: boolean;
-    /**
-     * Corresponds to the `inputmode` DOM attribute. Can be `text`, `numeric`, `decimal`, etc.
-     *
-     * @observable
-     * @default 'text'
-     */
-    inputMode: string;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale?: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Moves the focus to the input and selects the value.
-     */
-    select(): void;
-    /**
-     * Focuses the input.
-     */
-    focus(): void;
-    /**
-     * Updates the {@link #isEmpty} property value on demand.
-     */
-    private _updateIsEmpty;
-    /**
-     * Sets the `value` property of the {@link #element DOM element} on demand.
-     */
-    private _setDomElementValue;
-}
-/**
- * Fired when the user types in the input. Corresponds to the native
- * DOM `input` event.
- *
- * @eventName ~InputView#input
- */
-export type InputViewInputEvent = {
-    name: 'input';
-    args: [InputEvent];
-};
+/**
+ * @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/input/inputview
+ */
+import { type Locale } from '@ckeditor/ckeditor5-utils';
+import InputBase from './inputbase';
+import '../../theme/components/input/input.css';
+/**
+ * The input view class.
+ */
+export default class InputView extends InputBase {
+    /**
+     * Corresponds to the `inputmode` DOM attribute. Can be `text`, `numeric`, `decimal`, etc.
+     *
+     * @observable
+     * @default 'text'
+     */
+    inputMode: string;
+    /**
+     * @inheritDoc
+     */
+    constructor(locale?: Locale);
+}
+/**
+ * Fired when the user types in the input. Corresponds to the native
+ * DOM `input` event.
+ *
+ * @eventName ~InputView#input
+ */
+export type InputViewInputEvent = {
+    name: 'input';
+    args: [InputEvent];
+};

package/src/input/inputview.js

@@ -1,106 +1,24 @@
-/**
- * @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/input/inputview
- */
-import View from '../view';
-import { FocusTracker } from '@ckeditor/ckeditor5-utils';
-import '../../theme/components/input/input.css';
-/**
- * The base input view class.
- */
-export default class InputView extends View {
-    /**
-     * @inheritDoc
-     */
-    constructor(locale) {
-        super(locale);
-        this.set('value', undefined);
-        this.set('id', undefined);
-        this.set('placeholder', undefined);
-        this.set('isReadOnly', false);
-        this.set('hasError', false);
-        this.set('ariaDescribedById', undefined);
-        this.focusTracker = new FocusTracker();
-        this.bind('isFocused').to(this.focusTracker);
-        this.set('isEmpty', true);
-        this.set('inputMode', 'text');
-        const bind = this.bindTemplate;
-        this.setTemplate({
-            tag: 'input',
-            attributes: {
-                class: [
-                    'ck',
-                    'ck-input',
-                    bind.if('isFocused', 'ck-input_focused'),
-                    bind.if('isEmpty', 'ck-input-text_empty'),
-                    bind.if('hasError', 'ck-error')
-                ],
-                id: bind.to('id'),
-                placeholder: bind.to('placeholder'),
-                readonly: bind.to('isReadOnly'),
-                inputmode: bind.to('inputMode'),
-                'aria-invalid': bind.if('hasError', true),
-                'aria-describedby': bind.to('ariaDescribedById')
-            },
-            on: {
-                input: bind.to((...args) => {
-                    this.fire('input', ...args);
-                    this._updateIsEmpty();
-                }),
-                change: bind.to(this._updateIsEmpty.bind(this))
-            }
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    render() {
-        super.render();
-        this.focusTracker.add(this.element);
-        this._setDomElementValue(this.value);
-        this._updateIsEmpty();
-        // Bind `this.value` to the DOM element's value.
-        // We cannot use `value` DOM attribute because removing it on Edge does not clear the DOM element's value property.
-        this.on('change:value', (evt, name, value) => {
-            this._setDomElementValue(value);
-            this._updateIsEmpty();
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    destroy() {
-        super.destroy();
-        this.focusTracker.destroy();
-    }
-    /**
-     * Moves the focus to the input and selects the value.
-     */
-    select() {
-        this.element.select();
-    }
-    /**
-     * Focuses the input.
-     */
-    focus() {
-        this.element.focus();
-    }
-    /**
-     * Updates the {@link #isEmpty} property value on demand.
-     */
-    _updateIsEmpty() {
-        this.isEmpty = isInputElementEmpty(this.element);
-    }
-    /**
-     * Sets the `value` property of the {@link #element DOM element} on demand.
-     */
-    _setDomElementValue(value) {
-        this.element.value = (!value && value !== 0) ? '' : value;
-    }
-}
-function isInputElementEmpty(domElement) {
-    return !domElement.value;
-}
+/**
+ * @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
+ */
+import InputBase from './inputbase';
+import '../../theme/components/input/input.css';
+/**
+ * The input view class.
+ */
+export default class InputView extends InputBase {
+    /**
+     * @inheritDoc
+     */
+    constructor(locale) {
+        super(locale);
+        this.set('inputMode', 'text');
+        const bind = this.bindTemplate;
+        this.extendTemplate({
+            attributes: {
+                inputmode: bind.to('inputMode')
+            }
+        });
+    }
+}