search:facet-list

Description

The facet list directive displays a list of facets.

Usage

as element:
<search:facet-list
       [response="{object}"]
       [styling="{string}"]
       [facet-names="{string}"]
       [max-characters="{number}"]
       [platform="{string}"]
       [query="{Object}"]>
</search:facet-list>

Directive info

  • This directive creates new scope.

Parameters

Param Type Details
response
(optional)
object

A response object

styling
(optional)
string

The style the facet list is to be renedered in. Accepted values 'shadow' and 'wrappedheader'

facet-names
(optional)
string

The names of the facets to output. Can be specified as either a comma separated list or as a wildcard * for all available facets. In addition, you can use the - with a facet name to omit a specific facet (e.g. -cat will omit the cat facet).

max-characters
(optional)
number

Limit display value to a certain number of characters, adding '…' if maxCharacters is exceeded. This will not break highlighting code.

platform
(optional)
string

The name of the platform to use for search within the facet.

query
(optional)
Object

Query to be used.

Example

Source