Search

import Search from "@arcgis/core/widgets/Search.js";

Inheritance:: Search→Widget→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.0

The Search widget provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer, BuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). If using a locator with a geocoding service, the findAddressCandidates operation is used, whereas queries are used on feature layers.

By default, the Search widget uses the ArcGIS World Geocoding Service via this URL: https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer. If a global apiKey is present, the Search widget uses this URL: https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer. If an LocatorSearchSource.apiKey is present on the LocatorSearchSource, then the Search widget uses the URL defined by the LocatorSearchSource.url property.

The Search widget sets the view on the Search result. The level of detail (LOD) at the center of the view depends on the data source, with higher quality data sources returning extents closer to the feature obtained from the search. To manually define the scale of the view at the Search result, use the zoomScale property of the LocatorSearchSource.zoomScale or LayerSearchSource.zoomScale.

Search widget results are typically sorted according to their relevance to the search and their relative importance. However, when the scale of the MapView.scale or SceneView.scale is less than or equal to 300,000, the operations support prioritization of candidates based on their distance from a specified point (the center of the view) by passing in the location parameter. Features closest to the input location show up higher in the list of results. This behavior can be changed by using the LocatorSearchSource.localSearchDisabled property.

You can use the view's DefaultUI to add widgets to the view's user interface via the ui property on the view. See the example below.

See also

Example

