Javascript API

The Site Search 360 Plugin provides a set of methods that can be used to trigger specific behavior from outside of the plugin or to dynamically update some of the configuration options.

Configuration

Update configuration

The changeConfig method allows you to update a configuration parameter at runtime (after SS360 has been initialized).

Parameters

  • key:String - the key of the parameter, equal to the path through ss360Config object, e.g. suggestions.show

  • value:* - the value to be set

Usage example

To update the included content groups you can call the changeConfig method like this:

SS360.changeConfig('contentGroups.include',['Recipes']);

A similar result can be achieved by setting the whole contentGroups object as follows:

SS360.changeConfig('contentGroups',{include:['Recipes'],exclude:undefined});

Update siteId

To update the siteId after the plugin initialization you can call the setSiteId method.

Parameters

  • siteId:String - the siteId to be set

Usage example

SS360.setSiteId('spoonacular.com');

Controls

(Re-)Initialize

The Site Search 360 Plugin initializes automatically when the page is loaded. In case you need to trigger the initialization at a later point in time (e.g. you are creating the search field dynamically), you can call the init function to "restart" the plugin.

Usage example

SS360.init();

Show search results

You don't have to rely only on our search field and search button bindings in order to be able to show search results. You can also call the showResults method from outside of the plugin to trigger the search.

Parameters

  • query:String - the search query

  • sort:String (optional) - the sorting to apply, default: undefined

  • pushState:Boolean (optional) - whether to push state to the window history, default: true

  • searchButton:Node (optional) - the search button that triggered the search (for tracking purposes), default: undefined

  • callback:Function (optional) - the callback to be executed after the search results have been rendered, default: undefined

Usage example

SS360.showResults('pizza');

Open specific content group (tab)

If you're using content groups, by default the search result page will open with the All results tab. If you want searchers to focus on a different content group instead (e.g. all queries coming from the News page should open the "News" tab first), you can use the openTab('') method. NB: This is different from limiting your results to a specific content group instead (hiding all other groups).

Usage example

SS360.openTab('News')

Show fullscreen layer

If you are using the fullscreen search results, you can call the showFullscreenLayer method in order to make it slide down and show.

Usage example

SS360.showFullscreenLayer();

Close search results

By calling the closeLayer method you can make the Search Plugin hide the rendered search result. This method only works for layover or fullscreen integration.

Usage example

SS360.closeLayer();

Hide search results

By calling the hideSearchResults method you can make the Search Plugin hide the rendered search result. This method is independent of the search result type.

Usage example

SS360.hideSearchResults();

Show/hide loading animation

You can show or hide the (customized) Site Search 360 loader by calling showLoading(); or hideLoading();.

Usage example

Helpers

Is Initialized?

In order to find out whether the Site Search 360 Plugin has been successfully initialized, you can call the isInitialized method.

Please note that a false return value does not have to mean that the search won't work - it only indicates that there was an error while initializing the plugin (e.g. the script is being embedded multiple times).

Returns

  • isInitialized:Boolean - flag indicating whether the initialization was successful

Usage example

var success=SS360.isInitialized();