1.0.2 • Published 8 years ago

paginorm v1.0.2

Weekly downloads
9
License
Apache-2.0
Repository
github
Last release
8 years ago

paginorm

A ReactJS dumb component to render a pagination.

A fork of Sergey Vayser's component named react-js-pagination.

The component comes with no built-in styles. HTML layout compatible with Bootstrap pagination stylesheets.

Installation

Install paginorm with npm:

$ npm install paginorm

Usage

Very easy to use. Just provide props with total amount of things that you want to display on the page.

import React, { Component } from "react";
import ReactDOM from "react-dom";
import Pagination from "paginorm";
require("bootstrap/less/bootstrap.less");

class App extends Component {
  constructor(props) {
    super();
    this.state = {
      activePage: 15
    };
    this.handlePageChange = ::this._handlePageChange;
  }

  _handlePageChange(pageNumber) {
    console.log(`active page is ${pageNumber}`);
    this.setState({activePage: pageNumber});
  }

  render() {
    return (
      <div>
        <Pagination
          activePage={this.state.activePage}
          itemsCountPerPage={10}
          totalItemsCount={450}
          pageRangeDisplayed={5}
          onChange={this.handlePageChange}
        />
      </div>
    );
  }
}

ReactDOM.render(<App />, document.getElementById("root"));

Example

Params

NameTypeDefaultDescription
totalItemsCountNumberTotal count of items which you are going to display
onChangeFunctionPage change handler. Receive pageNumber as arg
acivePageNumber1Active page
itemsCountPerPageNumber10Count of items per page
pageRangeDisplayedNumber5Range of pages in paginator, exclude navigation blocks (prev, next, first, last pages)
firstPageTextString / ReactElement«Text of first page navigation button or whole element
lastPageTextString / ReactElement»Text of last page navigation button or whole element
prevPageTextString / ReactElementText of prev page navigation button or whole element
nextPageTextString / ReactElementText of next page navigation button or whole element
classNameString"pagination"ClassName for the pagination ul
firstPageClassNameStringClassName for the first page link
lastPageClassNameStringClassName for the last page link
prevPageClassNameStringClassName for the previous page link
nextPageClassNameStringClassName for the next page link
allItemsClassNameStringClassName for the all pagination links
activeClassNameStringClassName for the active page