const searchWidget = new Search({
  view: view
});
// Adds the search widget below other elements in
// the top left corner of the view
view.ui.add(searchWidget, {
  position: "top-left",
  index: 2
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`SearchProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Example

// typical usage
const searchWidget = new Search({
  view: view,
  sources: [ ... ]
});

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`activeMenu`	`SearchActiveMenu`
`activeSource` readonly	`SupportedSearchSource \| null \| undefined`
`activeSourceIndex`	`number`
`allPlaceholder`	`string \| null \| undefined`
`allSources` readonly	`Collection<SupportedSearchSource>`
`autoNavigate`	`boolean`
`autoSelect`	`boolean`
`container` inherited	`HTMLElement \| null \| undefined`	Widget
`declaredClass` readonly inherited	`string`	Accessor
`defaultSources` readonly	`Collection<SupportedSearchSource>`
`destroyed` readonly inherited	`boolean`	Widget
`disabled`	`boolean`
`goToOverride`	`GoToOverride \| null \| undefined`
`icon`	`Icon["icon"]`
`id` inherited	`string`	Widget
`includeDefaultSources`	`boolean \| SourcesHandler`
`label`	`string`
`locationEnabled`	`boolean`
`maxResults`	`number`
`maxSuggestions`	`number`
`minSuggestCharacters`	`number`
`popupEnabled`	`boolean`
`popupTemplate`	`PopupTemplate \| null \| undefined`
`portal`	`Portal \| null \| undefined`
`resultGraphic`	`Graphic \| null \| undefined`
`resultGraphicEnabled`	`boolean`
`results` readonly	`BaseSearchResults<SearchResult>[] \| null \| undefined`
`searchAllEnabled`	`boolean`
`searchTerm`	`string`
`selectedResult` readonly	`SearchResult \| null \| undefined`
`sources`	`SearchViewModel["sources"]`
`suggestions` readonly	`SearchViewModel["suggestions"]`
`suggestionsEnabled`	`boolean`
`view`	`MapViewOrSceneView \| null \| undefined`
`viewModel`	`SearchViewModel`
`visible` inherited	`boolean`	Widget

activeMenu

Property

Type: SearchActiveMenu

The current active menu of the Search widget.

Default value: "none"

activeSource

readonly Property

Type: SupportedSearchSource | null | undefined

The source object currently selected. Can be either a LayerSearchSource or a LocatorSearchSource.

activeSourceIndex

Property

Type: number

The selected source's index. This value is -1 when all sources are selected.

Default value: 0

allPlaceholder

Property

Type: string | null | undefined

String value used as a hint for input text when searching on multiple sources. See the image below to view the location and style of this text in the context of the widget.

Default value: "Find address or place"

allSources

readonly Property

Type: Collection<SupportedSearchSource>

Since: ArcGIS Maps SDK for JavaScript 4.8

The combined collection of SearchViewModel.defaultSources and SearchViewModel.sources. The SearchViewModel.defaultSources displays first in the Search UI.

autoNavigate

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.32

Indicates whether to automatically navigate to the selected result once selected.

Default value: true

autoSelect

Property

Type: boolean

Indicates whether to automatically select and zoom to the first geocoded result. If false, the findAddressCandidates operation will still geocode the input string, but the top result will not be selected. To work with the geocoded results, you can set up a @search-complete event handler and get the results through the event object.

Default value: true

container

autocast inherited Property

Type: HTMLElement | null | undefined

Inherited from: Widget

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.

Examples

// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

defaultSources

readonly Property

Type: Collection<SupportedSearchSource>

Since: ArcGIS Maps SDK for JavaScript 4.8

A read-only property that is a Collection of LayerSearchSource and/or LocatorSearchSource. This property may contain ArcGIS Portal locators and any web map or web scene configurable search sources. Web maps or web scenes may contain map/feature service feature layer(s), and/or table(s) as sources.

This property is used to populate the Search UI if the SearchViewModel.sources property is not set.

destroyed

readonlyinherited Property

Type: boolean

Inherited from: Widget

When true, this property indicates whether the widget has been destroyed.

disabled

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.15

When true, the widget is visually withdrawn and cannot be interacted with.

Default value: false

goToOverride

Property

Type: GoToOverride | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.8

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

See also

Example

// The following snippet uses Search but can be applied to any
// widgets that support the goToOverride property.
search.goToOverride = function(view, goToParams) {
  goToParams.options = {
    duration: updatedDuration
  };
  return view.goTo(goToParams.target, goToParams.options);
};

icon

autocast Property

Type: Icon["icon"]

Since: ArcGIS Maps SDK for JavaScript 4.27

Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).

See also

Default value: "search"

id

inherited Property

Type: string

Inherited from: Widget

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

includeDefaultSources

Property

Type: boolean | SourcesHandler

Since: ArcGIS Maps SDK for JavaScript 4.8

Indicates whether or not to include SearchViewModel.defaultSources in the Search UI. This can be a boolean value or a function that returns an array of Search SearchViewModel.sources.

Default value: true

Example

// includeDefaultSources passed as a boolean value
const searchWidget = new Search({
  view: view,
  sources: [customSearchSource],
  includeDefaultSources: false
});

// includeDefaultSources passed as a function
const searchWidget = new Search({
  view: view,
  sources: [customSearchSource],
  includeDefaultSources: function(sourcesResponse) {
    return sourcesResponse.defaultSources;
  }
});

label

autocast Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 4.7

The widget's default label.

locationEnabled

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.6

Enables location services within the widget.

The use of this property is only supported on secure origins. To use it, switch your application to a secure origin, such as HTTPS. Note that localhost is considered "potentially secure" and can be used for easy testing in browsers that supports Window.isSecureContext (currently Chrome and Firefox).

Default value: true

maxResults

Property

Type: number

The maximum number of results returned by the widget if not specified by the source.

Default value: 6

maxSuggestions

Property

Type: number

The maximum number of suggestions returned by the widget if not specified by the source.

If working with the default ArcGIS Online Geocoding service, the default remains at 5.

Default value: 6

minSuggestCharacters

Property

Type: number

Indicates the minimum number of characters required before querying for a suggestion.

Default value: 3

popupEnabled

Property

Type: boolean

Indicates whether to display a Popup when a selected result is clicked.

Default value: true

popupTemplate

autocast Property

Type: PopupTemplate | null | undefined

A customized PopupTemplate for the selected feature. Note that any templates defined on allSources take precedence over those defined directly on the template.

portal

autocast Property

Type: Portal | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.8

It is possible to search a specified portal instance's locator services Use this property to set this ArcGIS Portal instance to search.

resultGraphic

Property

Type: Graphic | null | undefined

The graphic used to highlight the resulting feature or location.

A graphic will be placed in the View's View.graphics for layer views that do not support the highlight method.

resultGraphicEnabled

Property

Type: boolean

Indicates if the resultGraphic will display at the location of the selected feature.

Default value: true

results

readonly Property

Type: BaseSearchResults<SearchResult>[] | null | undefined

An array of objects, each containing a SearchResult from the search.

searchAllEnabled

Property

Type: boolean

Indicates whether to display the option to search all sources. When true, the "All" option is displayed by default:

When false, no option to search all sources at once is available:

Default value: true

searchTerm

Property

Type: string

The value of the search box input text string.

selectedResult

readonly Property

Type: SearchResult | null | undefined

The result selected from a search.

See also

sources

autocast Property

Type: SearchViewModel["sources"]

The Search widget may be used to search features in a map/feature service feature layer(s), SceneLayers with an associated feature layer, BuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer or OGCFeatureLayer, or table, or geocode locations with a locator. The sources property defines the sources from which to search for the view specified by the Search widget instance. There are two types of sources:

Any combination of these sources may be used together in the same instance of the Search widget.

Feature layers created from client-side graphics are not supported.

Examples

// Default sources[] when sources is not specified
[
  {
    url: "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer",
    singleLineFieldName: "SingleLine",
    outFields: ["Addr_type"],
    name: "ArcGIS World Geocoding Service",
    placeholder: "Address",
    resultSymbol: {
       type: "picture-marker",  // autocasts as new PictureMarkerSymbol()
       url: this.basePath + "/images/search/search-symbol-32.png",
       size: 24,
       width: 24,
       height: 24,
       xoffset: 0,
       yoffset: 0
   }
  }
]

// Example of multiple sources[]
const sources = [
{
  url: "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer",
  singleLineFieldName: "SingleLine",
  name: "Custom Geocoding Service",
  placeholder: "Search Geocoder",
  maxResults: 3,
  maxSuggestions: 6,
  suggestionsEnabled: false,
  minSuggestCharacters: 0
}, {
  layer: new FeatureLayer({
    url: "https://services.arcgis.com/DO4gTjwJVIJ7O9Ca/arcgis/rest/services/GeoForm_Survey_v11_live/FeatureServer/0",
    outFields: ["*"]
  }),
  searchFields: ["Email", "URL"],
  displayField: "Email",
  exactMatch: false,
  outFields: ["*"],
  name: "Point FS",
  placeholder: "example: esri",
  maxResults: 6,
  maxSuggestions: 6,
  suggestionsEnabled: true,
  minSuggestCharacters: 0
},
{
  layer: new FeatureLayer({
    outFields: ["*"]
  }),
  placeholder: "esri",
  name: "A FeatureLayer",
  prefix: "",
  suffix: "",
  maxResults: 1,
  maxSuggestions: 6,
  exactMatch: false,
  searchFields: [], // defaults to FeatureLayer.displayField
  displayField: "", // defaults to FeatureLayer.displayField
  minSuggestCharacters: 0
}
];

// Set source(s) on creation
const searchWidget = new Search({
  sources: []
});

// Set source(s)
const searchWidget = new Search();
const sources = [{ ... }, { ... }, { ... }]; //array of sources
searchWidget.sources = sources;

// Add to source(s)
const searchWidget = new Search();
searchWidget.sources.push({ ... });  //new source

suggestions

readonly Property

Type: SearchViewModel["suggestions"]

An array of results from the suggest method.

This is available if working with a 10.3 or greater geocoding service that has suggest capability loaded or a 10.3 or greater feature layer that supports pagination, i.e. supportsPagination = true.

suggestionsEnabled

Property

Type: boolean

Enable suggestions for the widget.

This is only available if working with a 10.3 or greater geocoding service that has suggest capability loaded or a 10.3 or greater feature layer that supports pagination, i.e. supportsPagination = true.

Default value: true

view

Property

Type: MapViewOrSceneView | null | undefined

A reference to the MapView or SceneView. Set this to link the widget to a specific view.

viewModel

autocast Property

Type: SearchViewModel

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the SearchViewModel class to access all properties and methods on the widget.

visible

inherited Property

Type: boolean

Inherited from: Widget

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the DefaultUI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of "none".

Default value: true

Example

// Hides the widget in the view
widget.visible = false;

Methods

Method	Signature	Class
`blur`	`blur(): void`
`classes` inherited	`classes(...classNames: ((string \| null \| undefined) \| ((string[] \| Record<string, boolean>) \| null \| undefined) \| false \| null \| undefined)[]): string`	Widget
`clear`	`clear(): void`
`destroy` inherited	`destroy(): void`	Widget
`emit` inherited	`emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean`	EventedMixin
`focus`	`focus(): void`
`hasEventListener` inherited	`hasEventListener<Type extends EventNames<this>>(type: Type): boolean`	EventedMixin
`isFulfilled` inherited	`isFulfilled(): boolean`	EsriPromiseMixin
`isRejected` inherited	`isRejected(): boolean`	EsriPromiseMixin
`isResolved` inherited	`isResolved(): boolean`	EsriPromiseMixin
`on` inherited	`on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle`	EventedMixin
`postInitialize` inherited	`postInitialize(): void`	Widget
`render` inherited	`render(): any \| null`	Widget
`renderNow` inherited	`renderNow(): void`	Widget
`scheduleRender` inherited	`scheduleRender(): void`	Widget
`search`	`search(searchTerm?: SearchItem \| null \| undefined): Promise<SearchResponse \| null \| undefined>`
`suggest`	`suggest(query?: string): Promise<SuggestResponse \| null \| undefined>`
`when` inherited	`when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> \| null \| undefined, onRejected?: OnRejectedCallback<TResult2> \| null \| undefined): Promise<TResult1 \| TResult2>`	EsriPromiseMixin

blur

Method

Signature: blur (): void

Unfocuses the widget's text input.

Returns: void

classes

inherited Method

Signature: classes (...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string

Inherited from: Widget

Since: ArcGIS Maps SDK for JavaScript 4.7

A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.

Parameters

Parameter	Type	Description	Required
classNames	`((string \| null \| undefined) \| ((string[] \| Record<string, boolean>) \| null \| undefined) \| false \| null \| undefined)[]`	The class names.

Returns: string
The computed class name.

Example

// .tsx syntax showing how to set css classes while rendering the widget

render() {
  const dynamicClasses = {
    [css.flip]: this.flip,
    [css.primary]: this.primary
  };

  return (
    <div class={classes(css.root, css.mixin, dynamicClasses)} />
  );
}

clear

Method

Signature: clear (): void

Clears the current searchTerm, search results, suggest results, graphic, and graphics layer. It also hides any open menus.

Returns: void

destroy

inherited Method

Signature: destroy (): void

Inherited from: Widget

Destroys the widget instance.

Returns: void

emit

inherited Method

Signature: emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

Since: ArcGIS Maps SDK for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

Parameter	Type	Description	Required
type	`Type`	The name of the event.
event	`this["@eventTypes"][Type]`	The event payload.

Returns: boolean
true if a listener was notified

focus

Method

Signature: focus (): void

Brings focus to the widget's text input.

Returns: void

hasEventListener

inherited Method

Signature: hasEventListener <Type extends EventNames<this>>(type: Type): boolean

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameters

Parameter	Type	Description	Required
type	`Type`	The name of the event.

Returns: boolean
Returns true if the class supports the input event.

isFulfilled

inherited Method

Signature: isFulfilled (): boolean

Inherited from: EsriPromiseMixin

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns: boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected

inherited Method

Signature: isRejected (): boolean

Inherited from: EsriPromiseMixin

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns: boolean
Indicates whether creating an instance of the class has been rejected.

isResolved

inherited Method

Signature: isResolved (): boolean

Inherited from: EsriPromiseMixin

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns: boolean
Indicates whether creating an instance of the class has been resolved.

on

inherited Method

Signature: on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

Parameter	Type	Description	Required
type	`Type`	An event or an array of events to listen for.
listener	`EventedCallback<this["@eventTypes"][Type]>`	The function to call when the event fires.

Returns

ResourceHandle

Returns an event handler with a remove() method that should be called to stop listening for the event(s).

Property	Type	Description
remove	Function	When called, removes the listener from the event.

Example

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

postInitialize

inherited Method

Signature: postInitialize (): void

Inherited from: Widget

Executes after widget is ready for rendering.

Returns: void

render

inherited Method

Signature: render (): any | null

Inherited from: Widget

This method is implemented by subclasses for rendering.

Returns: any | null
The rendered virtual node.

renderNow

inherited Method

Signature: renderNow (): void

Inherited from: Widget

Renders widget to the DOM immediately.

Returns: void

scheduleRender

inherited Method

Signature: scheduleRender (): void

Inherited from: Widget

Schedules widget rendering. This method is useful for changes affecting the UI.

Returns: void

Method

Signature: search (searchTerm?: SearchItem | null | undefined): Promise<SearchResponse | null | undefined>

Depending on the sources specified, search() queries the feature layer(s) and/or performs address matching using any specified locator(s) and returns any applicable results.

Parameters

Parameter	Type	Description	Required
searchTerm	`SearchItem \| null \| undefined`	This searchTerm can be a string, geometry, suggest candidate object, or an array of [longitude,latitude] coordinate pairs. If a geometry is supplied, then it will reverse geocode (locator) or findAddressCandidates with geometry instead of text.

Returns: Promise<SearchResponse | null | undefined>
When resolved, returns a SearchResponse containing a SearchResult.

suggest

Method

Signature: suggest (query?: string): Promise<SuggestResponse | null | undefined>

Performs a suggest() request on the active Locator. It also uses the current value of the widget or one that is passed in.

Suggestions are available if working with a 10.3 or greater geocoding service that has suggest capability loaded or a 10.3 or greater feature layer that supports pagination, i.e. supportsPagination = true.

Parameters

Parameter	Type	Description	Required
query	`string`	The string value used to suggest() on an active Locator or feature layer. If nothing is passed in, takes the current value of the widget.

Returns: Promise<SuggestResponse | null | undefined>
When resolved, returns SuggestResponse containing an array of result objects. Each of these results contains a SuggestResult.

when

inherited Method

Signature: when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>

Type parameters: <TResult1 = this, TResult2 = never>

Inherited from: EsriPromiseMixin

Since: ArcGIS Maps SDK for JavaScript 4.6

when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function. The onFulfilled executes when the instance of the class loads. The onRejected executes if the instance of the class fails to load.

Parameters

Parameter	Type	Description	Required
onFulfilled	`OnFulfilledCallback<this, TResult1> \| null \| undefined`	The function to call when the promise resolves.
onRejected	`OnRejectedCallback \| null \| undefined`	The function to execute when the promise fails.

Returns: Promise<TResult1 | TResult2>
Returns a new promise for the result of onFulfilled that may be used to chain additional functions.

Example

// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Events

Name	Type
`search-blur`	CustomEvent<void>
`search-clear` inherited	CustomEvent<void>
`search-complete` inherited	CustomEvent<SearchResponse>
`search-focus`	CustomEvent<void>
`search-start` inherited	CustomEvent<void>
`select-result` inherited	CustomEvent<SearchViewModelSelectResultEvent>
`suggest-complete` inherited	CustomEvent<SuggestResponse \| null>
`suggest-start` inherited	CustomEvent<{ searchTerm: string; }>

search-blur

Event

search-blur: CustomEvent<void>

Fires when the widget's text input loses focus.

Example

const searchWidget = new Search();

searchWidget.on("search-blur", function(event){
  console.log("Focus removed from search input textbox.");
});

search-clear

inherited Event

search-clear: CustomEvent<void>

Inherited from: SearchViewModelEvents

Fires when a result is cleared from the input box or a new result is selected.

Example

const searchWidget = new Search();

searchWidget.on("search-clear", function(event){
  console.log("Search input textbox was cleared.");
});

search-complete

inherited Event

search-complete: CustomEvent<SearchResponse>

Inherited from: SearchViewModelEvents

Fires when the Search.search() method is called and returns its results.

Example

const searchWidget = new Search();

searchWidget.on("search-complete", function(event){
  // The results are stored in the event Object[]
  console.log("Results of the search: ", event);
});

search-focus

Event

search-focus: CustomEvent<void>

Fires when the widget's text input sets focus.

Example

const searchWidget = new Search();

searchWidget.on("search-focus", function(event){
  console.log("Search input textbox is focused.");
});

search-start

inherited Event

search-start: CustomEvent<void>

Inherited from: SearchViewModelEvents

Fires when the Search.search() method starts.

Example

const searchWidget = new Search();

searchWidget.on("search-start", function(event){
  console.log("Search started.");
});

select-result

inherited Event

select-result: CustomEvent<SearchViewModelSelectResultEvent>

Inherited from: SearchViewModelEvents

Fires when a search result is selected.

Example

const searchWidget = new Search();

searchWidget.on("select-result", function(event){
  console.log("The selected search result: ", event);
});

suggest-complete

inherited Event

suggest-complete: CustomEvent<SuggestResponse | null>

Inherited from: SearchViewModelEvents

Fires when the Search.suggest() method is called and returns its results.

Example

const searchWidget = new Search();

searchWidget.on("suggest-complete", function(event){
  // The results are stored in the event Object[]
  console.log("Results of suggest: ", event);
});

suggest-start

inherited Event

suggest-start: CustomEvent<{ searchTerm: string; }>

Inherited from: SearchViewModelEvents

Fires when the Search.suggest() method starts.

Example

const searchWidget = new Search();

searchWidget.on("suggest-start", function(event){
  console.log("suggest-start", event);
});

Type definitions

SearchActiveMenu

Type definition

Type: "none" | "suggestion" | "source" | "warning"