Interface SelectedEvent

An event emitted via the Event Service using the topic name search-api/SELECTED.

interface SelectedEvent {
    context: undefined | string;
    item?: Record<string, unknown>;
    items?: Record<string, unknown>[];
    query: string;
    source: ItemSource;
}

Properties

context item? items? query source

Properties

Readonlycontext

context: undefined | string

Context parameter that was specified when the search was started.

May indicate the UI widget or bundle where the search was originally triggered.

See also SearchOptions.context.

Optional Readonlyitem

item?: Record<string, unknown>

The selected item (for single selection).

Mutually exclusive with items.

Optional Readonlyitems

items?: Record<string, unknown>[]

The selected items (for multi selection).

Mutually exclusive with item.

Readonlyquery

query: string

The original search query entered by the user.

Readonlysource

source: ItemSource

The source of the selected item. Currently all sources are stores, but different source types may be added in the future. Use the type field for disambiguation.

Settings

Member Visibility

On This Page

Properties