feat: multipleChoiceList => refinementList

fixes #64
algolia · Sep 8, 2015 · 423542d · 423542d
1 parent a52fb6d
commit 423542d
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ API is unstable. We welcome any idea.
   - [pagination](#pagination)
   - [hits](#hits)
   - [toggle](#toggle)
-  - [multipleChoiceList](#multiplechoicelist)
+  - [refinementList](#refinementlist)
   - [menu](#menu)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -248,7 +248,7 @@ search.addWidget(
 ```
 
 
-### multipleChoiceList
+### refinementList
 
 #### API
 
@@ -278,7 +278,7 @@ search.addWidget(
 
 ```js
 search.addWidget(
-  instantsearch.widgets.multipleChoiceList({
+  instantsearch.widgets.refinementList({
     container: '#brands', 
     facetName: 'brands',
     operator: 'or'

diff --git a/components/MultipleChoiceList.js → components/RefinementList.js b/components/MultipleChoiceList.js → components/RefinementList.js
@@ -2,7 +2,7 @@ var React = require('react');
 
 var Template = require('./Template');
 
-class MultipleChoiceList extends React.Component {
+class RefinementList extends React.Component {
   refine(value) {
     this.props.toggleRefine(value);
   }
@@ -58,7 +58,7 @@ class MultipleChoiceList extends React.Component {
   }
 }
 
-MultipleChoiceList.propTypes = {
+RefinementList.propTypes = {
   rootClass: React.PropTypes.oneOfType([
     React.PropTypes.string,
     React.PropTypes.arrayOf(React.PropTypes.string)
@@ -75,4 +75,4 @@ MultipleChoiceList.propTypes = {
   toggleRefine: React.PropTypes.func.isRequired
 };
 
-module.exports = MultipleChoiceList;
+module.exports = RefinementList;
diff --git a/example/app.js b/example/app.js
@@ -54,7 +54,7 @@ search.addWidget(
 );
 
 search.addWidget(
-  instantsearch.widgets.multipleChoiceList({
+  instantsearch.widgets.refinementList({
     container: '#brands',
     facetName: 'brand',
     operator: 'or',

diff --git a/index.js b/index.js
@@ -4,7 +4,7 @@ module.exports = {
     hits: require('./widgets/hits'),
     indexSelector: require('./widgets/index-selector'),
     menu: require('./widgets/menu'),
-    multipleChoiceList: require('./widgets/multiple-choice-list'),
+    refinementList: require('./widgets/refinement-list'),
     pagination: require('./widgets/pagination'),
     searchBox: require('./widgets/search-box'),
     stats: require('./widgets/stats'),

diff --git a/widgets/menu.js b/widgets/menu.js
@@ -29,7 +29,7 @@ function menu({
   }) {
   hierarchicalCounter++;
 
-  var MultipleChoiceList = require('../components/MultipleChoiceList');
+  var RefinementList = require('../components/RefinementList');
 
   var containerNode = utils.getContainerNode(container);
   var usage = 'Usage: menu({container, facetName, [sortBy, limit, rootClass, itemClass, template]})';
@@ -49,7 +49,7 @@ function menu({
     }),
     render: function(results, state, helper) {
       React.render(
-        <MultipleChoiceList
+        <RefinementList
           rootClass={cx(rootClass)}
           itemClass={cx(itemClass)}
           facetValues={getFacetValues(results, hierarchicalFacetName, sortBy, limit)}

diff --git a/widgets/multiple-choice-list.js → widgets/refinement-list.js b/widgets/multiple-choice-list.js → widgets/refinement-list.js
@@ -21,7 +21,7 @@ var defaultTemplate = `<label>
  *                                                       to build radio based refinement lists for example.
  * @return {Object}
  */
-function multipleChoiceList({
+function refinementList({
     container = null,
     facetName = null,
     operator = null,
@@ -32,10 +32,10 @@ function multipleChoiceList({
     template = defaultTemplate,
     singleRefine = false
   }) {
-  var MultipleChoiceList = require('../components/MultipleChoiceList');
+  var RefinementList = require('../components/RefinementList');
 
   var containerNode = utils.getContainerNode(container);
-  var usage = 'Usage: multipleChoiceList({container, facetName, operator[sortBy, limit, rootClass, itemClass, template]})';
+  var usage = 'Usage: refinementList({container, facetName, operator[sortBy, limit, rootClass, itemClass, template]})';
 
   if (container === null ||
     facetName === null ||
@@ -57,7 +57,7 @@ function multipleChoiceList({
     }),
     render: function(results, state, helper) {
       React.render(
-        <MultipleChoiceList
+        <RefinementList
           rootClass={cx(rootClass)}
           itemClass={cx(itemClass)}
           facetValues={results.getFacetValues(facetName, {sortBy: sortBy}).slice(0, limit)}
@@ -80,4 +80,4 @@ function toggleRefine(helper, singleRefine, facetName, facetValue) {
     .search();
 }
 
-module.exports = multipleChoiceList;
+module.exports = refinementList;