Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #613 from droganov/feature/use-queue
useQueue hook
- Loading branch information
Showing
7 changed files
with
155 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # `useQueue` | ||
|
|
||
| React state hook implements simple FIFO queue. | ||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ```jsx | ||
| import { useQueue } from 'react-use'; | ||
|
|
||
| const Demo = () => { | ||
| const { add, remove, first, last, size } = useQueue(); | ||
|
|
||
| return ( | ||
| <div> | ||
| <ul> | ||
| <li>first: {first}</li> | ||
| <li>last: {last}</li> | ||
| <li>size: {size}</li> | ||
| </ul> | ||
| <button onClick={() => add((last || 0) + 1)}>Add</button> | ||
| <button onClick={() => pop()}>Remove</button> | ||
| </div> | ||
| ); | ||
| }; | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| import { storiesOf } from '@storybook/react'; | ||
| import * as React from 'react'; | ||
| import { useQueue } from '..'; | ||
| import ShowDocs from './util/ShowDocs'; | ||
|
|
||
| const Demo = () => { | ||
| const { add, remove, first, last, size } = useQueue(); | ||
| return ( | ||
| <div> | ||
| <ul> | ||
| <li>first: {first}</li> | ||
| <li>last: {last}</li> | ||
| <li>size: {size}</li> | ||
| </ul> | ||
| <button onClick={() => add((last || 0) + 1)}>Add</button> | ||
| <button onClick={() => remove()}>Removw</button> | ||
| </div> | ||
| ); | ||
| }; | ||
|
|
||
| storiesOf('State|useQueue', module) | ||
| .add('Docs', () => <ShowDocs md={require('../../docs/useQueue.md')} />) | ||
| .add('Demo', () => <Demo />); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| import { act, renderHook } from '@testing-library/react-hooks'; | ||
| import useQueue from '../useQueue'; | ||
|
|
||
| const setUp = (initialQueue?: any[]) => renderHook(() => useQueue(initialQueue)); | ||
|
|
||
| it('takes initial state', () => { | ||
| const { result } = setUp([1, 2, 3]); | ||
| const { first, last, size } = result.current; | ||
| expect(first).toEqual(1); | ||
| expect(last).toEqual(3); | ||
| expect(size).toEqual(3); | ||
| }); | ||
|
|
||
| it('appends new member', () => { | ||
| const { result } = setUp([1, 2]); | ||
| act(() => { | ||
| result.current.add(3); | ||
| }); | ||
| const { first, last, size } = result.current; | ||
| expect(first).toEqual(1); | ||
| expect(last).toEqual(3); | ||
| expect(size).toEqual(3); | ||
| }); | ||
|
|
||
| it('pops oldest member', () => { | ||
| const { result } = setUp([1, 2]); | ||
| act(() => { | ||
| result.current.remove(); | ||
| }); | ||
| const { first, size } = result.current; | ||
| expect(first).toEqual(2); | ||
| expect(size).toEqual(1); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| import { useState } from 'react'; | ||
|
|
||
| export interface QueueMethods<T> { | ||
| add: (item: T) => void; | ||
| remove: () => T; | ||
| first: T; | ||
| last: T; | ||
| size: number; | ||
| } | ||
|
|
||
| const useQueue = <T>(initialValue: T[] = []): QueueMethods<T> => { | ||
| const [state, set] = useState(initialValue); | ||
| return { | ||
| add: value => { | ||
| set(queue => [...queue, value]); | ||
| }, | ||
| remove: () => { | ||
| let result; | ||
| set(([first, ...rest]) => { | ||
| result = first; | ||
| return rest; | ||
| }); | ||
| return result; | ||
| }, | ||
| get first() { | ||
| return state[0]; | ||
| }, | ||
| get last() { | ||
| return state[state.length - 1]; | ||
| }, | ||
| get size() { | ||
| return state.length; | ||
| }, | ||
| }; | ||
| }; | ||
|
|
||
| export default useQueue; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters