useQueueState
Aboutβ
A React hook that manages state in the form of a queue
Installationβ
npm install --save rooks
Importing the hookβ
import { useQueueState } from "rooks";
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 />);
Argumentsβ
Arguments | Type | Description | Default value |
---|---|---|---|
initialList | any[] | An array | undefind |
Returned array itemsβ
Returned items | Type | Description |
---|---|---|
enqueue | function | Put an item to the end of the queue |
dequeue | function | Remove the first item in the queue |
peek | function | Return the item at the front of the queue |
length | number | Number of items in the queue |
Codesandbox Examplesβ
Basic Usageβ
Join Bhargav's discord serverβ
You can click on the floating discord icon at the bottom right of the screen and talk to us in our server.