Looking for the old docs site? You can still view it for a limited time here.

search:facet

Description

The facet directive displays an individual facet. Either a response object and facet name must be passed to it, or a facet object.

Search Within Facet

To enable search within facets the following attributes must be set on the facet search-enabled="true". The following attributes can be set on either the facet-list tag or the facet tag to enable search within platform and query.

If using a string field such as facet_field_s then you should add the attribute facet-field to your facet tag with the tokenized version of that field eg. facet-field="facet_field_t", for more information see the search-enabled and facet-field attributes.

Usage

as element:
<search:facet
       [response="{string}"]
       [facet-name="{string}"]
       [facet="{expression}"]
       [title="{string}"]
       [show="{string}"]
       [show-more="{string}"]
       [max-characters="{string}"]
       [select="{string}"]
       [platform="{string}"]
       [query="{string}"]
       [search-enabled="{boolean}"]
       [facet-field="{string}"]
       [collapsible="{boolean}"]
       [show-empty="{boolean}"]
       [collapsed-by-default="{boolean}"]
       [show-more-label="{string}"]
       [show-less-label="{string}"]
       [show-count="{boolean}"]
       [action="{string}"]
       [count-number="{string}"]
       [date-format="{string}"]
       [measure="{string}"]
       [when-field="{string}"]
       [exclude="{boolean}"]>
</search:facet>

Directive info

  • This directive creates new scope.

Parameters

Param Type Details
response
(optional)
 string

The name of the response to use.
facet-name
(optional)
 string

Facet name to use from the response object
facet
(optional)
 expression

A facet object to display
title
(optional)
 string

The title of the facet to display, defaults to the name of the facet
show
(optional)
 string

The number of filters to show by default
show-more
(optional)
 string

The number of extra filters to display when the show more link is clicked
max-characters
(optional)
 string

Limit display value to a certain number of characters, adding '...' if max-characters is exceeded.
select
(optional)
 string

How to render each FacetFilter.


Valid values:-
  • click

    User selects a filter by clicking the value;

    (default)
  • multiselect

    Supports selecting multiple filters that get combined with an 'OR'.

  • toggle

    Only allows one filter to be selected at a time but shows unselected filters and counts

  • multiselect-instant

    Supports selecting multiple filters that get combined with an 'OR', filters will be applied automatically.
platform
(optional)
 string

The name of the platform to use for search within the facet.
query
(optional)
 string

Nome of the query to be used.
search-enabled
(optional)
 boolean

Whether to enable search on the facet. If no query or platform is defined on the facet or facet-list it will enable the user to search through the filters that have been returned in the response. If a platform and query is defined on the facet or facet-list then it will search for filters in the search index. (Requires a tokenized field, if not using a tokenized field, if not using a tokenized field please see facet-field).
facet-field
(optional)
 string

When this option is provided, the user will have the option to search values within the facet using the named field to search against. The named field should be tokenized. Example usage is if you are using facet_field_s (a string facet/field) as your facet you need to provide the tokenized version of that field for search against, e.g. facet_field_t.
collapsible
(optional)
 boolean

Set to true if the facet should be collapsible in the list of facets.

(default: false)
show-empty
(optional)
 boolean

If true then the facet will also output empty filters where count is zero.

(default: false)
collapsed-by-default
(optional)
 boolean

Set to true if this facet should be collapsed by default.

(default: false)
show-more-label
(optional)
 string

Text to show on the link that shows more filters (expandable mode).

(default: "Show more")
show-less-label
(optional)
 string

Text to show on the link that shows fewer filters (expandable mode).

(default: "Show less")
show-count
(optional)
 boolean

Whether to add metadata with frequency counts etc.

(default: true)
action
(optional)
 string

Alternative Action to submit the query parameters to - defaults to current page.
count-number
(optional)
 string

Specify how the number representing the count should be formatted.


Valid values:-
  • plain

    Displays the number without any formatting.

  • formatted

    Formatted means that the number is comma formatted (2,000,000 for 2000000).

    (default)
  • rounded

    Rounded means the number is represented in a short format (2k for ~2000).
date-format
(optional)
 string

How to format the date. See date format filter for valid formats.
measure
(optional)
 string

What fact to use as an alternative to count as quantiative value for a filter.
when-field
(optional)
 string

Comma-separated list of field names. When one matches this facet representation will be used during an iteration.
exclude
(optional)
 boolean

On filter hover, displays an icon to allow the user to add an exclusion filter for the value.

(default: false)

Example

Source