fix(documentationjs): fixed default value parameter

Author: Alexandre Stanislawski

docgen/layouts/mixins/documentationjs/widget-usage.pug

@@ -1,7 +1,9 @@
 mixin widgetUsage(fnSymbol)
-  - const paramsTypeName = fnSymbol.params[0].type.name;
-  if paramsTypeName && paramsTypeName !== 'Object'
-    - const paramsType = fnSymbol.relatedTypes && fnSymbol.relatedTypes.find(t => t.name === paramsTypeName);
+  - const paramTag = fnSymbol.tags.find(tag => tag.title === 'param' && tag.name === '$0');
+  if paramTag && paramTag.type
+    - const paramTypeName = paramTag.type.name;
+    - const paramsType = fnSymbol.relatedTypes && fnSymbol.relatedTypes.find(t => t.name === paramTypeName);
+    - if(!paramsType) console.log(fnSymbol.relatedTypes.map(t => t.name));
     - const properties = '\n' + paramsType.properties.map(p => `  ${p.name}: ${p.type.name}`).join(',\n');
     pre.CodeMirror.cm-s-mdn-like
       code

docgen/plugins/documentationjs-data.js

@@ -83,11 +83,14 @@ function mapWidgets(widgets, symbols, files) {
     // console.log(symbol.name);
     const fileName = `widgets/${symbol.name}.html`;
 
+    const relatedTypes = findRelatedTypes(symbol, symbols);
+
     const symbolWithRelatedType = {
       ...symbol,
-      relatedTypes: findRelatedTypes(symbol, symbols),
+      relatedTypes,
     };
 
+
     files[fileName] = {
       mode: '0764',
       contents: '',

src/widgets/price-ranges/price-ranges.js

@@ -67,34 +67,41 @@ priceRanges({
 })`;
 
 /**
- * Instantiate a price ranges on a numerical facet
+ * @typedef {Object} PriceRangeClasses
+ * @property  {string|string[]} [root] CSS class to add to the root element
+ * @property  {string|string[]} [header] CSS class to add to the header element
+ * @property  {string|string[]} [body] CSS class to add to the body element
+ * @property  {string|string[]} [list] CSS class to add to the wrapping list element
+ * @property  {string|string[]} [item] CSS class to add to each item element
+ * @property  {string|string[]} [active] CSS class to add to the active item element
+ * @property  {string|string[]} [link] CSS class to add to each link element
+ * @property  {string|string[]} [form] CSS class to add to the form element
+ * @property  {string|string[]} [label] CSS class to add to each wrapping label of the form
+ * @property  {string|string[]} [input] CSS class to add to each input of the form
+ * @property  {string|string[]} [currency] CSS class to add to each currency element of the form
+ * @property  {string|string[]} [separator] CSS class to add to the separator of the form
+ * @property  {string|string[]} [button] CSS class to add to the submit button of the form
+ * @property  {string|string[]} [footer] CSS class to add to the footer element
+ */
+
+/**
+ * @typedef {Object} PriceRangeWidgetOptions
+ * @property  {string|DOMElement} container Valid CSS Selector as a string or DOMElement
+ * @property  {string} attributeName Name of the attribute for faceting
+ * @property  {Object} [templates] Templates to use for the widget
+ * @property  {string|Function} [templates.item] Item template. Template data: `from`, `to` and `currency`
+ * @property  {string} [currency='$'] The currency to display
+ * @property  {Object} [labels] Labels to use for the widget
+ * @property  {string|Function} [labels.separator] Separator label, between min and max
+ * @property  {string|Function} [labels.button] Button label
+ * @property  {boolean} [autoHideContainer=true] Hide the container when no refinements available
+ * @property  {PriceRangeClasses} [cssClasses] CSS classes to add
+ * @property  {{collapsed: boolean}|boolean} [collapsible=false] Hide the widget body and footer when clicking on header
+ */
+
+/**
  * @type {WidgetFactory}
- * @param  {string|DOMElement} $0.container Valid CSS Selector as a string or DOMElement
- * @param  {string} $0.attributeName Name of the attribute for faceting
- * @param  {Object} [$0.templates] Templates to use for the widget
- * @param  {string|Function} [$0.templates.item] Item template. Template data: `from`, `to` and `currency`
- * @param  {string} [$0.currency='$'] The currency to display
- * @param  {Object} [$0.labels] Labels to use for the widget
- * @param  {string|Function} [$0.labels.separator] Separator label, between min and max
- * @param  {string|Function} [$0.labels.button] Button label
- * @param  {boolean} [$0.autoHideContainer=true] Hide the container when no refinements available
- * @param  {Object} [$0.cssClasses] CSS classes to add
- * @param  {string|string[]} [$0.cssClasses.root] CSS class to add to the root element
- * @param  {string|string[]} [$0.cssClasses.header] CSS class to add to the header element
- * @param  {string|string[]} [$0.cssClasses.body] CSS class to add to the body element
- * @param  {string|string[]} [$0.cssClasses.list] CSS class to add to the wrapping list element
- * @param  {string|string[]} [$0.cssClasses.item] CSS class to add to each item element
- * @param  {string|string[]} [$0.cssClasses.active] CSS class to add to the active item element
- * @param  {string|string[]} [$0.cssClasses.link] CSS class to add to each link element
- * @param  {string|string[]} [$0.cssClasses.form] CSS class to add to the form element
- * @param  {string|string[]} [$0.cssClasses.label] CSS class to add to each wrapping label of the form
- * @param  {string|string[]} [$0.cssClasses.input] CSS class to add to each input of the form
- * @param  {string|string[]} [$0.cssClasses.currency] CSS class to add to each currency element of the form
- * @param  {string|string[]} [$0.cssClasses.separator] CSS class to add to the separator of the form
- * @param  {string|string[]} [$0.cssClasses.button] CSS class to add to the submit button of the form
- * @param  {string|string[]} [$0.cssClasses.footer] CSS class to add to the footer element
- * @param  {object|boolean} [$0.collapsible=false] Hide the widget body and footer when clicking on header
- * @param  {boolean} [$0.collapsible.collapsed] Initial collapsed state of a collapsible widget
+ * @param {PriceRangeWidgetOptions} $0 The price ranges widget options.
  * @return {Object} widget
  */
 export default function priceRanges({

src/widgets/range-slider/range-slider.js

@@ -149,7 +149,7 @@ export default function rangeSlider({
   min,
   max,
   precision = 2,
-}) {
+} = {}) {
   if (!container) {
     throw new Error(usage);
   }

src/widgets/refinement-list/refinement-list.js

@@ -189,7 +189,7 @@ export default function refinementList({
   autoHideContainer = true,
   showMore = false,
   searchForFacetValues = false,
-}) {
+} = {}) {
   if (!container) {
     throw new Error(usage);
   }

src/widgets/search-box/search-box.js

@@ -167,7 +167,7 @@ export default function searchBox({
   autofocus = 'auto',
   searchOnEnterKeyPressOnly = false,
   queryHook,
-}) {
+} = {}) {
   if (!container) {
     throw new Error(usage);
   }

src/widgets/sort-by-selector/sort-by-selector.js

@@ -76,7 +76,7 @@ export default function sortBySelector({
   indices,
   cssClasses: userCssClasses = {},
   autoHideContainer = false,
-}) {
+} = {}) {
   if (!container) {
     throw new Error(usage);
   }

src/widgets/star-rating/star-rating.js

@@ -141,7 +141,7 @@ export default function starRating({
   collapsible = false,
   transformData,
   autoHideContainer = true,
-}) {
+} = {}) {
   if (!container) {
     throw new Error(usage);
   }

src/widgets/stats/stats.js

@@ -130,7 +130,7 @@ export default function stats({
   collapsible = false,
   transformData,
   templates = defaultTemplates,
-}) {
+} = {}) {
   if (!container) {
     throw new Error(usage);
   }

src/widgets/toggle/toggle.js

@@ -148,7 +148,7 @@ export default function toggle({
   autoHideContainer = true,
   collapsible = false,
   values: userValues = {on: true, off: undefined},
-}) {
+} = {}) {
   if (!container) {
     throw new Error(usage);
   }