@ckeditor/ckeditor5-ui 40.0.0 → 40.2.0

package/src/list/listseparatorview.d.ts

@@ -1,18 +1,18 @@
-/**
- * @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/list/listseparatorview
- */
-import View from '../view';
-import type { Locale } from '@ckeditor/ckeditor5-utils';
-/**
- * The list separator view class.
- */
-export default class ListSeparatorView extends View {
-    /**
-     * @inheritDoc
-     */
-    constructor(locale?: Locale);
-}
+/**
+ * @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/list/listseparatorview
+ */
+import View from '../view';
+import type { Locale } from '@ckeditor/ckeditor5-utils';
+/**
+ * The list separator view class.
+ */
+export default class ListSeparatorView extends View {
+    /**
+     * @inheritDoc
+     */
+    constructor(locale?: Locale);
+}

package/src/list/listseparatorview.js

@@ -1,28 +1,28 @@
-/**
- * @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/list/listseparatorview
- */
-import View from '../view';
-/**
- * The list separator view class.
- */
-export default class ListSeparatorView extends View {
-    /**
-     * @inheritDoc
-     */
-    constructor(locale) {
-        super(locale);
-        this.setTemplate({
-            tag: 'li',
-            attributes: {
-                class: [
-                    'ck',
-                    'ck-list__separator'
-                ]
-            }
-        });
-    }
-}
+/**
+ * @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/list/listseparatorview
+ */
+import View from '../view';
+/**
+ * The list separator view class.
+ */
+export default class ListSeparatorView extends View {
+    /**
+     * @inheritDoc
+     */
+    constructor(locale) {
+        super(locale);
+        this.setTemplate({
+            tag: 'li',
+            attributes: {
+                class: [
+                    'ck',
+                    'ck-list__separator'
+                ]
+            }
+        });
+    }
+}

package/src/list/listview.d.ts

