Skip to content

docs: add JSDoc to useToggle hook #2695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RaquelLores wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −0
Open

docs: add JSDoc to useToggle hook #2695

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/useToggle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@ import { Reducer, useReducer } from 'react';
const toggleReducer = (state: boolean, nextValue?: any) =>
typeof nextValue === 'boolean' ? nextValue : !state;

/**
* useToggle
*
* Un hook sencillo para manejar estados booleanos (on/off).
* Ideal para modales, menús desplegables y checkboxes.
*
* @param initialValue - Valor booleano inicial.
* @returns Un array con el estado actual y una función para alternarlo.
*/

const useToggle = (initialValue: boolean): [boolean, (nextValue?: any) => void] => {
return useReducer<Reducer<boolean, any>>(toggleReducer, initialValue);
};
Expand Down