search:breadcrumbs

Description

The Breadcrumbs directive.

Usage

as element:
<search:breadcrumbs
       [response="{object}"]
       [query="{string}"]
       [group-by-field="{boolean}"]
       [show-field-name="{boolean}"]
       [show-query="{boolean}"]
       [max-characters="{number}"]
       [action="{string}"]
       [optional-label="{string}"]
       [exclude-label="{string}"]
       [date-format="{string}"]
       [exclude="{string}"]>
</search:breadcrumbs>

Directive info

  • This directive creates new scope.

Parameters

Param Type Details
response
(optional)
object

A response object

query
(optional)
string

A query object

group-by-field
(optional)
boolean

Group filters by field name (only available if query is not in grouping mode).

show-field-name
(optional)
boolean

Whether to show field name as a part of the breadcrumb (only available when group by field is true), Default:true.

show-query
(optional)
boolean

Whether to include the user query text as a breadcrumb. Default:true

max-characters
(optional)
number

Limit display value to a certain number of characters, adding ’…’ if maxCharacters is exceeded.

action
(optional)
string

Alternative page to submit the query parameters to - defaults to current page.

optional-label
(optional)
string

Label to show when the Filter is optional.

exclude-label
(optional)
string

Label to prefix the display values with to indicate that the Filter excludes the values. Default:not

date-format
(optional)
string

Format to use for date values if no display value is specified. See date format filter for valid formats.

exclude
(optional)
string

Comma separated list of fields to exclude, you can also use field=value to exclude only fields with the value provided.

Example

Source





Demo