Facets Component

Class Name

The Facets Component is implemented by the following class:

org.onehippo.cms7.essentials.components.EssentialsFacetsComponent

Overview

Bloomreach Content supports faceted navigation out of the box. Faceted navigation allows users to filter and refine search results based on specific document properties (facets). For example, you can display all news documents from the current month that relate to the topic "weather".

In the content repository, faceted navigation is represented by a virtual facet navigation node tree. The Facets component retrieves a HippoFacetNavigationBean and provides it to the rendering template. This bean exposes the available facet navigation filters for rendering.

Component Parameters

Name Description

facetPath Required. Repository path relative to the site's root folder. The Facets component first checks the current request URL and site map. If the corresponding repository node is a facet navigation node, the component provides the related HippoFacetNavigationBean. This typically occurs when a site visitor selects one or more facet navigation filters. If the node is not a facet navigation node, the component uses this parameter to locate the desired HippoFacetNavigationBean. Usually, facetPath points to the root node of a facet navigation tree.

query Optional. Free-text query string. The fields searched depend on your indexing configuration. This parameter can be overridden by a request parameter.

Name	Description
facetPath	Required. Repository path relative to the site's root folder. The Facets component first checks the current request URL and site map. If the corresponding repository node is a facet navigation node, the component provides the related `HippoFacetNavigationBean`. This typically occurs when a site visitor selects one or more facet navigation filters. If the node is not a facet navigation node, the component uses this parameter to locate the desired `HippoFacetNavigationBean`. Usually, `facetPath` points to the root node of a facet navigation tree.
query	Optional. Free-text query string. The fields searched depend on your indexing configuration. This parameter can be overridden by a request parameter.

Request Parameters

Name	Description
query	Free-text query string. This parameter overrides the component's `query` parameter. Note: Free-text queries do not work when querying within a facet navigation scope.

Rendering Attributes

Name	Type	Description
facets	`org.hippoecm.hst.content.beans.standard.HippoFacetNavigationBean`	A bean (or `null`) representing the current position in the facet navigation tree. The rendering template can use this bean to generate a list of filters and filter values.
query	`java.lang.String`	The normalized free-text query string, sourced from either the request or the component parameter.