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
  });
  ...

interface SearchUiService {
    on<Name extends "reset">(
        name: Name,
        callBack: EventCallback<SearchUiServiceEvents[Name]>,
    ): Handle;
    reset(options?: { searchText?: string }): void;
}

Hierarchy

EventSource<SearchUiServiceEvents>
- SearchUiService

Index

Methods

on reset

Methods

on

on<Name extends "reset">(
name: Name,
callBack: EventCallback<SearchUiServiceEvents[Name]>,
): Handle
Registers event listener.
Type Parameters
- Name extends "reset"
Parameters
- name: Name
- callBack: EventCallback<SearchUiServiceEvents[Name]>
Returns Handle
Inherited from EventSource.on
- Defined in apprt/apprt-core/Types.ts:85

reset

reset(options?: { searchText?: string }): void
Resets the UI. Optionally accepts a text to be displayed in the search field.
Parameters
- Optionaloptions: { searchText?: string }
Returns void
- Defined in search/search-ui/api.ts:53

Interface SearchUiService

Example: Reset the search

Example: Listen for reset event of the search ui

Hierarchy

Index

Methods

Methods

on

Type Parameters

Parameters

Returns Handle

reset

Parameters

Returns void

Settings

On This Page