Interface SearchUiEnterKeyAction

Special interface provided for the product smart.finder to react on the 'Enter' key pressed event of the search-ui input field. It will provide the current text from the input field to another component.

This interface is subject to change and strictly coupled with the requirements of the smart.finder.

Only one action is allowed. It must be registered as a service which provides search-ui.EnterKeyAction.

Hierarchy

  • SearchUiEnterKeyAction

Properties

description?

Methods

reset? trigger

Properties

Optional description

description?: string

A description of the action. Used as tooltip for the lens icon button and its aria-label.

Methods

Optional reset

  • Informs the action that the search-ui was reset.

    Returns void

trigger

  • Triggers the action.

    Parameters

    • searchText: string

      the current searchText shown in the input field.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc