jsdoc

$.ui.simplicitySearchResults

Namespace $.ui.simplicitySearchResults

Widget that displays the search results. This widget listens to the simplicitySearchResponse event and takes the resultsHtml field from the search response, injecting it directly into the page.

If your search controller does not inject the search results as HTML into it's response then consider using simplicityRenderParamsSearchResults instead.
Defined in: ui.simplicitySearchResults.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
$.ui.simplicitySearchResults.options
Widget options.
Method Summary
Method Attributes Method Name and Description
<private> <static>  
$.ui.simplicitySearchResults._searchResponseHandler()
Default event handler for the simplicitySearchResponse event.
Namespace Detail
$.ui.simplicitySearchResults
Field Detail
<static> $.ui.simplicitySearchResults.options
Widget options.
searchElement
The simplicityDiscoverySearch widget that this widget binds it's events to. Defaults to 'body'.
resultsCallback

This is the callback which creates the resultsHTML for display in the browser. This option only needs to be provided if the search response does not contain resultsHtml, for example, if directly querying a CORS-compatible Discovery Search Engine. Callback invocation signature: function (resultsElement, searchResponse) {}

When not provided, the widget will look for the resultsHTML in the searchResponse.

Defaults to ''.
errorCallback

This is the callback which handles search response errors. Callback invocation signature: function (resultsElement, searchResponse) {}

Method Detail
<private> <static> $.ui.simplicitySearchResults._searchResponseHandler()
Default event handler for the simplicitySearchResponse event. If there is no option resultsCallback, expects the given search response object to contain a resultsHtml field and splices it directly into the page, otherwise option resultsCallback handles the results logic.

Documentation generated by JsDoc Toolkit 2.4.0