@@ -1,122 +1,123 @@
-/**
- * @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/list/listview
- */
-import View from '../view';
-import type ListItemView from './listitemview';
-import ListItemGroupView from './listitemgroupview';
-import type DropdownPanelFocusable from '../dropdown/dropdownpanelfocusable';
-import ViewCollection from '../viewcollection';
-import { FocusTracker, KeystrokeHandler, type Locale } from '@ckeditor/ckeditor5-utils';
-import '../../theme/components/list/list.css';
-/**
- * The list view class.
- */
-export default class ListView extends View<HTMLUListElement> implements DropdownPanelFocusable {
-    /**
-     * The collection of focusable views in the list. It is used to determine accessible navigation
-     * between the {@link module:ui/list/listitemview~ListItemView list items} and
-     * {@link module:ui/list/listitemgroupview~ListItemGroupView list groups}.
-     */
-    readonly focusables: ViewCollection;
-    /**
-     * Collection of the child list views.
-     */
-    readonly items: ViewCollection<ListItemView | ListItemGroupView>;
-    /**
-     * Tracks information about DOM focus in the list.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Label used by assistive technologies to describe this list element.
-     *
-     * @observable
-     */
-    ariaLabel: string | undefined;
-    /**
-     * (Optional) The ARIA property reflected by the `aria-ariaLabelledBy` DOM attribute used by assistive technologies.
-     *
-     * @observable
-     */
-    ariaLabelledBy?: string | undefined;
-    /**
-     * The property reflected by the `role` DOM attribute to be used by assistive technologies.
-     *
-     * @observable
-     */
-    role: string | undefined;
-    /**
-     * Helps cycling over focusable {@link #items} in the list.
-     */
-    private readonly _focusCycler;
-    /**
-     * A cached map of {@link module:ui/list/listitemgroupview~ListItemGroupView} to `change` event listeners for their `items`.
-     * Used for accessibility and keyboard navigation purposes.
-     */
-    private readonly _listItemGroupToChangeListeners;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale?: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Focuses the first focusable in {@link #items}.
-     */
-    focus(): void;
-    /**
-     * Focuses the first focusable in {@link #items}.
-     */
-    focusFirst(): void;
-    /**
-     * Focuses the last focusable in {@link #items}.
-     */
-    focusLast(): void;
-    /**
-     * Registers a list item view in the focus tracker.
-     *
-     * @param item The list item view to be registered.
-     * @param index Index of the list item view in the {@link #items} collection. If not specified, the item will be added at the end.
-     */
-    private _registerFocusableListItem;
-    /**
-     * Removes a list item view from the focus tracker.
-     *
-     * @param item The list item view to be removed.
-     */
-    private _deregisterFocusableListItem;
-    /**
-     * Gets a callback that will be called when the `items` collection of a {@link module:ui/list/listitemgroupview~ListItemGroupView}
-     * change.
-     *
-     * @param groupView The group view for which the callback will be created.
-     * @returns The callback function to be used for the items `change` event listener in a group.
-     */
-    private _getOnGroupItemsChangeCallback;
-    /**
-     * Registers a list item group view (and its children) in the focus tracker.
-     *
-     * @param groupView A group view to be registered.
-     * @param groupIndex Index of the group view in the {@link #items} collection. If not specified, the group will be added at the end.
-     */
-    private _registerFocusableItemsGroup;
-    /**
-     * Removes a list item group view (and its children) from the focus tracker.
-     *
-     * @param groupView The group view to be removed.
-     */
-    private _deregisterFocusableItemsGroup;
-}
+/**
+ * @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/list/listview
+ */
+import View from '../view';
+import ListItemView from './listitemview';
+import ListItemGroupView from './listitemgroupview';
+import type ListSeparatorView from './listseparatorview';
+import type DropdownPanelFocusable from '../dropdown/dropdownpanelfocusable';
+import ViewCollection from '../viewcollection';
+import { FocusTracker, KeystrokeHandler, type Locale } from '@ckeditor/ckeditor5-utils';
+import '../../theme/components/list/list.css';
+/**
+ * The list view class.
+ */
+export default class ListView extends View<HTMLUListElement> implements DropdownPanelFocusable {
+    /**
+     * The collection of focusable views in the list. It is used to determine accessible navigation
+     * between the {@link module:ui/list/listitemview~ListItemView list items} and
+     * {@link module:ui/list/listitemgroupview~ListItemGroupView list groups}.
+     */
+    readonly focusables: ViewCollection;
+    /**
+     * Collection of the child list views.
+     */
+    readonly items: ViewCollection<ListItemView | ListItemGroupView | ListSeparatorView>;
+    /**
+     * Tracks information about DOM focus in the list.
+     */
+    readonly focusTracker: FocusTracker;
+    /**
+     * Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+     */
+    readonly keystrokes: KeystrokeHandler;
+    /**
+     * Label used by assistive technologies to describe this list element.
+     *
+     * @observable
+     */
+    ariaLabel: string | undefined;
+    /**
+     * (Optional) The ARIA property reflected by the `aria-ariaLabelledBy` DOM attribute used by assistive technologies.
+     *
+     * @observable
+     */
+    ariaLabelledBy?: string | undefined;
+    /**
+     * The property reflected by the `role` DOM attribute to be used by assistive technologies.
+     *
+     * @observable
+     */
+    role: string | undefined;
+    /**
+     * Helps cycling over focusable {@link #items} in the list.
+     */
+    private readonly _focusCycler;
+    /**
+     * A cached map of {@link module:ui/list/listitemgroupview~ListItemGroupView} to `change` event listeners for their `items`.
+     * Used for accessibility and keyboard navigation purposes.
+     */
+    private readonly _listItemGroupToChangeListeners;
+    /**
+     * @inheritDoc
+     */
+    constructor(locale?: Locale);
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Focuses the first focusable in {@link #items}.
+     */
+    focus(): void;
+    /**
+     * Focuses the first focusable in {@link #items}.
+     */
+    focusFirst(): void;
+    /**
+     * Focuses the last focusable in {@link #items}.
+     */
+    focusLast(): void;
+    /**
+     * Registers a list item view in the focus tracker.
+     *
+     * @param item The list item view to be registered.
+     * @param index Index of the list item view in the {@link #items} collection. If not specified, the item will be added at the end.
+     */
+    private _registerFocusableListItem;
+    /**
+     * Removes a list item view from the focus tracker.
+     *
+     * @param item The list item view to be removed.
+     */
+    private _deregisterFocusableListItem;
+    /**
+     * Gets a callback that will be called when the `items` collection of a {@link module:ui/list/listitemgroupview~ListItemGroupView}
+     * change.
+     *
+     * @param groupView The group view for which the callback will be created.
+     * @returns The callback function to be used for the items `change` event listener in a group.
+     */
+    private _getOnGroupItemsChangeCallback;
+    /**
+     * Registers a list item group view (and its children) in the focus tracker.
+     *
+     * @param groupView A group view to be registered.
+     * @param groupIndex Index of the group view in the {@link #items} collection. If not specified, the group will be added at the end.
+     */
+    private _registerFocusableItemsGroup;
+    /**
+     * Removes a list item group view (and its children) from the focus tracker.
+     *
+     * @param groupView The group view to be removed.
+     */
+    private _deregisterFocusableItemsGroup;
+}