1.0.0 • Published 6 years ago

react-pager-component v1.0.0

Weekly downloads
12
License
MIT
Repository
github
Last release
6 years ago

react-pager-component

Pager component for React

NPM Travis JavaScript Style Guide

screenshot

Install

yarn add react-pager-component

or

npm install --save react-pager-component

Usage

import React, { Component } from 'react';
import Pager from 'react-pager-component';

class Example extends Component {
  constructor(props) {
    super(props);
    this.state = {
      current: 37,
    }
  }
  render () {
    return (
      <Pager
        length={84}
        current={this.state.current}
        expansion={3}
        onChange={ current => this.setState({ current }) }
      />
    )
  }
}

Props

PropDescriptionTypeRequiredDefault
lengthTotal page countnumberrequired
currentCurrent page numbernumberrequired
expansionLeft and right expansion number from current numbernumber2
showRestLabelsShow rest labels (...)booltrue
restLabelRest button label*...
showPrevNextButtonsShow Prev and Next Buttonsbooltrue
prevLabelPrevious button label*<
nextLabelNext button label*>
showFirstButtonShow "Go first" buttonbooltrue
firstButtonLabel"Go first" button label*First
showLastButtonShow "Go last" buttonbooltrue
lastButtonLabel"Go last" button label*Last
onChangeReturns new page numberfunction

Also, you can use other html props.

Customization

/*** pager container style ***/
.Pager {
  /* styles */
}

/*** button styles ***/
.Pager .PagerButton {
  /* base button styles */

  /** styles by intent **/
  &--Prev {
    /* previous button style */
  }
  &--Next {
    /* next button style */
  }
  &--Go {
    /* numeric button style */
  }
  &--Rest {
    /* disabled rest button style */
  }
  &--GoFirst {
    /* go first button style */
  }
  &--GoLast {
    /* go last button style */
  }

  /** styles by state **/
  &-is-active {
    /* active button style */
  }
  &-is-disabled {
    /* disabled button style */
  }
}

License

MIT © emr