atomic-facet

This is for:

Developer

A facet is a list of values for a certain field occurring in the results, ordered using a configurable criteria (e.g., number of occurrences). An atomic-facet displays a facet of the results for the current query.

Introduction

A facet allows users to drill down inside a result set by filtering the result to certain field values. Adding an optional search box to a facet can help find specific values inside larger sets.

User Experience and Best Practices

Usage Notes

  • Checkboxes are the most commonly used display in most cases.

  • Boxes are multi-select, more visual, and able to present more values in a small space.

  • Links allow the user to select only one value at a time, and behave like a normal navigational link.

Guidelines

Don’t use boxes if your facet values are long, it won’t provide a good experience for your users and you risk truncating values. Place facets on the left side of the search page; this is the most natural place for them and is where users expect to see them. Positioning facets on the right side results in lower adoption and decreases the usability of the search page.

Use Cases and Examples

Facets are useful for large indexes because they provide multiple filters, one for every specific aspect of the content. Faceted navigation helps the user get an overview of the content available, helping them understand how to search for it.

Reference

Don’t Lose Face with Facets

Properties

Property Attribute Description Type Default

allowedValues

allowed-values

Specifies an explicit list of allowedValues in the Search API request, as a JSON string representation.

If you specify a list of values for this option, the facet uses only these values (if they are available in the current result set).

Example:

The following facet only uses the Contact, Account, and File values of the objecttype field. Even if the current result set contains other objecttype values, such as Message, or Product, the facet does not use those other values.

<atomic-facet field="objecttype" allowed-values='["Contact","Account","File"]'></atomic-facet>

The maximum amount of allowed values is 25.

Default value is undefined, and the facet uses all available values for its field in the current result set.

string | string[]

'[]'

customSort

custom-sort

Identifies the facet values that must appear at the top, in this order. This parameter can be used in conjunction with the sortCriteria parameter.

Facet values not part of the customSort list will be sorted according to the sortCriteria.

Example:

The following facet will sort the Contact, Account, and File values at the top of the list for the objecttype field.

If there are more than these 3 values available, the rest of the list will be sorted using occurrences.

<atomic-facet field="objecttype" custom-sort='["Contact","Account","File"]' sort-criteria='occurrences'></atomic-facet>

The maximum amount of custom sort values is 25.

The default value is undefined, and the facet values will be sorted using only the sortCriteria.

string | string[]

'[]'

dependsOn

The required facets and values for this facet to be displayed. Examples:

<atomic-facet facet-id="abc" field="objecttype" ...></atomic-facet>

<!-- To show the facet when any value is selected in the facet with id "abc": -->
<atomic-facet
  depends-on-abc
  ...
></atomic-facet>

<!-- To show the facet when value "doc" is selected in the facet with id "abc": -->
<atomic-facet
  depends-on-abc="doc"
  ...
></atomic-facet>

{ [x: string]: string; }

{}

displayValuesAs

display-values-as

Whether to display the facet values as checkboxes (multiple selection), links (single selection) or boxes (multiple selection). Possible values are 'checkbox', 'link', and 'box'.

"box" | "checkbox" | "link"

'checkbox'

enableExclusion

enable-exclusion

Whether to allow excluding values from the facet.

boolean

false

facetId

facet-id

Specifies a unique identifier for the facet.

string | undefined

field (required)

field

The field whose values you want to display in the facet.

string

filterFacetCount

filter-facet-count

Whether to exclude the parents of folded results when estimating the result count for each facet value.

boolean

true

headingLevel

heading-level

The heading level to use for the heading over the facet, from 1 to 6.

number

0

injectionDepth

injection-depth

The maximum number of results to scan in the index to ensure that the facet lists all potential facet values. Note: A high injectionDepth may negatively impact the facet request performance. Minimum: 0 Default: 1000

number

1000

isCollapsed

is-collapsed

Specifies whether the facet is collapsed. When the facet is the child of an atomic-facet-manager component, the facet manager controls this property.

boolean

false

label

label

The non-localized label for the facet. Used in the atomic-breadbox component through the bindings store.

string

'no-label'

numberOfValues

number-of-values

The number of values to request for this facet. Also determines the number of additional values to request each time more values are shown.

number

8

resultsMustMatch

results-must-match

Specifies how a result must match the selected facet values. Allowed values: - atLeastOneValue: A result will match if at least one of the corresponding facet values is selected. - allValues: A result will match if all corresponding facet values are selected.

"allValues" | "atLeastOneValue"

'atLeastOneValue'

sortCriteria

sort-criteria

The sort criterion to apply to the returned facet values. Possible values are 'score', 'alphanumeric', 'alphanumericDescending', 'occurrences', and 'automatic'.

"alphanumeric" | "alphanumericDescending" | "automatic" | "occurrences" | "score"

'automatic'

tabsExcluded

tabs-excluded

The tabs on which this facet must not be displayed. This property should not be used at the same time as tabs-included.

Set this property as a stringified JSON array, e.g.,

 <atomic-facet tabs-excluded='["tabIDA", "tabIDB"]'></atomic-facet>

If you don’t set this property, the facet can be displayed on any tab. Otherwise, the facet won’t be displayed on any of the specified tabs.

string | string[]

'[]'

tabsIncluded

tabs-included

The tabs on which the facet can be displayed. This property should not be used at the same time as tabs-excluded.

Set this property as a stringified JSON array, e.g.,

 <atomic-facet tabs-included='["tabIDA", "tabIDB"]'></atomic-facet>

If you don’t set this property, the facet can be displayed on any tab. Otherwise, the facet can only be displayed on the specified tabs.

string | string[]

'[]'

withSearch

with-search

Whether this facet should contain a search box.

boolean

true

Shadow Parts

Part Description

clear-button

The button that resets the actively selected facet values.

clear-button-icon

The clear button icon.

facet

The wrapper for the entire facet.

label-button

The button that displays the label and allows to expand/collapse the facet.

label-button-icon

The label button icon.

matches-query

The highlighted query inside the matches labels.

more-matches

The label indicating there are more matches for the current facet search query.

no-matches

The label indicating there are no matches for the current facet search query.

placeholder

The placeholder shown before the first search is executed.

search-clear-button

The button to clear the search box of input.

search-highlight

The highlighted query inside the facet values.

search-icon

The search box submit button.

search-input

The search box input.

search-wrapper

The search box wrapper.

show-less

The show less results button.

show-more

The show more results button.

show-more-less-icon

The icons of the show more & show less buttons.

value-box

The facet value when display is 'box'.

value-box-selected

The selected facet value when display is 'box'.

value-checkbox

The facet value checkbox, available when display is 'checkbox'.

value-checkbox-checked

The checked facet value checkbox, available when display is 'checkbox'.

value-checkbox-icon

The facet value checkbox icon, available when display is 'checkbox'.

value-checkbox-label

The facet value checkbox clickable label, available when display is 'checkbox'.

value-count

The facet value count, common for all displays.

value-exclude-button

The button to exclude a facet value, available when display is 'checkbox'.

value-label

The facet value label, common for all displays.

value-link

The facet value when display is 'link'.

value-link-selected

The selected facet value when display is 'link'.

values

The facet values container.

CSS Custom Content

Name Description

--atomic-facet-boxes-gap

Gap value for facet values, when the display is 'box'

--atomic-facet-boxes-per-row

Number of facet values to display per row, when the display is 'box'

--atomic-facet-checkbox-size

Size of the checkbox.

--atomic-facet-search-clear-icon-size

The size of the facet search clear icon.

--atomic-facet-search-icon-size

The size of the facet search icon.