1.0.4 • Published 3 years ago

react-bootstrap-4-pagination v1.0.4

Weekly downloads
606
License
MIT
Repository
github
Last release
3 years ago

NPM

react-bootstrap-4-pagination

A React component to render and manage Bootstrap 4 pagination quickly and easily.

Your project must have Bootstrap 4 in order to properly render the component

Check Live example

Installation

Install react-bootstrap-4-pagination with npm:

$ npm install react-bootstrap-4-pagination

Usage

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

With href

import React from 'react';
import Pagination from 'react-bootstrap-4-pagination';

let paginationConfig = {
  totalPages: 22,
  currentPage: 15,
  showMax: 5,
  size: "lg",
  threeDots: true,
  prevNext: true,
  href: 'https://example.com/items?page=*', // * will be replaced by the page number
  pageOneHref: 'https://example.com/items',
  borderColor: 'red',
  activeBorderColor: 'black',
  activeBgColor: 'grey',
  disabledBgColor: 'red',
  activeColor: 'red',
  color: 'purple',
  disabledColor: 'green',
  circle: true,
  shadow: true
};

function App() {
  return (
    <div className="App">
      <Pagination {...paginationConfig} />
    </div>
  );
}

export default App;

With function

import React from 'react';
import Pagination from 'react-bootstrap-4-pagination';

let paginationConfig = {
  totalPages: 7,
  currentPage: 3,
  showMax: 5,
  size: "lg",
  threeDots: true,
  prevNext: true,
  onClick: function (page) {
     console.log(page);
   }
};

function App() {
  return (
    <div className="App">
      <Pagination {...paginationConfig} />
    </div>
  );
}

export default App;

Params

NameTypeDefaultDescription
totalPagesNumberRequired. Total number of pages.
currentPageNumber1Current page
showMaxNumber5Total page items to display excluding navigation blocks (prev, next, first, last pages)
onClickFunctionPage item click handler. Receive pageNumber as arg. If you pass onClick prop, href prop will stop having effect
sizeStringmdPagination component size. Options: sm lg
prevNextBooleantrueSet to false if you don't want to show next and prev navigation buttons
prevTextStringText of prev page navigation button
nextTextStringText of prev page navigation button
hrefStringHref template. Example: https://example.com/items?page=*&sessionId=Khf3124nfj * will be replaced by the page item number
pageOneHrefStringHref template for first page. Example: https://example.com/items?sessionId=Khf3124nfj if pageOneHref is not set, page one links will have the href template
threeDotsBooleanfalseSet to trueif you want to show Ellipsis items
activeClassStringactiveClass name of active <li> tag
disabledClassStringdisabledClass name of the first, previous, next and last <li> tags when disabled
centerBooleantrueSet to false if you don't whant to center pagination items
activeBgColorStringBootstrap defaultbackground-color: of active class page items
activeBorderColorStringBootstrap defaultborder-color: of active class page items
activeColorStringBootstrap defaultcolor: (font color) of active class page items
disabledBgColorStringBootstrap defaultbackground-color: of disabled class page items
disabledBorderColorStringBootstrap defaultborder-color: of disabled class page items
disabeldColorStringBootstrap defaultcolor: (font color) of disabled class page itmes
bgColorStringBootstrap defaultbackground-color: of page items that don't have active or disabled class
borderColorStringBootstrap defaultborder-color: of page items that don't have active or disabled class
colorStringBootstrap defaultcolor: (font color) of page items that don't have active or disabled class
circleBooleanfalseSet to true if you want circular page items
shadowBooleanfalseSet to true if you want shadow on page items
ariaLabelStringPage navigatoraria-label text of nav element

License

MIT