archive-gh-me/react-use
1
0
Fork 0
mirror of https://github.com/streamich/react-use.git synced 2026-01-25 14:17:16 +00:00
Code Issues Projects Releases Wiki Activity

[FIX] typo in useStateList.md (#923)

Browse Source 
`nexct` --> `next`
This commit is contained in:
Guillaume L 2020-01-27 15:46:37 +01:00 committed by Anton Zinovyev
parent 7e6f9b3997
commit f06895d9d5
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/useStateList.md
View File

@ -46,7 +46,7 @@ If `stateSet` changed, became shorter than before and `currentIndex` left in shr
- **`state`**_`: T`_ — current state value;
- **`currentIndex`**_`: number`_ — current state index;
- **`prev()`**_`: void`_ — switches state to the previous one. If first element selected it will switch to the last one;
- **`nexct()`**_`: void`_ — switches state to the next one. If last element selected it will switch to the first one;
- **`next()`**_`: void`_ — switches state to the next one. If last element selected it will switch to the first one;
- **`setStateAt(newIndex: number)`**_`: void`_ — set the arbitrary state by index. Indexes are looped, and can be negative.
_4ex:_ if list contains 5 elements, attempt to set index 9 will bring use to the 5th element, in case of negative index it will start counting from the right, so -17 will bring us to the 4th element.
- **`setState(state: T)`**_`: void`_ — set the arbitrary state value that exists in `stateSet`. _In case new state does not exists in `stateSet` an Error will be thrown._