SearchEventMap Interface
SearchEventMap is an interface used to provide type-safe event listeners and is not instantiated or used directly. It maps event names to their corresponding event object types and is consumed by addEventListener to ensure correct typing of listener callbacks.
export declare interface SearchEventMap
Remarks
This interface defines the types of events that can be emitted during search operations, including when a search starts, is cancelled, or completes.
Fields
searchStarting
Event emitted when a search operation is starting.
searchStarting: SearchStartingEvent;
Field Value
Remarks
This event is fired before the actual search begins, allowing listeners to cancel or modify the search operation. The event contains the query text that will be searched for.
searchCancelled
Event emitted when a search operation is cancelled.
searchCancelled: SearchCancelledEvent;
Field Value
Remarks
This event is fired when an active search is cancelled, either by the user or programmatically. It indicates that no search results are currently available.
searchCompleted
Event emitted when a search operation completes.
searchCompleted: SearchCompletedEvent;
Field Value
Remarks
This event is fired after a search operation finishes, containing information about the search results including the query text, current match position, and total matches found.