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.
changeConfig method allows you to update a configuration parameter at runtime (after SS360 has been initialized).
String- the key of the parameter, equal to the path through ss360Config object, e.g.
*- the value to be set
To update the included result groups you can call the
changeConfig method like this:
A similar result can be achieved by setting the whole contentGroups object as follows:
To update the siteId after the plugin initialization you can call the
String- the siteId to be set
Change base URL
To update the URL from which search results are loaded you can call the
String- the search URL to be used
Change suggestion URL
To update the URL from which search suggestions are loaded you can call the
String- the suggestion URL to be used
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.
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.
String- the search query
String(optional) - the sorting to apply, default:
Boolean(optional) - whether to push state to the window history, default:
Node(optional) - the search button that triggered the search (for tracking purposes), default:
Function(optional) - the callback to be executed after the search results have been rendered, default:
Open specific result group (tab)
If you're using result grouping, by default the search result page will open with the All results tab. If you want searchers to focus on a different result 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 result group instead (hiding all other groups). To open the "All Results" result group you need to call
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.
Close search results
By calling the
closeLayer method you can make the Search Plugin hide the rendered search result. This method only works for overlay or fullscreen integration.
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.
Show/hide loading animation
You can show or hide the (customized) Site Search 360 loader by calling
In order to find out whether the Site Search 360 Plugin has been successfully initialized, you can call the
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).
Boolean- flag indicating whether the initialization was successful