readme.md

React Pagination

This package includes pagination hooks for React. The hooks support saving the query and pagination values in local state or in the browser URL.

Table of content

• Usage
  • useQueryAndPagination
• Supported Implementations
  • In Memory Pagination
  • React-Router based pagination
  • NextJS Router based pagination
• Build & Publish
• Information

Usage

First, you have to install the package:

npm install @aboutbits/react-pagination

Second, you can make use of the useQueryAndPagination hook. This package implements 3 versions of this hook:

• In Memory: Use this hook where you don't want to modify browser history. e.g. Dialogs
• React Router: Use this hook if you want to keep track of the state in the URL and your project is using React Router.
• NextJS Router: Use this hook if you want to keep track of the state in the URL and your project is using NextJS.

useQueryAndPagination

This hook supports the combination of query parameters and pagination and manages the state of the query parameter values and the pagination values.

The hook supports following configuration parameter object:

value	type	default	description
indexType	IndexType	IndexType.ZERO_BASED	It defines whether the pagination is zero or one based.
pageSize	number	15	Page size of the pagination.
defaultQueryParameters/Record<string, string>	{}	It defines the default value for each query parameter. This is used to remove a query parameter from the URL and also to clear the query.

The hook returns the following object:

value	type	description
queryParameters	object	values of your query parameters
page	number	value of the current page
size	number	max elements in a single page
actions	object	object with 3 functions: updateQuery, setPage, clear

Example usage with NextJS

import { useQueryAndPagination } from '@aboutbits/react-pagination/dist/nextRouterPagination'

const users = [
    'Alex', 'Simon', 'Natan', 'Nadia', 'Moritz', 'Marie'
]

function UserList() {
    const { page, size, queryParameters, actions } = useQueryAndPagination({pageSize: 2})

    return (
        <div>
            <input onChange={(value) => actions.updateQuery({search: value})}/>
            <button onClick={() => actions.clear()}>Clear Input</button>
            <select onSelect={(value) => actions.setPage(value)}>
                <option value={0}>First Page</option>
                <option value={1}>Second Page</option>
            </select>

            <ul>
                {users.filter(user => user.startsWith(queryParameters.search))
                    .slice(page, page + size)
                    .map(user => <li>{user}</li>)}
            </ul>
        </div>
    )
}

Supported implementations

This package includes 3 different implementations of the above hook.

• In Memory
• React Router
• NextJS Router

In Memory Pagination

Use this pagination hook if you want to keep track of the pagination in memory. This is very handy for dialogs.

import { useQueryAndPagination } from '@aboutbits/react-pagination/dist/inMemoryPagination'

React-Router based pagination

These are specific hooks for applications that use React Router for routing.

import { useQueryAndPagination } from '@aboutbits/react-pagination/dist/reactRouterPagination'

NextJS Router based pagination

These are specific hooks for applications that use NextJS Router for routing.

import { useQueryAndPagination } from '@aboutbits/react-pagination/dist/nextRouterPagination'

Build & Publish

To publish the package commit all changes and push them to main. Then run one of the following commands locally:

npm version patch
npm version minor
npm version major

Information

About Bits is a company based in South Tyrol, Italy. You can find more information about us on our website.

Support

For support, please contact info@aboutbits.it.

Credits

• All Contributors

License

The MIT License (MIT). Please see the license file for more information.