List of available parameters for common.widget.search-form component?

Oh well, I figured it might have to be a custom solution.  Was hoping there might be a list of parameters some where.

Thanks PaoloT!

Here is documentation from the Studio hovercard component help for Search Form. 

The parameters you can use differ depending on whether you are using Search v1 or v2. 

Search V 1.0 settings are configured in Community Admin > System > Search> Search 1.0. Be sure that Search 2.0 is disabled in the Search 2.0 tab, if visible.

In the XML tab you can configure the component to hide the drop down list that enables uses to choose the scope of their search, to use a slim or wide display model, and to default the scoping options to a Community-level scope.

Search V1 supports the parameters: hideGranularity, and defaultToCommunity.

Search V2 supports the parameters: mode, hideGranularity, defaultToCommunity

To hide the drop down list to scope the search add: hideGranularity="true"

To default the scope of the search to be community-wide add: defaultToCommunity="true"

To change the component width, add: mode="slim" or mode="wide"

We have documented available XML parameters for the components that use them in the Where Do I Configure This section of the Studio inline help. Here's an example:

if anyone comes looking, you can override common.widget.search-form@override and add this JavaScript. This will scope it to the particular forum.

<@liaAddScript>
;(function($){

  var nodeType = "${coreNode.nodeType}";

  if (nodeType === "board") {
   var boardId = "${coreNode.id}";

   var inputFormFilter = '<input name="filter" value="location" type="hidden">';
   var inputFormLocation = '<input name="location" value="board:' + boardId + '" type="hidden">';
   $('form[action*="searchform.form.form"]').append(inputFormFilter).append(inputFormLocation);
  }

})(LITHIUM.jQuery)
</@liaAddScript>

<@delegate />

---

gstelang wrote:

if anyone comes looking, you can override common.widget.search-form@override and add this JavaScript. This will scope it to the particular forum.

<@liaAddScript>
;(function($){

  var nodeType = "${coreNode.nodeType}";

  if (nodeType === "board") {
   var boardId = "${coreNode.id}";

   var inputFormFilter = '<input name="filter" value="location" type="hidden">';
   var inputFormLocation = '<input name="location" value="board:' + boardId + '" type="hidden">';
   $('form[action*="searchform.form.form"]').append(inputFormFilter).append(inputFormLocation);
  }

})(LITHIUM.jQuery)
</@liaAddScript>

<@delegate />

 

---

gstelang where would this type of script go? In a custom component, or just anywhere on the page where you want to override the context of the search component or elsewhere?

Hi robertcavanna

if you create a custom component and call it common.widget.search-form@override and use that code, it will override the behavior of common.widget.search-form on all pages that the Lithium's default search component is being used. Does that make sense?