feat(pagination): setPage() -> refine() / currentPage -> currentRefinement

Author: iam4x

src/connectors/pagination/__tests__/connectPagination-test.js

@@ -37,7 +37,7 @@ describe('connectPagination', () => {
 
       // should provide good values for the first rendering
       const firstRenderingOptions = rendering.lastCall.args[0];
-      expect(firstRenderingOptions.currentPage).toBe(0);
+      expect(firstRenderingOptions.currentRefinement).toBe(0);
       expect(firstRenderingOptions.nbHits).toBe(0);
       expect(firstRenderingOptions.nbPages).toBe(0);
       expect(firstRenderingOptions.widgetParams).toEqual({
@@ -64,7 +64,7 @@ describe('connectPagination', () => {
 
       // should call the rendering with values from the results
       const secondRenderingOptions = rendering.lastCall.args[0];
-      expect(secondRenderingOptions.currentPage).toBe(0);
+      expect(secondRenderingOptions.currentRefinement).toBe(0);
       expect(secondRenderingOptions.nbHits).toBe(1);
       expect(secondRenderingOptions.nbPages).toBe(1);
     }
@@ -88,8 +88,8 @@ describe('connectPagination', () => {
 
     { // first rendering
       const renderOptions = rendering.lastCall.args[0];
-      const {setPage} = renderOptions;
-      setPage(2);
+      const {refine} = renderOptions;
+      refine(2);
       expect(helper.getPage()).toBe(2);
       expect(helper.search.callCount).toBe(1);
     }
@@ -103,8 +103,8 @@ describe('connectPagination', () => {
 
     { // Second rendering
       const renderOptions = rendering.lastCall.args[0];
-      const {setPage} = renderOptions;
-      setPage(7);
+      const {refine} = renderOptions;
+      refine(7);
       expect(helper.getPage()).toBe(7);
       expect(helper.search.callCount).toBe(2);
     }

src/connectors/pagination/connectPagination.js

@@ -4,10 +4,10 @@ const usage = `Usage:
 var customPagination = connectPagination(function render(params, isFirstRendering) {
   // params = {
   //   createURL,
-  //   currentPage,
+  //   currentRefinement,
   //   nbHits,
   //   nbPages,
-  //   setPage,
+  //   refine,
   //   widgetParams,
   // }
 });
@@ -27,10 +27,10 @@ Full documentation available at https://community.algolia.com/instantsearch.js/c
 /**
  * @typedef PaginationRenderingOptions
  * @property {function(number)} createURL create URL's for the next state, the number is the page to generate the URL for
- * @property {number} currentPage the number of the page currently displayed
+ * @property {number} currentRefinement the number of the page currently displayed
  * @property {number} nbHits the number of hits computed for the last query (can be approximated)
  * @property {number} nbPages the number of pages for the result set
- * @property {function} setPage set the current page and trigger a search
+ * @property {function} refine set the current page and trigger a search
  * @property {Object} widgetParams all original options forwarded to rendering
  * @property {InstantSearch} instantSearchInstance the instance of instantsearch on which the widget is attached
  */
@@ -48,19 +48,19 @@ export default function connectPagination(renderFn) {
 
     return {
       init({helper, createURL, instantSearchInstance}) {
-        this.setPage = page => {
+        this.refine = page => {
           helper.setPage(page);
           helper.search();
         };
 
-        this.createURL = state => page => createURL(state.setPage(page));
+        this.createURL = state => page => createURL(state.refine(page));
 
         renderFn({
           createURL: this.createURL(helper.state),
-          currentPage: helper.getPage() || 0,
+          currentRefinement: helper.getPage() || 0,
           nbHits: 0,
           nbPages: 0,
-          setPage: this.setPage,
+          refine: this.refine,
           widgetParams,
           instantSearchInstance,
         }, true);
@@ -75,8 +75,8 @@ export default function connectPagination(renderFn) {
       render({results, state, instantSearchInstance}) {
         renderFn({
           createURL: this.createURL(state),
-          currentPage: state.page,
-          setPage: this.setPage,
+          currentRefinement: state.page,
+          refine: this.refine,
           nbHits: results.nbHits,
           nbPages: this.getMaxPage(results),
           widgetParams,

src/widgets/pagination/__tests__/pagination-test.js

@@ -51,7 +51,7 @@ describe('pagination()', () => {
   });
 
   it('sets the page', () => {
-    widget.setPage(helper, 42);
+    widget.refine(helper, 42);
     expect(helper.setPage.calledOnce).toBe(true);
     expect(helper.search.calledOnce).toBe(true);
   });
@@ -81,7 +81,7 @@ describe('pagination()', () => {
     it('should not scroll', () => {
       widget = pagination({container, scrollTo: false});
       widget.init({helper});
-      widget.setPage(helper, 2);
+      widget.refine(helper, 2);
       expect(scrollIntoView.calledOnce).toBe(false, 'scrollIntoView never called');
     });
 

src/widgets/pagination/pagination.js

@@ -28,15 +28,15 @@ const renderer = ({
   scrollToNode,
 }) => ({
   createURL,
-  currentPage,
+  currentRefinement,
   nbHits,
   nbPages,
-  setPage,
+  refine,
 }, isFirstRendering) => {
   if (isFirstRendering) return;
 
-  const setCurrentPage = () => {
-    setPage();
+  const setCurrrentPage = () => {
+    refine();
 
     if (scrollToNode !== false) {
       scrollToNode.scrollIntoView();
@@ -49,12 +49,12 @@ const renderer = ({
     <Pagination
       createURL={createURL}
       cssClasses={cssClasses}
-      currentPage={currentPage}
+      currentPage={currentRefinement}
       labels={labels}
       nbHits={nbHits}
       nbPages={nbPages}
       padding={padding}
-      setCurrentPage={setCurrentPage}
+      setCurrentPage={setCurrrentPage}
       shouldAutoHideContainer={shouldAutoHideContainer}
       showFirstLast={showFirstLast}
     />,