@ckeditor/ckeditor5-template 41.3.0-alpha.4 → 41.3.1

package/dist/types/ui/templatelistbuttonview.d.ts

@@ -1,108 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module template/ui/templatelistbuttonview
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-import { ButtonView, HighlightedTextView, View } from 'ckeditor5/src/ui.js';
-import type { TemplateDefinition } from '../template.js';
-/**
- * A class representing an individual button (template) in the list. Renders a rich preview of the template option.
- *
- * @protected
- */
-export default class TemplateListButtonView extends ButtonView {
-    /**
-     * The definition of the template that the button will apply when executed.
-     *
-     * @readonly
-     */
-    templateDefinition: TemplateDefinition;
-    /**
-     * The view rendering the text part of the template definition.
-     *
-     * @protected
-     * @readonly
-     */
-    textPartView: TextPartView | null;
-    /**
-     * Creates an instance of the {@link module:template/ui/templatelistbuttonview~TemplateListButtonView} class.
-     *
-     * @param locale The localization services instance.
-     * @param templateDefinition The definition of the template.
-     */
-    constructor(locale: Locale, templateDefinition: TemplateDefinition);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    destroy(): void;
-    /**
-     * Tells whether the `title` or `description` of the {@link #templateDefinition} match against the provided regular expression.
-     *
-     * @param regExp A regular expression to match the definition against.
-     * @returns When the match is positive, an object with the `title` and `description` keys is returned that describes
-     * the match. Otherwise, this method returns `null`.
-     */
-    isMatching(regExp: RegExp): object | null;
-    /**
-     * Highlights a subset of the {@link #textPartView} text according to a specified regular expression. When `null` is passed,
-     * the highlighting is turned off.
-     *
-     * @param regExp A regular expression used to highlight the matching text in the {@link #textPartView}.
-     */
-    highlightText(regExp: RegExp | null): void;
-}
-/**
- * A view representing the title and the description of the template.
- *
- * @protected
- */
-export declare class TextPartView extends View {
-    /**
-     * The title text of the template.
-     *
-     * @readonly
-     */
-    title: string;
-    /**
-     * The description text of the template.
-     *
-     * @readonly
-     */
-    description: string | undefined;
-    /**
-     * Renders the title text of a template.
-     *
-     * **Note**: It acts as a label of the entire button in the context of accessibility.
-     *
-     * @readonly
-     */
-    titleView: HighlightedTextView;
-    /**
-     * Renders the description text of a template.
-     *
-     * @readonly
-     */
-    descriptionView: HighlightedTextView;
-    /**
-     * Creates an instance of the text part view.
-     *
-     * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
-     * @param templateDefinition The definition of the template.
-     * @param labelId A unique ID that connects the entire button with the {@link #titleView} in the context of accessibility.
-     */
-    constructor(locale: Locale, templateDefinition: TemplateDefinition, labelId: string);
-    /**
-     * Highlights a subset of the {@link #titleView} and {@link #descriptionView} text according to a specified regular expression.
-     *
-     * @param regExp
-     */
-    highlightText(regExp: RegExp | null): void;
-}

package/dist/types/ui/templatelistitemview.d.ts

@@ -1,38 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module template/ui/templatelistitemview
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-import { ListItemView } from 'ckeditor5/src/ui.js';
-import type TemplateListButtonView from './templatelistbuttonview.js';
-/**
- * A view representing an item in the list of tempaltes.
- *
- * @protected
- */
-export default class TemplateListItemView extends ListItemView {
-    /**
-     * The initial index of the item in the list of templates.
-     * Useful while searching and sorting to reverse the list to the same order.
-     */
-    readonly originalIndex: number;
-    /**
-     * The instance of the template button view containing the title,
-     * icon, and description of the template.
-     */
-    buttonView: TemplateListButtonView | null;
-    /**
-     * Creates an instance of the {@link module:template/ui/templatelistitemview~TemplateListItemView} class.
-     *
-     * @param locale The localization services instance.
-     * @param originalIndex The initial index of the item in the list of templates.
-     */
-    constructor(locale: Locale, originalIndex: number);
-}

package/dist/types/ui/templatelistview.d.ts

@@ -1,42 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module template/ui/templatelistview
- */
-import { ListView, type FilteredView } from 'ckeditor5/src/ui.js';
-/**
- * The template list view class with filtering and sorting.
- *
- * @private
- */
-export default class TemplateListView extends ListView implements FilteredView {
-    /**
-     * Filters the list of templates according to a specified regular expression. The filtered list is sorted so that items that
-     * match the regular expression in their titles are displayed first.
-     *
-     * Matching items highlight the regular expression (query) in their titles and/or descriptions.
-     *
-     * **Note**: The `Collection` (also `ViewCollection`) class does not provide sorting functionality. Thus, the functionality
-     * implemented in this method is **extremely inefficient** because it clones the entire collection, sorts it as an array,
-     * then purges the original collection and sets it from scratch with the sorted array. Purging and resetting the
-     * collection triggers an avalanche of `add` and `remove` events synchronously handled by the `Template` (UI bindings)
-     * and **rendered in the DOM**. As long as sorting takes shorter than rendering of the DOM this should not be noticeable
-     * but the moment it does not, the UI will start glitching. A proper `Collection#sort` is needed to work around
-     * this overhead (see https://github.com/ckeditor/ckeditor5/issues/2065).
-     *
-     * **Note**: Passing `null` to this method resets the list to its original state.
-     *
-     * @param regExp A regular expression used to match the list title and description.
-     * @returns True if some list items matched the regular expression. False otherwise.
-     */
-    filter(regExp: RegExp | null): {
-        resultsCount: number;
-        totalItemsCount: number;
-    };
-}