Merge pull request #782 from algolia/docs/cssClasses-array

docs(all): cssClasses is always {string|string[]}

src/widgets/hits-per-page-selector/hits-per-page-selector.js

@@ -16,8 +16,8 @@ import autoHideContainerHOC from '../../decorators/autoHideContainer.js';
  * @param  {string} options.options[0].label Label to display in the option
  * @param  {boolean} [options.autoHideContainer=false] Hide the container when no results match
  * @param  {Object} [options.cssClasses] CSS classes to be added
- * @param  {string} [options.cssClasses.root] CSS classes added to the parent `<select>`
- * @param  {string} [options.cssClasses.item] CSS classes added to each `<option>`
+ * @param  {string|string[]} [options.cssClasses.root] CSS classes added to the parent `<select>`
+ * @param  {string|string[]} [options.cssClasses.item] CSS classes added to each `<option>`
  * @return {Object}
  */
 

src/widgets/hits/hits.js

@@ -20,9 +20,9 @@ import defaultTemplates from './defaultTemplates.js';
  * @param  {Function} [options.transformData.item=identity] Method used to change the object passed to the item template
  * @param  {number} [hitsPerPage=20] The number of hits to display per page
  * @param  {Object} [options.cssClasses] CSS classes to add
- * @param  {string} [options.cssClasses.root] CSS class to add to the wrapping element
- * @param  {string} [options.cssClasses.empty] CSS class to add to the wrapping element when no results
- * @param  {string} [options.cssClasses.item] CSS class to add to each result
+ * @param  {string|string[]} [options.cssClasses.root] CSS class to add to the wrapping element
+ * @param  {string|string[]} [options.cssClasses.empty] CSS class to add to the wrapping element when no results
+ * @param  {string|string[]} [options.cssClasses.item] CSS class to add to each result
  * @return {Object}
  */
 const usage = `Usage:

src/widgets/numeric-selector/numeric-selector.js

@@ -19,8 +19,8 @@ let bem = utils.bemHelper('ais-numeric-selector');
  * @param  {string} [options.operator] The operator to use to refine
  * @param  {boolean} [options.autoHideContainer=false] Hide the container when no results match
  * @param  {Object} [options.cssClasses] CSS classes to be added
- * @param  {string} [options.cssClasses.root] CSS classes added to the parent `<select>`
- * @param  {string} [options.cssClasses.item] CSS classes added to each `<option>`
+ * @param  {string|string[]} [options.cssClasses.root] CSS classes added to the parent `<select>`
+ * @param  {string|string[]} [options.cssClasses.item] CSS classes added to each `<option>`
  * @return {Object}
  */
 

src/widgets/pagination/pagination.js

@@ -29,16 +29,16 @@ let defaultLabels = {
  * @param  {boolean} [options.showFirstLast=true] Define if the First and Last links should be displayed
  * @param  {boolean} [options.autoHideContainer=true] Hide the container when no results match
  * @param  {Object} [options.cssClasses] CSS classes to be added
- * @param  {string} [options.cssClasses.root] CSS classes added to the parent `<ul>`
- * @param  {string} [options.cssClasses.item] CSS classes added to each `<li>`
- * @param  {string} [options.cssClasses.link] CSS classes added to each link
- * @param  {string} [options.cssClasses.page] CSS classes added to page `<li>`
- * @param  {string} [options.cssClasses.previous] CSS classes added to the previous `<li>`
- * @param  {string} [options.cssClasses.next] CSS classes added to the next `<li>`
- * @param  {string} [options.cssClasses.first] CSS classes added to the first `<li>`
- * @param  {string} [options.cssClasses.last] CSS classes added to the last `<li>`
- * @param  {string} [options.cssClasses.active] CSS classes added to the active `<li>`
- * @param  {string} [options.cssClasses.disabled] CSS classes added to the disabled `<li>`
+ * @param  {string|string[]} [options.cssClasses.root] CSS classes added to the parent `<ul>`
+ * @param  {string|string[]} [options.cssClasses.item] CSS classes added to each `<li>`
+ * @param  {string|string[]} [options.cssClasses.link] CSS classes added to each link
+ * @param  {string|string[]} [options.cssClasses.page] CSS classes added to page `<li>`
+ * @param  {string|string[]} [options.cssClasses.previous] CSS classes added to the previous `<li>`
+ * @param  {string|string[]} [options.cssClasses.next] CSS classes added to the next `<li>`
+ * @param  {string|string[]} [options.cssClasses.first] CSS classes added to the first `<li>`
+ * @param  {string|string[]} [options.cssClasses.last] CSS classes added to the last `<li>`
+ * @param  {string|string[]} [options.cssClasses.active] CSS classes added to the active `<li>`
+ * @param  {string|string[]} [options.cssClasses.disabled] CSS classes added to the disabled `<li>`
  * @return {Object}
  */
 const usage = `Usage:

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

