import { KeyboardEventArgs } from '@syncfusion/ej2-base'; import { EmitType } from '@syncfusion/ej2-base'; import { FieldSettingsModel } from '../drop-down-base/drop-down-base-model'; import { FilteringEventArgs, FilterType } from '../drop-down-base/drop-down-base'; import { DropDownBase, PopupEventArgs, SelectEventArgs } from '../drop-down-base/drop-down-base'; import { DataManager, Query } from '@syncfusion/ej2-data'; import { MentionModel } from '../mention/mention-model'; import { SortOrder } from '@syncfusion/ej2-lists'; export interface MentionChangeEventArgs extends SelectEventArgs { /** * Specifies the selected value. * * @isGenericType true */ value: number | string | boolean; /** * Specifies the element of previous selected list item. */ previousItem: HTMLLIElement; /** * Specifies the previously selected item as a JSON Object from the data source. * */ previousItemData: FieldSettingsModel; /** * Specifies the component root element. */ element: HTMLElement; } /** * The Mention component is used to list someone or something based on user input in textarea, input, * or any other editable element from which the user can select. */ export declare class Mention extends DropDownBase { private initRemoteRender; private inputElement; private popupObj; private isPopupOpen; private isSelected; private selectedLI; private previousSelectedLI; private previousItemData; private activeIndex; private isFiltered; private beforePopupOpen; private listHeight; private isListResetted; private range; private displayTempElement; private isCollided; private collision; private spinnerElement; private spinnerTemplateElement; private lineBreak; private selectedElementID; private isSelectCancel; private isTyped; private didPopupOpenByTypingInitialChar; private isUpDownKey; private isRTE; private keyEventName; private keyupHandler; private keydownHandler; private popupAppendTo; /** * Defines class/multiple classes separated by a space for the mention component. * * @default null */ cssClass: string; /** * Specifies the symbol or single character which triggers the search action in the mention component. * * @default '@' * @aspType char */ mentionChar: string; /** * Specifies whether to show the configured mentionChar with the text. * * @default false */ showMentionChar: boolean; /** * Defines whether to allow the space in the middle of mention while searching. * When disabled, the space ends the mention component search. * * @default false */ allowSpaces: boolean; /** * Specifies the custom suffix to append along with the mention component selected item while inserting. * You can append space or new line character as suffix. * * @default null */ suffixText: string; /** * Specifies the number of items in the suggestion list. * * @default 25 * @aspType int */ suggestionCount: number; /** * Specifies the minimum length of user input to initiate the search action. * The default value is zero, where suggestion the list opened as soon as the user inputs the mention character. * * @default 0 * @aspType int */ minLength: number; /** * Specifies the order to sort the data source. The possible sort orders are, * * `None` - The data source is not sorted. * * `Ascending` - The data source is sorted in ascending order. * * `Descending` - The data source is sorted in descending order. * * @default 'None' */ sortOrder: SortOrder; /** * Specifies whether the searches are case sensitive to find suggestions. * * @default true */ ignoreCase: boolean; /** * Specifies whether a space is required before the mention character to trigger the suggestion list. * When set to false, the suggestion list will be triggered even without a space before the mention character. * * @default true */ requireLeadingSpace: boolean; /** * Specifies whether to highlight the searched characters on suggestion list items. * * @default false */ highlight: boolean; /** * Overrides the global culture and localization value for this component. Default global culture is ‘en-US’. * * @default 'en-US' */ locale: string; /** * Specifies the width of the popup in pixels/number/percentage. The number value is considered as pixels. * * @default 'auto' * @aspType string */ popupWidth: string | number; /** * Specifies the height of the popup in pixels/number/percentage. The number value is considered as pixels. * * @default '300px' * @aspType string */ popupHeight: string | number; /** * Specifies the delay time in milliseconds for filtering operations. * * @default 300 */ debounceDelay: number; /** * Specifies the template for the selected value from the suggestion list. * * @default null * @aspType string */ displayTemplate: string | Function; /** * Specifies the template for the suggestion list. * * @default null */ itemTemplate: string; /** * Specifies the template for no matched item which is displayed when there are no items to display in the suggestion list. * * @default 'No records found' */ noRecordsTemplate: string; /** * Specifies the template for showing until data is loaded in the popup. * * @default null * @aspType string */ spinnerTemplate: string | Function; /** * Specifies the target selector where the mention component needs to be displayed. * The mention component listens to the target's user input and displays suggestions as soon as the user inputs the mention character. * */ target: HTMLElement | string; /** * Accepts the list items either through local or remote service and binds it to the component. * It can be an array of JSON Objects or an instance of `DataManager`. * * @default [] */ dataSource: { [key: string]: Object; }[] | DataManager | string[] | number[] | boolean[]; /** * Specifies the external query, which can be customized and filtered against the data source. * * @default null */ query: Query; /** * Determines on which filter type, the component needs to be considered on search action. * and its supported data types are * *
|
* FilterType |
* Description |
* Supported Types |
|
* StartsWith |
* Checks whether a value begins with the specified value. |
* String |
|
* EndsWith |
* Checks whether a value ends with a specified value. |
* String |
|
* Contains |
* Checks whether a value contains with a specified value. |
* String |