@rooks/use-queue-state
TypeScript icon, indicating that this package has built-in type declarations

4.11.2 • Public • Published

@rooks/use-queue-state

Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using

npm install rooks

or

yarn add rooks

Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!

TitleCard

Build Status

About

A React hook that manages state in the form of a queue

Installation

npm install --save @rooks/use-queue-state

Importing the hook

import useQueueState from "@rooks/use-queue-state"

Usage

function Demo() {
  // here list is still 1,2,3
  // controls contains utils to change the queue;
  const [list, controls] =  useQueueState([1,2,3]);
  const {enqueue, peek, dequeue, length} = controls;

  // enqueue(1)
  // dequeue()
  // peek()
  
  // This will render items in FIFO order
  return <div>
    {list.map(item => <span>{item}</span>)}
  </div>
}

render(<Demo/>)

Package Sidebar

Install

npm i @rooks/use-queue-state

Weekly Downloads

1

Version

4.11.2

License

MIT

Unpacked Size

7.37 kB

Total Files

14

Last publish

Collaborators

  • imbhargav5