feat(hierarchical): expose rootPath and showParentLevel

Author: maxiloc

docs/_includes/widget-jsdoc/hierarchicalMenu.md

@@ -3,6 +3,8 @@
 | <span class='attr-required'>`options.container`</span><span class="attr-infos">Type: <code>string</code> &#124; <code>DOMElement</code></span> | CSS Selector or DOMElement to insert the widget |
 | <span class='attr-required'>`options.attributes`</span><span class="attr-infos">Type: <code>Array.&lt;string&gt;</code></span> | Array of attributes to use to generate the hierarchy of the menu. Refer to [the readme](https://github.com/algolia/algoliasearch-helper-js#hierarchical-facets) for the convention to follow. |
 | <span class='attr-optional'>`options.separator`</span><span class="attr-infos">Default:<code class="attr-default">&#x27; &gt; &#x27;</code><br />Type: <code>string</code></span> | Separator used in the attributes to separate level values. |
+| <span class='attr-optional'>`options.rootPath`</span><span class="attr-infos">Type: <code>string</code></span> | Prefix path to use if the first level is not the root level. |
+| <span class='attr-optional'>`options.showParentLevel`</span><span class="attr-infos">Default:<code class="attr-default">false</code><br />Type: <code>string</code></span> | Show the parent level of the current refined value |
 | <span class='attr-optional'>`options.limit`</span><span class="attr-infos">Default:<code class="attr-default">100</code><br />Type: <code>number</code></span> | How much facet values to get |
 | <span class='attr-optional'>`options.sortBy`</span><span class="attr-infos">Default:<code class="attr-default">[&#x27;name:asc&#x27;]</code><br />Type: <code>Array.&lt;string&gt;</code></span> | How to sort refinements. Possible values: `count|isRefined|name:asc|desc` |
 | <span class='attr-optional'>`options.templates`</span><span class="attr-infos">Type: <code>Object</code></span> | Templates to use for the widget |

npm-shrinkwrap.json

@@ -71,7 +71,7 @@
   },
   "dependencies": {
     "algoliasearch": "^3.9.1",
-    "algoliasearch-helper": "^2.6.7",
+    "algoliasearch-helper": "^2.6.9",
     "classnames": "^2.2.0",
     "events": "^1.1.0",
     "hogan.js": "^3.0.2",

package.json

@@ -80,8 +80,10 @@ describe('hierarchicalMenu()', () => {
       ).toEqual({
         hierarchicalFacets: [{
           name: 'hello',
+          rootPath: null,
           attributes: ['hello', 'world'],
-          separator: ' > '
+          separator: ' > ',
+          showParentLevel: true
         }]
       });
     });
@@ -92,8 +94,38 @@ describe('hierarchicalMenu()', () => {
       ).toEqual({
         hierarchicalFacets: [{
           name: 'hello',
+          rootPath: null,
           attributes: ['hello', 'world'],
-          separator: ' ? '
+          separator: ' ? ',
+          showParentLevel: true
+        }]
+      });
+    });
+
+    it('understand the showParentLevel option', () => {
+      expect(
+        hierarchicalMenu({showParentLevel: false, ...options}).getConfiguration()
+      ).toEqual({
+        hierarchicalFacets: [{
+          name: 'hello',
+          rootPath: null,
+          attributes: ['hello', 'world'],
+          separator: ' > ',
+          showParentLevel: false
+        }]
+      });
+    });
+
+    it('understand the rootPath option', () => {
+      expect(
+        hierarchicalMenu({rootPath: 'Beer', ...options}).getConfiguration()
+      ).toEqual({
+        hierarchicalFacets: [{
+          name: 'hello',
+          rootPath: 'Beer',
+          attributes: ['hello', 'world'],
+          separator: ' > ',
+          showParentLevel: true
         }]
       });
     });

src/widgets/hierarchical-menu/__tests__/hierarchical-menu-test.js

@@ -16,6 +16,8 @@ let defaultTemplates = require('./defaultTemplates.js');
  * @param  {string[]} options.attributes Array of attributes to use to generate the hierarchy of the menu.
  * Refer to [the readme](https://github.com/algolia/algoliasearch-helper-js#hierarchical-facets) for the convention to follow.
  * @param  {string} [options.separator=' > '] Separator used in the attributes to separate level values.
+ * @param  {string} [options.rootPath] Prefix path to use if the first level is not the root level.
+ * @param  {string} [options.showParentLevel=false] Show the parent level of the current refined value
  * @param  {number} [options.limit=100] How much facet values to get
  * @param  {string[]} [options.sortBy=['name:asc']] How to sort refinements. Possible values: `count|isRefined|name:asc|desc`
  * @param  {Object} [options.templates] Templates to use for the widget
@@ -42,6 +44,8 @@ hierarchicalMenu({
   container,
   attributes,
   [ separator=' > ' ],
+  [ rootPath ],
+  [ showParentLevel=true ],
   [ limit=1000 ],
   [ sortBy=['name:asc'] ],
   [ cssClasses.{root , header, body, footer, list, depth, item, active, link}={} ],
@@ -53,6 +57,8 @@ function hierarchicalMenu({
     container,
     attributes,
     separator = ' > ',
+    rootPath = null,
+    showParentLevel = true,
     limit = 1000,
     sortBy = ['name:asc'],
     cssClasses: userCssClasses = {},
@@ -81,7 +87,9 @@ function hierarchicalMenu({
       hierarchicalFacets: [{
         name: hierarchicalFacetName,
         attributes,
-        separator
+        separator,
+        rootPath,
+        showParentLevel
       }]
     }),
     render: function({results, helper, templatesConfig, createURL, state}) {