Plugin: Tabs - remove parameters
Purpose
Use this plugin if you need to remove parameters such as sort and num_ranks when navigating between tabs.
This plugin will remove the specified parameters from the facet’s toggleUrl.
|
When to use this plugin
Use this plugin when you have multiple tabs and you wish to control whether certain properties such as the sort order are maintained when you select a new tab.
This is useful in the scenario where retaining the user’s selection is not desirable.
For example, consider the following scenario:
-
A search implementation with a primary tab which has two categories; courses and events.
-
The courses tab is selected.
-
Results are ordered by title.
When a user changes from courses to events by selecting the events tab, the default tab behavior is for the new set of event results to be sorted by title.
This plugin can alter the behavior so that selecting the events tab in the above example will return the results sorted by relevancy (which is how results are sorted when you don’t provide a sort parameter).
Usage
Enable the plugin
-
Select Plugins from the side navigation pane and click on the Tabs - remove parameters tile.
-
From the Location section, select the results page to which you would like to enable this plugin from the Select a results page select list.
| The plugin will take effect as soon as you finish running through the plugin setup steps. |
Configuration settings
The configuration settings section is where you do most of the configuration for your plugin. The settings enable you to control how the plugin behaves.
| The configuration key names below are only used if you are configuring this plugin manually. The configuration keys are set in the results page configuration to configure the plugin. When setting the keys manually you need to type in (or copy and paste) the key name and value. |
Search query parameters to remove
Configuration key |
|
Data type |
array |
Default value |
|
Required |
This setting is optional |
Lists the set of search query parameters that should be removed when navigating from a tab with browse mode enabled to another tab. Separate the parameter names with commas.
| The plugin will only work with tabs are set up using a tabbed facet which is named Tabs (case-sensitive). |
Examples
Remove a single parameter when navigating from tab to tab.
This configuration will remove any selected sort parameter, resulting in a default sort (by relevancy) being applied to the results, or whatever is configured in the results page query processor options.
| Configuration key name | Value |
|---|---|
Search query parameters to remove |
|
Remove multiple parameters when navigating from tab to tab.
This configuration will remove any selected num_ranks and fmo parameters.
| Configuration key name | Value |
|---|---|
Search query parameters to remove |
|
The default values will be applied:
-
num_ranks: the search will return 10 results per page, or whatever is configured in the results page query processor options). -
fmo: the search will return both fully and partially matching results, or whatever is configured in the results page query processor options.
| The default value is either the product-level default, or whatever you have set in the results page configuration (which sets the results-page default for the setting). |