fix(hideIfEmpty): should be hideWhenNoResults

dunno why it was commited this way. reverting
algolia · Sep 24, 2015 · 21877a0 · 21877a0
1 parent 3cc48f3
commit 21877a0
Show file tree

Hide file tree

Showing 10 changed files with 30 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -265,7 +265,7 @@ search.addWidget(
  * @param  {String|DOMElement} options.container Valid CSS Selector as a string or DOMElement
  * @param  {Array} options.indices Array of objects defining the different indices to choose from. Each object must contain a `name` and `label` key.
  * @param  {String} [options.cssClass] Class name(s) to be added to the generated select element
- * @param  {boolean} [hideIfEmpty=false] Hide the container when no results match
+ * @param  {boolean} [hideWhenNoResults=false] Hide the container when no results match
  * @return {Object}
  */
 ```
@@ -362,7 +362,7 @@ search.addWidget(
  * @param  {String} options.label Human-readable name of the filter (eg. "Free Shipping")
  * @param  {String|Function} [options.template] Item template, provided with `label` and `isRefined`
  * @param  {Function} [options.transformData] Function to change the object passed to the item template
- * @param  {boolean} [hideIfEmpty=true] Hide the container when no results match
+ * @param  {boolean} [hideWhenNoResults=true] Hide the container when no results match
  * @return {Object}
  */
 ```
@@ -395,7 +395,7 @@ search.addWidget(
  * @param  {Function} [options.transformData] Function to change the object passed to the item template
  * @param  {String|Function} [options.singleRefine=true] Are multiple refinements allowed or only one at the same time. You can use this
  *                                                       to build radio based refinement lists for example
- * @param  {boolean} [hideIfEmpty=true] Hide the container when no results match
+ * @param  {boolean} [hideWhenNoResults=true] Hide the container when no results match
  * @return {Object}
  */
 ```
@@ -439,7 +439,7 @@ search.addWidget(
  * @param  {String|Function} [options.templates.item='<a href="{{href}}">{{name}}</a> {{count}}'] Item template, provided with `name`, `count`, `isRefined`
  * @param  {String|Function} [options.templates.footer=''] Footer template
  * @param  {Function} [options.transformData] Function to change the object passed to the item template
- * @param  {boolean} [hideIfEmpty=true] Hide the container when no results match
+ * @param  {boolean} [hideWhenNoResults=true] Hide the container when no results match
  * @return {Object}
  */
 ```
@@ -476,7 +476,7 @@ search.addWidget(
  * You can also provide
  * tooltips: {format: function(formattedValue, rawValue) {return '$' + formattedValue}}
  * So that you can format the tooltip display value as you want
- * @param  {boolean} [hideIfEmpty=true] Hide the container when no results match
+ * @param  {boolean} [hideWhenNoResults=true] Hide the container when no results match
  * @return {Object}
  */
 ```

diff --git a/decorators/autoHide.js b/decorators/autoHide.js
@@ -12,16 +12,16 @@ function autoHide(ComposedComponent) {
 
     _hideOrShowContainer(props) {
       var container = React.findDOMNode(this).parentNode;
-      if (props.hideIfEmpty === true && props.hasResults === false) {
+      if (props.hideWhenNoResults === true && props.hasResults === false) {
         container.style.display = 'none';
-      } else if (props.hideIfEmpty === true) {
+      } else if (props.hideWhenNoResults === true) {
         container.style.display = '';
       }
     }
 
     render() {
       if (this.props.hasResults === false &&
-        this.props.hideIfEmpty === true) {
+        this.props.hideWhenNoResults === true) {
         return <div/>;
       }
 
@@ -31,7 +31,7 @@ function autoHide(ComposedComponent) {
 
   AutoHide.propTypes = {
     hasResults: React.PropTypes.bool.isRequired,
-    hideIfEmpty: React.PropTypes.bool.isRequired
+    hideWhenNoResults: React.PropTypes.bool.isRequired
   };
 
   // precise displayName for ease of debugging (react dev tool, react warnings)

diff --git a/widgets/hits.js b/widgets/hits.js
@@ -6,7 +6,7 @@ function hits({
     container = null,
     templates = {},
     transformData = {},
-    hideIfEmpty = false,
+    hideWhenNoResults = false,
     hitsPerPage = 20
   }) {
   var Hits = require('../components/Hits');
@@ -23,7 +23,7 @@ function hits({
           helper={helper}
           noResultsTemplate={templates.empty}
           noResultsTransformData={transformData.empty}
-          hideIfEmpty={hideIfEmpty}
+          hideWhenNoResults={hideWhenNoResults}
           hasResults={results.hits.length > 0}
           hitTemplate={templates.hit}
           hitTransformData={transformData.hit}

diff --git a/widgets/index-selector.js b/widgets/index-selector.js
@@ -8,14 +8,14 @@ var utils = require('../lib/utils.js');
  * @param  {String|DOMElement} options.container Valid CSS Selector as a string or DOMElement
  * @param  {Array} options.indices Array of objects defining the different indices to choose from. Each object must contain a `name` and `label` key.
  * @param  {String} [options.cssClass] Class name(s) to be added to the generated select element
- * @param  {boolean} [hideIfEmpty=false] Hide the container when no results match
+ * @param  {boolean} [hideWhenNoResults=false] Hide the container when no results match
  * @return {Object}
  */
 function indexSelector({
     container = null,
     indices = null,
     cssClass,
-    hideIfEmpty = false
+    hideWhenNoResults = false
   }) {
   var IndexSelector = require('../components/IndexSelector');
   var containerNode = utils.getContainerNode(container);
@@ -42,7 +42,7 @@ function indexSelector({
           cssClass={cssClass}
           currentIndex={helper.getIndex()}
           indices={indices}
-          hideIfEmpty={hideIfEmpty}
+          hideWhenNoResults={hideWhenNoResults}
           hasResults={results.hits.length > 0}
           setIndex={helper.setIndex.bind(helper)}
         />,

diff --git a/widgets/menu.js b/widgets/menu.js
@@ -28,7 +28,7 @@ var defaults = require('lodash/object/defaults');
  * @param  {String|Function} [options.templates.item='<a href="{{href}}">{{name}}</a> {{count}}'] Item template, provided with `name`, `count`, `isRefined`
  * @param  {String|Function} [options.templates.footer=''] Footer template
  * @param  {Function} [options.transformData] Method to change the object passed to the item template
- * @param  {boolean} [hideIfEmpty=true] Hide the container when no results match
+ * @param  {boolean} [hideWhenNoResults=true] Hide the container when no results match
  * @return {Object}
  */
 function menu({
@@ -41,7 +41,7 @@ function menu({
       list: null,
       item: null
     },
-    hideIfEmpty = true,
+    hideWhenNoResults = true,
     templates = defaultTemplates,
     transformData = null
   }) {
@@ -78,7 +78,7 @@ function menu({
           facetValues={facetValues}
           templates={templates}
           transformData={transformData}
-          hideIfEmpty={hideIfEmpty}
+          hideWhenNoResults={hideWhenNoResults}
           hasResults={facetValues.length > 0}
           toggleRefinement={toggleRefinement.bind(null, helper, hierarchicalFacetName)}
         />,

diff --git a/widgets/pagination.js b/widgets/pagination.js
@@ -8,7 +8,7 @@ function pagination({
     labels,
     maxPages,
     showFirstLast,
-    hideIfEmpty = true
+    hideWhenNoResults = true
   }) {
   var Pagination = require('../components/Pagination/Pagination.js');
 
@@ -28,7 +28,7 @@ function pagination({
           nbPages={nbPages}
           setCurrentPage={helper.setCurrentPage.bind(helper)}
           cssClass={cssClass}
-          hideIfEmpty={hideIfEmpty}
+          hideWhenNoResults={hideWhenNoResults}
           hasResults={results.hits.length > 0}
           labels={labels}
           showFirstLast={showFirstLast}

diff --git a/widgets/range-slider.js b/widgets/range-slider.js
@@ -11,14 +11,14 @@ var utils = require('../lib/utils.js');
  * You can also provide
  * tooltips: {format: function(formattedValue, rawValue) {return '$' + formattedValue}}
  * So that you can format the tooltip display value as you want
- * @param  {boolean} [hideIfEmpty=true] Hide the container when no results match
+ * @param  {boolean} [hideWhenNoResults=true] Hide the container when no results match
  * @return {Object}
  */
 function rangeSlider({
     container = null,
     facetName = null,
     tooltips = true,
-    hideIfEmpty = true
+    hideWhenNoResults = true
   }) {
   var Slider = require('../components/Slider');
 
@@ -71,7 +71,7 @@ function rangeSlider({
         <Slider
           start={[currentRefinement.min, currentRefinement.max]}
           range={{min: stats.min, max: stats.max}}
-          hideIfEmpty={hideIfEmpty}
+          hideWhenNoResults={hideWhenNoResults}
           hasResults={stats.min !== null && stats.max !== null}
           onChange={this._refine.bind(this, helper)}
           tooltips={tooltips}

diff --git a/widgets/refinement-list.js b/widgets/refinement-list.js
@@ -32,7 +32,7 @@ var defaults = require('lodash/object/defaults');
  * @param  {Function} [options.transformData] Function to change the object passed to the item template
  * @param  {String|Function} [options.singleRefine=true] Are multiple refinements allowed or only one at the same time. You can use this
  *                                                       to build radio based refinement lists for example
- * @param  {boolean} [hideIfEmpty=true] Hide the container when no results match
+ * @param  {boolean} [hideWhenNoResults=true] Hide the container when no results match
  * @return {Object}
  */
 function refinementList({
@@ -46,7 +46,7 @@ function refinementList({
       list: null,
       item: null
     },
-    hideIfEmpty = true,
+    hideWhenNoResults = true,
     templates = defaultTemplates,
     transformData = null,
     singleRefine = false
@@ -87,7 +87,7 @@ function refinementList({
           facetValues={facetValues}
           templates={templates}
           transformData={transformData}
-          hideIfEmpty={hideIfEmpty}
+          hideWhenNoResults={hideWhenNoResults}
           hasResults={facetValues.length > 0}
           toggleRefinement={toggleRefinement.bind(null, helper, singleRefine, facetName)}
         />,

diff --git a/widgets/stats/index.js b/widgets/stats/index.js
@@ -7,7 +7,7 @@ function stats({
     container = null,
     template = defaultTemplate,
     transformData = null,
-    hideIfEmpty = true
+    hideWhenNoResults = true
   }) {
   var Stats = require('../../components/Stats');
   var containerNode = utils.getContainerNode(container);
@@ -21,7 +21,7 @@ function stats({
       React.render(
         <Stats
           hasResults={results.hits.length > 0}
-          hideIfEmpty={hideIfEmpty}
+          hideWhenNoResults={hideWhenNoResults}
           hitsPerPage={results.hitsPerPage}
           nbHits={results.nbHits}
           nbPages={results.nbPages}

diff --git a/widgets/toggle.js b/widgets/toggle.js
@@ -12,7 +12,7 @@ var defaultTemplate = '<label>{{label}}<input type="checkbox" {{#isRefined}}chec
  * @param  {String} options.label Human-readable name of the filter (eg. "Free Shipping")
  * @param  {String|Function} [options.template] Item template, provided with `label` and `isRefined`
  * @param  {Function} [options.transformData] Function to change the object passed to the item template
- * @param  {boolean} [hideIfEmpty=true] Hide the container when no results match
+ * @param  {boolean} [hideWhenNoResults=true] Hide the container when no results match
  * @return {Object}
  */
 function toggle({
@@ -21,7 +21,7 @@ function toggle({
     label = null,
     template = defaultTemplate,
     transformData = null,
-    hideIfEmpty = true
+    hideWhenNoResults = true
   }) {
   var Toggle = require('../components/Toggle');
 
@@ -50,7 +50,7 @@ function toggle({
           label={label}
           template={template}
           transformData={transformData}
-          hideIfEmpty={hideIfEmpty}
+          hideWhenNoResults={hideWhenNoResults}
           hasResults={results.hits.length > 0}
           toggleFilter={toggleFilter}
         />,