File tree Expand file tree Collapse file tree 1 file changed +6
-6
lines changed
Expand file tree Collapse file tree 1 file changed +6
-6
lines changed Original file line number Diff line number Diff line change @@ -36,18 +36,18 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
3636
3737/**
3838 * @typedef {Object } HierarchicalMenuRenderingOptions
39- * @property {string } attributeNameKey
40- * @property {function } createURL
41- * @property {Object[] } items
42- * @property {function } refine
43- * @property {InstantSearch } instantSearchInstance
39+ * @property {string } attributeNameKey the key to be used on the items
40+ * @property {function } createURL function that create a url for the next state
41+ * @property {Object[] } items the values to be rendered
42+ * @property {function } refine set the path of the hierarchical filter and triggers a new search
43+ * @property {InstantSearch } instantSearchInstance the instance of instantsearch on which the widget is attached
4444 * @property {Object } widgetParams all original options forwarded to rendering
4545 */
4646
4747 /**
4848 * Connects a rendering function with the toggle business logic.
4949 * @param {function(HierarchicalMenuRenderingOptions) } renderFn function that renders the toggle widget
50- * @return {function(CustomHierarchicalMenuWidgetOptions) } a widget factory for toggle widget
50+ * @return {function(CustomHierarchicalMenuWidgetOptions) } a custom toggle widget factory
5151 */
5252export default function connectHierarchicalMenu ( renderFn ) {
5353 checkRendering ( renderFn , usage ) ;
You can’t perform that action at this time.
0 commit comments