Interface SearchUiService

Provides methods to control the search-ui. The service can be referenced via search-ui.SearchUiService.

Example

Reset the search

  const service = this.searchUiService; // injected
service.reset();
// or
service.reset({searchText: "My text"});
...

Example

Listen for reset event of the search ui

  const service = this.searchUiService; // injected
service.on("reset", ()=>{
// react to the reset of the search ui
});
...

Hierarchy

Methods

Methods

  • Registers event listener.

    Type Parameters

    • Name extends "reset"

    Parameters

    Returns Handle

  • Resets the UI. Optionally accepts a text to be displayed in the search field.

    Parameters

    • Optional options: {
          searchText?: string;
      }
      • Optional searchText?: string

    Returns void

Generated using TypeDoc