@ckeditor/ckeditor5-ui 36.0.0 → 37.0.0-alpha.0

package/src/dropdown/button/splitbuttonview.d.ts

@@ -0,0 +1,145 @@
+/**
+ * @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/dropdown/button/splitbuttonview
+ */
+import View from '../../view';
+import ButtonView from '../../button/buttonview';
+import type ViewCollection from '../../viewcollection';
+import type Button from '../../button/button';
+import type DropdownButton from './dropdownbutton';
+import { KeystrokeHandler, FocusTracker, type Locale } from '@ckeditor/ckeditor5-utils';
+import '../../../theme/components/dropdown/splitbutton.css';
+/**
+ * The split button view class.
+ *
+ * ```ts
+ * const view = new SplitButtonView();
+ *
+ * view.set( {
+ * 	label: 'A button',
+ * 	keystroke: 'Ctrl+B',
+ * 	tooltip: true
+ * } );
+ *
+ * view.render();
+ *
+ * document.body.append( view.element );
+ * ```
+ *
+ * Also see the {@link module:ui/dropdown/utils~createDropdown `createDropdown()` util}.
+ */
+export default class SplitButtonView extends View<HTMLDivElement> implements DropdownButton {
+    /**
+     * Collection of the child views inside of the split button {@link #element}.
+     */
+    readonly children: ViewCollection;
+    /**
+     * A main button of split button.
+     */
+    readonly actionView: ButtonView;
+    /**
+     * A secondary button of split button that opens dropdown.
+     */
+    readonly arrowView: ButtonView;
+    /**
+     * Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}. It manages
+     * keystrokes of the split button:
+     *
+     * * <kbd>▶</kbd> moves focus to arrow view when action view is focused,
+     * * <kbd>◀</kbd> moves focus to action view when arrow view is focused.
+     */
+    readonly keystrokes: KeystrokeHandler;
+    /**
+     * Tracks information about DOM focus in the dropdown.
+     */
+    readonly focusTracker: FocusTracker;
+    /**
+     * @inheritDoc
+     */
+    label: string | undefined;
+    /**
+     * @inheritDoc
+     */
+    keystroke: string | undefined;
+    /**
+     * @inheritDoc
+     */
+    tooltip: Button['tooltip'];
+    /**
+     * @inheritDoc
+     */
+    tooltipPosition: Button['tooltipPosition'];
+    /**
+     * @inheritDoc
+     */
+    type: Button['type'];
+    /**
+     * @inheritDoc
+     */
+    isOn: boolean;
+    /**
+     * @inheritDoc
+     */
+    isEnabled: boolean;
+    /**
+     * @inheritDoc
+     */
+    isVisible: boolean;
+    /**
+     * @inheritDoc
+     */
+    isToggleable: boolean;
+    /**
+     * @inheritDoc
+     */
+    withText: boolean;
+    /**
+     * @inheritDoc
+     */
+    withKeystroke: boolean;
+    /**
+     * @inheritDoc
+     */
+    icon: string | undefined;
+    /**
+     * @inheritDoc
+     */
+    tabindex: number;
+    /**
+     * @inheritDoc
+     */
+    class: string | undefined;
+    /**
+     * @inheritDoc
+     */
+    labelStyle: string | undefined;
+    /**
+     * @inheritDoc
+     */
+    constructor(locale?: Locale);
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Focuses the {@link #actionView#element} of the action part of split button.
+     */
+    focus(): void;
+    /**
+     * Creates a {@link module:ui/button/buttonview~ButtonView} instance as {@link #actionView} and binds it with main split button
+     * attributes.
+     */
+    private _createActionView;
+    /**
+     * Creates a {@link module:ui/button/buttonview~ButtonView} instance as {@link #arrowView} and binds it with main split button
+     * attributes.
+     */
+    private _createArrowView;
+}

package/src/dropdown/button/splitbuttonview.js

@@ -13,22 +13,21 @@ import '../../../theme/components/dropdown/splitbutton.css';
 /**
  * The split button view class.
  *
- *		const view = new SplitButtonView();
+ * ```ts
+ * const view = new SplitButtonView();
  *
- *		view.set( {
- *			label: 'A button',
- *			keystroke: 'Ctrl+B',
- *			tooltip: true
- *		} );
+ * view.set( {
+ * 	label: 'A button',
+ * 	keystroke: 'Ctrl+B',
+ * 	tooltip: true
+ * } );
  *
- *		view.render();
+ * view.render();
  *
- *		document.body.append( view.element );
+ * document.body.append( view.element );
+ * ```
  *
  * Also see the {@link module:ui/dropdown/utils~createDropdown `createDropdown()` util}.
- *
- * @implements module:ui/dropdown/button/dropdownbutton~DropdownButton
- * @extends module:ui/view~View
  */
 export default class SplitButtonView extends View {
     /**
@@ -53,44 +52,10 @@ export default class SplitButtonView extends View {
         this.set('tooltipPosition', 's');
         this.set('type', 'button');
         this.set('withText', false);
-        /**
-         * Collection of the child views inside of the split button {@link #element}.
-         *
-         * @readonly
-         * @member {module:ui/viewcollection~ViewCollection}
-         */
         this.children = this.createCollection();
-        /**
-         * A main button of split button.
-         *
-         * @readonly
-         * @member {module:ui/button/buttonview~ButtonView}
-         */
         this.actionView = this._createActionView();
-        /**
-         * A secondary button of split button that opens dropdown.
-         *
-         * @readonly
-         * @member {module:ui/button/buttonview~ButtonView}
-         */
         this.arrowView = this._createArrowView();
-        /**
-         * Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}. It manages
-         * keystrokes of the split button:
-         *
-         * * <kbd>▶</kbd> moves focus to arrow view when action view is focused,
-         * * <kbd>◀</kbd> moves focus to action view when arrow view is focused.
-         *
-         * @readonly
-         * @member {module:utils/keystrokehandler~KeystrokeHandler}
-         */
         this.keystrokes = new KeystrokeHandler();
-        /**
-         * Tracks information about DOM focus in the dropdown.
-         *
-         * @readonly
-         * @member {module:utils/focustracker~FocusTracker}
-         */
         this.focusTracker = new FocusTracker();
         this.setTemplate({
             tag: 'div',
@@ -148,9 +113,6 @@ export default class SplitButtonView extends View {
     /**
      * Creates a {@link module:ui/button/buttonview~ButtonView} instance as {@link #actionView} and binds it with main split button
      * attributes.
-     *
-     * @private
-     * @returns {module:ui/button/buttonview~ButtonView}
      */
     _createActionView() {
         const actionView = new ButtonView();
@@ -166,9 +128,6 @@ export default class SplitButtonView extends View {
     /**
      * Creates a {@link module:ui/button/buttonview~ButtonView} instance as {@link #arrowView} and binds it with main split button
      * attributes.
-     *
-     * @private
-     * @returns {module:ui/button/buttonview~ButtonView}
      */
     _createArrowView() {
         const arrowView = new ButtonView();

package/src/dropdown/dropdownpanelfocusable.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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/dropdown/dropdownpanelfocusable
+ */
+/**
+ * The dropdown panel interface for focusable contents. It provides two methods for managing focus of the contents
+ * of dropdown's panel.
+ */
+export default interface DropdownPanelFocusable {
+    /**
+     * Focuses the view element or first item in view collection on opening dropdown's panel.
+     */
+    focus(): void;
+    /**
+     * Focuses the view element or last item in view collection on opening dropdown's panel.
+     */
+    focusLast(): void;
+}

package/src/dropdown/dropdownpanelview.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @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/dropdown/dropdownpanelview
+ */
+import View from '../view';
+import type ViewCollection from '../viewcollection';
+import type DropdownPanelFocusable from './dropdownpanelfocusable';
+import { type Locale } from '@ckeditor/ckeditor5-utils';
+/**
+ * The dropdown panel view class.
+ *
+ * See {@link module:ui/dropdown/dropdownview~DropdownView} to learn about the common usage.
+ */
+export default class DropdownPanelView extends View implements DropdownPanelFocusable {
+    /**
+     * Collection of the child views in this panel.
+     *
+     * A common child type is the {@link module:ui/list/listview~ListView} and {@link module:ui/toolbar/toolbarview~ToolbarView}.
+     * See {@link module:ui/dropdown/utils~addListToDropdown} and
+     * {@link module:ui/dropdown/utils~addToolbarToDropdown} to learn more about child views of dropdowns.
+     */
+    readonly children: ViewCollection;
+    /**
+     * Controls whether the panel is visible.
+     *
+     * @observable
+     */
+    isVisible: boolean;
+    /**
+     * The position of the panel, relative to the parent.
+     *
+     * This property is reflected in the CSS class set to {@link #element} that controls
+     * the position of the panel.
+     *
+     * @observable
+     * @default 'se'
+     */
+    position: PanelPosition;
+    /**
+     * @inheritDoc
+     */
+    constructor(locale?: Locale);
+    /**
+     * Focuses the first view in the {@link #children} collection.
+     *
+     * See also {@link module:ui/dropdown/dropdownpanelfocusable~DropdownPanelFocusable}.
+     */
+    focus(): void;
+    /**
+     * Focuses the view element or last item in view collection on opening dropdown's panel.
+     *
+     * See also {@link module:ui/dropdown/dropdownpanelfocusable~DropdownPanelFocusable}.
+     */
+    focusLast(): void;
+}
+/**
+ * The position of the panel, relative to the parent.
+ */
+export type PanelPosition = 's' | 'se' | 'sw' | 'sme' | 'smw' | 'n' | 'ne' | 'nw' | 'nme' | 'nmw';

package/src/dropdown/dropdownpanelview.js

@@ -11,8 +11,6 @@ import { logWarning } from '@ckeditor/ckeditor5-utils';
  * The dropdown panel view class.
  *
  * See {@link module:ui/dropdown/dropdownview~DropdownView} to learn about the common usage.
- *
- * @extends module:ui/view~View
  */
 export default class DropdownPanelView extends View {
     /**
@@ -21,34 +19,8 @@ export default class DropdownPanelView extends View {
     constructor(locale) {
         super(locale);
         const bind = this.bindTemplate;
-        /**
-         * Controls whether the panel is visible.
-         *
-         * @observable
-         * @member {Boolean} #isVisible
-         */
         this.set('isVisible', false);
-        /**
-         * The position of the panel, relative to the parent.
-         *
-         * This property is reflected in the CSS class set to {@link #element} that controls
-         * the position of the panel.
-         *
-         * @observable
-         * @default 'se'
-         * @member {'s'|'se'|'sw'|'sme'|'smw'|'n'|'ne'|'nw'|'nme'|'nmw'} #position
-         */
         this.set('position', 'se');
-        /**
-         * Collection of the child views in this panel.
-         *
-         * A common child type is the {@link module:ui/list/listview~ListView} and {@link module:ui/toolbar/toolbarview~ToolbarView}.
-         * See {@link module:ui/dropdown/utils~addListToDropdown} and
-         * {@link module:ui/dropdown/utils~addToolbarToDropdown} to learn more about child views of dropdowns.
-         *
-         * @readonly
-         * @member {module:ui/viewcollection~ViewCollection}
-         */
         this.children = this.createCollection();
         this.setTemplate({
             tag: 'div',
@@ -93,8 +65,8 @@ export default class DropdownPanelView extends View {
                  * provides the `focus()` method for the best user experience.
                  *
                  * @error ui-dropdown-panel-focus-child-missing-focus
-                 * @param {module:ui/view~View} childView
-                 * @param {module:ui/dropdown/dropdownpanelview~DropdownPanelView} dropdownPanel
+                 * @param childView
+                 * @param dropdownPanel
                  */
                 logWarning('ui-dropdown-panel-focus-child-missing-focus', { childView: this.children.first, dropdownPanel: this });
             }

package/src/dropdown/dropdownview.d.ts

@@ -0,0 +1,315 @@
+/**
+ * @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/dropdown/dropdownview
+ */
+import View from '../view';
+import type { default as DropdownButton } from './button/dropdownbutton';
+import type { default as DropdownPanelView, PanelPosition } from './dropdownpanelview';
+import type { FocusableView } from '../focuscycler';
+import type ListView from '../list/listview';
+import type ToolbarView from '../toolbar/toolbarview';
+import { KeystrokeHandler, FocusTracker, type Locale, type PositioningFunction } from '@ckeditor/ckeditor5-utils';
+import '../../theme/components/dropdown/dropdown.css';
+/**
+ * The dropdown view class. It manages the dropdown button and dropdown panel.
+ *
+ * In most cases, the easiest way to create a dropdown is by using the {@link module:ui/dropdown/utils~createDropdown}
+ * util:
+ *
+ * ```ts
+ * const dropdown = createDropdown( locale );
+ *
+ * // Configure dropdown's button properties:
+ * dropdown.buttonView.set( {
+ * 	label: 'A dropdown',
+ * 	withText: true
+ * } );
+ *
+ * dropdown.render();
+ *
+ * dropdown.panelView.element.textContent = 'Content of the panel';
+ *
+ * // Will render a dropdown with a panel containing a "Content of the panel" text.
+ * document.body.appendChild( dropdown.element );
+ * ```
+ *
+ * If you want to add a richer content to the dropdown panel, you can use the {@link module:ui/dropdown/utils~addListToDropdown}
+ * and {@link module:ui/dropdown/utils~addToolbarToDropdown} helpers. See more examples in
+ * {@link module:ui/dropdown/utils~createDropdown} documentation.
+ *
+ * If you want to create a completely custom dropdown, then you can compose it manually:
+ *
+ * ```ts
+ * const button = new DropdownButtonView( locale );
+ * const panel = new DropdownPanelView( locale );
+ * const dropdown = new DropdownView( locale, button, panel );
+ *
+ * button.set( {
+ * 	label: 'A dropdown',
+ * 	withText: true
+ * } );
+ *
+ * dropdown.render();
+ *
+ * panel.element.textContent = 'Content of the panel';
+ *
+ * // Will render a dropdown with a panel containing a "Content of the panel" text.
+ * document.body.appendChild( dropdown.element );
+ * ```
+ *
+ * However, dropdown created this way will contain little behavior. You will need to implement handlers for actions
+ * such as {@link module:ui/bindings/clickoutsidehandler~clickOutsideHandler clicking outside an open dropdown}
+ * (which should close it) and support for arrow keys inside the panel. Therefore, unless you really know what
+ * you do and you really need to do it, it is recommended to use the {@link module:ui/dropdown/utils~createDropdown} helper.
+ */
+export default class DropdownView extends View<HTMLDivElement> {
+    /**
+     * Button of the dropdown view. Clicking the button opens the {@link #panelView}.
+     */
+    readonly buttonView: DropdownButton & FocusableView;
+    /**
+     * Panel of the dropdown. It opens when the {@link #buttonView} is
+     * {@link module:ui/button/buttonview~ButtonView#event:execute executed} (i.e. clicked).
+     *
+     * Child views can be added to the panel's `children` collection:
+     *
+     * ```ts
+     * dropdown.panelView.children.add( childView );
+     * ```
+     *
+     * See {@link module:ui/dropdown/dropdownpanelview~DropdownPanelView#children} and
+     * {@link module:ui/viewcollection~ViewCollection#add}.
+     */
+    readonly panelView: DropdownPanelView;
+    /**
+     * Tracks information about the DOM focus in the dropdown.
+     */
+    readonly focusTracker: FocusTracker;
+    /**
+     * Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}. It manages
+     * keystrokes of the dropdown:
+     *
+     * * <kbd>▼</kbd> opens the dropdown,
+     * * <kbd>◀</kbd> and <kbd>Esc</kbd> closes the dropdown.
+     */
+    readonly keystrokes: KeystrokeHandler;
+    /**
+     * A child {@link module:ui/list/listview~ListView list view} of the dropdown located
+     * in its {@link module:ui/dropdown/dropdownview~DropdownView#panelView panel}.
+     *
+     * **Note**: Only supported when dropdown has list view added using {@link module:ui/dropdown/utils~addListToDropdown}.
+     */
+    listView?: ListView;
+    /**
+     * A child toolbar of the dropdown located in the
+     * {@link module:ui/dropdown/dropdownview~DropdownView#panelView panel}.
+     *
+     * **Note**: Only supported when dropdown has list view added using {@link module:ui/dropdown/utils~addToolbarToDropdown}.
+     */
+    toolbarView?: ToolbarView;
+    /**
+     * Controls whether the dropdown view is open, i.e. shows or hides the {@link #panelView panel}.
+     *
+     * **Note**: When the dropdown gets open, it will attempt to call `focus()` on the first child of its {@link #panelView}.
+     * See {@link module:ui/dropdown/utils~addToolbarToDropdown}, {@link module:ui/dropdown/utils~addListToDropdown}, and
+     * {@link module:ui/dropdown/utils~focusChildOnDropdownOpen} to learn more about focus management in dropdowns.
+     *
+     * @observable
+     */
+    isOpen: boolean;
+    /**
+     * Controls whether the dropdown is enabled, i.e. it can be clicked and execute an action.
+     *
+     * See {@link module:ui/button/buttonview~ButtonView#isEnabled}.
+     *
+     * @observable
+     */
+    isEnabled: boolean;
+    /**
+     * (Optional) The additional CSS class set on the dropdown {@link #element}.
+     *
+     * @observable
+     */
+    class: string | undefined;
+    /**
+     * (Optional) The `id` attribute of the dropdown (i.e. to pair with a `<label>` element).
+     *
+     * @observable
+     */
+    id: string | undefined;
+    /**
+     * The position of the panel, relative to the dropdown.
+     *
+     * **Note**: When `'auto'`, the panel will use one of the remaining positions to stay
+     * in the viewport, visible to the user. The positions correspond directly to
+     * {@link module:ui/dropdown/dropdownview~DropdownView.defaultPanelPositions default panel positions}.
+     *
+     * **Note**: This value has an impact on the
+     * {@link module:ui/dropdown/dropdownpanelview~DropdownPanelView#position} property
+     * each time the panel becomes {@link #isOpen open}.
+     *
+     * @observable
+     * @default 'auto'
+     */
+    panelPosition: PanelPosition | 'auto';
+    /**
+     * @observable
+     */
+    ariaDescribedById: string | undefined;
+    /**
+     * Creates an instance of the dropdown.
+     *
+     * Also see {@link #render}.
+     *
+     * @param locale The localization services instance.
+     */
+    constructor(locale: Locale | undefined, buttonView: DropdownButton & FocusableView, panelView: DropdownPanelView);
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+    /**
+     * Focuses the {@link #buttonView}.
+     */
+    focus(): void;
+    /**
+     * Returns {@link #panelView panel} positions to be used by the
+     * {@link module:utils/dom/position~getOptimalPosition `getOptimalPosition()`}
+     * utility considering the direction of the language the UI of the editor is displayed in.
+     */
+    private get _panelPositions();
+    /**
+     * A set of positioning functions used by the dropdown view to determine
+     * the optimal position (i.e. fitting into the browser viewport) of its
+     * {@link module:ui/dropdown/dropdownview~DropdownView#panelView panel} when
+     * {@link module:ui/dropdown/dropdownview~DropdownView#panelPosition} is set to 'auto'`.
+     *
+     * The available positioning functions are as follow:
+     *
+     * **South**
+     *
+     * * `south`
+     *
+     * ```
+     *			[ Button ]
+     *		+-----------------+
+     *		|      Panel      |
+     *		+-----------------+
+     * ```
+     *
+     * * `southEast`
+     *
+     * ```
+     *		[ Button ]
+     *		+-----------------+
+     *		|      Panel      |
+     *		+-----------------+
+     * ```
+     *
+     * * `southWest`
+     *
+     * ```
+     *		         [ Button ]
+     *		+-----------------+
+     *		|      Panel      |
+     *		+-----------------+
+     * ```
+     *
+     * * `southMiddleEast`
+     *
+     * ```
+     *		  [ Button ]
+     *		+-----------------+
+     *		|      Panel      |
+     *		+-----------------+
+     * ```
+     *
+     * * `southMiddleWest`
+     *
+     * ```
+     *		       [ Button ]
+     *		+-----------------+
+     *		|      Panel      |
+     *		+-----------------+
+     * ```
+     *
+     * **North**
+     *
+     * * `north`
+     *
+     * ```
+     *		+-----------------+
+     *		|      Panel      |
+     *		+-----------------+
+     *		    [ Button ]
+     * ```
+     *
+     * * `northEast`
+     *
+     * ```
+     *		+-----------------+
+     *		|      Panel      |
+     *		+-----------------+
+     *		[ Button ]
+     * ```
+     *
+     * * `northWest`
+     *
+     * ```
+     *		+-----------------+
+     *		|      Panel      |
+     *		+-----------------+
+     *		         [ Button ]
+     * ```
+     *
+     * * `northMiddleEast`
+     *
+     * ```
+     *		+-----------------+
+     *		|      Panel      |
+     *		+-----------------+
+     *		  [ Button ]
+     * ```
+     *
+     * * `northMiddleWest`
+     *
+     * ```
+     *		+-----------------+
+     *		|      Panel      |
+     *		+-----------------+
+     *		       [ Button ]
+     * ```
+     *
+     * Positioning functions are compatible with {@link module:utils/dom/position~Position}.
+     *
+     * The name that position function returns will be reflected in dropdown panel's class that
+     * controls its placement. See {@link module:ui/dropdown/dropdownview~DropdownView#panelPosition}
+     * to learn more.
+     */
+    static defaultPanelPositions: Record<string, PositioningFunction>;
+    /**
+     * A function used to calculate the optimal position for the dropdown panel.
+     */
+    private static _getOptimalPosition;
+}
+/**
+ * Fired when the toolbar button or list item is executed.
+ *
+ * For {@link #listView} It fires when a child of some {@link module:ui/list/listitemview~ListItemView}
+ * fired `execute`.
+ *
+ * For {@link #toolbarView} It fires when one of the buttons has been
+ * {@link module:ui/button/buttonview~ButtonView#event:execute executed}.
+ *
+ * **Note**: Only supported when dropdown has list view added using {@link module:ui/dropdown/utils~addListToDropdown}
+ * or {@link module:ui/dropdown/utils~addToolbarToDropdown}.
+ *
+ * @eventName execute
+ */
+export type DropdownViewEvent = {
+    name: 'execute';
+    args: [];
+};