Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Catalogue

The <lens-catalogue> component renders the catalgue in a collapsible tree structure. The catalogue can be optionally collapsible, and will auto-expand based on configuration. If the options includes a facetCount input, it automatically fetches and updates facet counts on mount.

This component loads all elements from the catalogue store and lensOptions, uses DataTreeElement for each node, and offers customizable toggle behavior. Styling is exposed through ::part() attributes.


Props

PropTypeDefaultDescription
toggle{ collapsable?: boolean; open?: boolean }{ collapsable: true, open: false }Controls whether the catalogue is collapsible and its default open state.

Usage

<lens-catalogue
    toggle={{ collapsable: true, open: true }}
></lens-catalogue>

For a more in depth description of the structure see catalogue guide.


Styling

Part NameDescription
lens-catalogueMain container of the catalogue
lens-catalogue-wrapperWrapper around all top-level nodes
lens-catalogue-toggle-buttonThe expand/collapse toggle button
lens-catalogue-toggle-button-closed-iconIcon when the catalogue is collapsed
lens-catalogue-toggle-button-iconThe icon stlye
lens-catalogue-toggle-button-open-textThe label next to the icon