map.apps Bundle APIs 4.20.0
    Preparing search index...

    Interface SearchUiEnterKeyAction

    Interface 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.

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

    interface SearchUiEnterKeyAction {
        description?: string;
        reset(): void;
        trigger(searchText: string): void;
    }
    Index

    Properties

    description?

    Methods

    reset? trigger

    Properties

    description?: string

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

    Methods

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

      Returns void

    • Triggers the action.

      Parameters

      • searchText: string

        the current searchText shown in the input field.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods