npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

stateful-pagination

v1.0.10

Published

React pagination component with built in state management of pages.

Downloads

5

Readme

stateful-pagination

License

npm badge

React pagination component with built in state management of pages.

Demo

https://dougmacknz.github.io/stateful-pagination/

Getting started

Install the package:

npm install stateful-pagination --save

Usage:

import {
  Pagination,
  PaginationItems,
  PaginationItem,
  PaginationControls
} from "stateful-pagination";
<Pagination>
  <PaginationItems>
    <PaginationItem>
      <div>Item 1</div>
    </PaginationItem>
    <PaginationItem>
      <div>Item 2</div>
    </PaginationItem>
    <PaginationItem>
      <div>Item 3</div>
    </PaginationItem>
    <PaginationItem>
      <div>Item 4</div>
    </PaginationItem>
    ...etc
  </PaginationItems>
  <PaginationControls />
</Pagination>

Why another pagination component?

There's a lot of pagination components out there for React. However I haven't seen one that has built in state management of pages + some other common implementation requirements like window state management. This component is designed to take more of the logic out of the implementation and into the plugin.

Components & Props

<Pagination>

Container for the <PaginationItems> and <PaginationControls> components.

| Name | Type | Default | Description | | -------------- | ---------- | ---------------------------- | ----------------------------------------------------------------------------------------- | | itemsPerPage | number | 10 | The amount of parent elements that will be displayed on each page | | onPageChange | function | | Callback function to run anytime the current page changes | | pageCount | number | (calculated automatically) | Overrides the calculated page count. Enables lazy load mode. |

<PaginationItems>

A container for all the items to be paginated.

<PaginationItem>

Container for content for a single item to be paginated.

| Name | Type | Default | Description | | ---------- | -------- | ------- | ---------------------------------------------------------------------- | | position | number | | Required on lazy load mode. Position of the item in the full list. |

<PaginationControls>

Buttons for the user to control which page they are viewing.

| Name | Type | Default | Description | | ----------------- | -------- | ------------ | ----------------------------------------- | | maxButtons | number | 5 | Maximum amount of buttons to show at once | | prevLabel | node | Previous | Custom label for the 'previous' button | | nextLabel | node | Next | Custom label for the 'next' button | | ulClassName | string | pagination | Custom class/es for <ul> element | | liClassName | string | page-item | Custom class/es for <li> elements | | anchorClassName | string | page-link | Custom class/es for <a> elements |

Normal vs lazy load mode

There are two modes that this component can operate in.

Normal mode

This is the default mode where you supply the full list of items to paginate upfront and the component will handle everything from there. This is suited for situations where you have a known small amount of items you need to paginate, keeping in mind all items are stored in the user's browser memory.

Lazy load mode

This mode is suited for when your component will potentially be displaying large amounts of data and you want to only load items as required as the user moves through pages.

To enable lazy load mode- send a pageCount prop to the <Pagination> component, and add a position prop to each <PaginationItem>.

See the lazy load example on Storybook for an example of how you can use this mode.

Styling

There is no CSS included with this plugin. By default- Bootstrap class names are applied to the Pagination controls. These class names can be changed with the ulClassName, liClassName, and anchorClassName props on the <PaginationControls> component.

Credits

The pagination button logic was inspired by this blog post by Jason Watmore: http://jasonwatmore.com/post/2017/03/14/react-pagination-example-with-logic-like-google