React
TheGuidesHeadlines widget lets you reference and render different guides on your website.
Installation
The Algolia Guides React package is available on the npm registry.Usage
React
Parameters
Whether to show the feedback widget.
If true, you also need to provide a
userToken.Search parameters that are applied when fetching headlines.
Can be used for pagination or custom filtering.Not all search parameters are supported.
Some parameters are ignored to ensure the correct functioning of the widget:
facetFilters, hitsPerPage, optionalFilters, attributesToHighlight and getRankingInfo.For more information, see API parameters.A render function to fully customize what’s displayed.The default implementation is:
React
The view component into which your guide headlines will be rendered.The default implementation is:
React
Component to display the headlines.
JavaScript
TheguidesHeadlines widget lets you reference and render different guides on your website.
Installation
The Algolia Guides JavaScript package is available on the npm registry.Usage
JavaScript
Parameters
Whether to show the feedback widget.
If true, you also need to provide a
userToken.A render function to fully customize what’s displayed.The default implementation is:
JavaScript
The view component into which your guide headlines will be rendered.The default implementation is:
JavaScript
Component to display the headlines.