...
- name: a name for the facet to be displayed.
- pagination: can take 3 values:
- false(default): no pagination.
- true: pagination automaticaly created.
- PagerWidget: a pager widget.
- nbElmToDisplay: the number of facets to display (default: 10).
- sort: can take 3 values
- occurences(default): sort the facets by the number of occurences.
- AtoZ: sort the facets name by alphabetical order.
- ZtoA: sort the facets name in a reversed akphabetical order.
- maxDisplay: maximum number of facets (default: 40).
- checkedOnTop: if set to true, the checked facets will be sorted on the top before the unchecked facets (default: true).
mappingValues (optional): used to override the values of the facet by custom ones. This variable has to be initialized in the constructor call (search.js) and respect the following format : {"originalFacetValue1" : "customValue1", originalFacetValue2 "originalFacetValue2" : "customValue2", ... }
All the possible facet values don't have to be mapped to custom ones, you can fill this optional variable with the only needed ones, the other values will stay the same.- modules: list of modules instances that need to be implemented to this widget.
When the widget is initialized, it will set the 'manager' varaible on each module of the list and create a specific <li> element in his <ul> for each module. The <li> element will be set to them as the 'elm' variable.
Then, the beforeRequest() and afterRequest() method of the widget will respectively call the beforeRequest() and afterRequest() of each module.
...