@@ -25,20 +25,20 @@ import cx from 'classnames';
  * @param  {string|Function} [options.labels.button] Button label
  * @param  {boolean} [options.autoHideContainer=true] Hide the container when no refinements available
  * @param  {Object} [options.cssClasses] CSS classes to add
- * @param  {string} [options.cssClasses.root] CSS class to add to the root element
- * @param  {string} [options.cssClasses.header] CSS class to add to the header element
- * @param  {string} [options.cssClasses.body] CSS class to add to the body element
- * @param  {string} [options.cssClasses.list] CSS class to add to the wrapping list element
- * @param  {string} [options.cssClasses.item] CSS class to add to each item element
- * @param  {string} [options.cssClasses.active] CSS class to add to the active item element
- * @param  {string} [options.cssClasses.link] CSS class to add to each link element
- * @param  {string} [options.cssClasses.form] CSS class to add to the form element
- * @param  {string} [options.cssClasses.label] CSS class to add to each wrapping label of the form
- * @param  {string} [options.cssClasses.input] CSS class to add to each input of the form
- * @param  {string} [options.cssClasses.currency] CSS class to add to each currency element of the form
- * @param  {string} [options.cssClasses.separator] CSS class to add to the separator of the form
- * @param  {string} [options.cssClasses.button] CSS class to add to the submit button of the form
- * @param  {string} [options.cssClasses.footer] CSS class to add to the footer element
+ * @param  {string|string[]} [options.cssClasses.root] CSS class to add to the root element
+ * @param  {string|string[]} [options.cssClasses.header] CSS class to add to the header element
+ * @param  {string|string[]} [options.cssClasses.body] CSS class to add to the body element
+ * @param  {string|string[]} [options.cssClasses.list] CSS class to add to the wrapping list element
+ * @param  {string|string[]} [options.cssClasses.item] CSS class to add to each item element
+ * @param  {string|string[]} [options.cssClasses.active] CSS class to add to the active item element
+ * @param  {string|string[]} [options.cssClasses.link] CSS class to add to each link element
+ * @param  {string|string[]} [options.cssClasses.form] CSS class to add to the form element
+ * @param  {string|string[]} [options.cssClasses.label] CSS class to add to each wrapping label of the form
+ * @param  {string|string[]} [options.cssClasses.input] CSS class to add to each input of the form
+ * @param  {string|string[]} [options.cssClasses.currency] CSS class to add to each currency element of the form
+ * @param  {string|string[]} [options.cssClasses.separator] CSS class to add to the separator of the form
+ * @param  {string|string[]} [options.cssClasses.button] CSS class to add to the submit button of the form
+ * @param  {string|string[]} [options.cssClasses.footer] CSS class to add to the footer element
  * @return {Object}
  */
 const usage = `Usage:

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

@@ -17,8 +17,8 @@ import autoHideContainerHOC from '../../decorators/autoHideContainer.js';
  * @param  {string} options.indices[0].label Label displayed in the dropdown
  * @param  {boolean} [options.autoHideContainer=false] Hide the container when no results match
  * @param  {Object} [options.cssClasses] CSS classes to be added
- * @param  {string} [options.cssClasses.root] CSS classes added to the parent <select>
- * @param  {string} [options.cssClasses.item] CSS classes added to each <option>
+ * @param  {string|string[]} [options.cssClasses.root] CSS classes added to the parent <select>
+ * @param  {string|string[]} [options.cssClasses.item] CSS classes added to each <option>
  * @return {Object}
  */
 const usage = `Usage:

src/widgets/stats/stats.js

@@ -20,11 +20,11 @@ import defaultTemplates from './defaultTemplates.js';
  * @param  {Function} [options.transformData] Function to change the object passed to the `body` template
  * @param  {boolean} [options.autoHideContainer=true] Hide the container when no results match
  * @param  {Object} [options.cssClasses] CSS classes to add
- * @param  {string} [options.cssClasses.root] CSS class to add to the root element
- * @param  {string} [options.cssClasses.header] CSS class to add to the header element
- * @param  {string} [options.cssClasses.body] CSS class to add to the body element
- * @param  {string} [options.cssClasses.footer] CSS class to add to the footer element
- * @param  {string} [options.cssClasses.time] CSS class to add to the element wrapping the time processingTimeMs
+ * @param  {string|string[]} [options.cssClasses.root] CSS class to add to the root element
+ * @param  {string|string[]} [options.cssClasses.header] CSS class to add to the header element
+ * @param  {string|string[]} [options.cssClasses.body] CSS class to add to the body element
+ * @param  {string|string[]} [options.cssClasses.footer] CSS class to add to the footer element
+ * @param  {string|string[]} [options.cssClasses.time] CSS class to add to the element wrapping the time processingTimeMs
  * @return {Object}
  */
 const usage = `Usage: