elements
lifecycle
browser
- useAudio
- useBattery
- useBluetooth
- useBreakpoints
- useBroadcastChannel
- useBrowserLocation
- useClipboard
- useCopy
- useCssVar
- useDisplayMedia
- useDocumentEvent
- useDocumentTitle
- useDocumentVisibility
- useEventListener
- useEventSource
- useEyeDropper
- useFavicon
- useFileSystemAccess
- useFps
- useFullscreen
- useGamepad
- useGeolocation
- useMeasure
- useMediaControls
- useMediaQuery
- useMemory
- useNetwork
- useObjectUrl
- useOnline
- useOtpCredential
- usePermission
- usePictureInPicture
- usePointerLock
- usePostMessage
- useRaf
- useShare
- useSpeechRecognition
- useSpeechSynthesis
- useSticky
- useVibrate
- useVirtualKeyboard
- useWakeLock
- useWebSocket
utilities
state
- useBoolean
- useControllableState
- useCookie
- useCookies
- useCounter
- useCycleList
- useDefault
- useDisclosure
- useField
- useHash
- useList
- useLocalStorage
- useMap
- useMask
- useMergedRef
- useObject
- useOffsetPagination
- useQueue
- useRafState
- useRefState
- useSessionStorage
- useSet
- useStateHistory
- useStep
- useStorage
- useToggle
- useUrlSearchParam
- useUrlSearchParams
- useValidatedState
- useWizard
user
sensors
- useDeviceMotion
- useDeviceOrientation
- useHotkeys
- useIdle
- useInfiniteScroll
- useIntersectionObserver
- useKeyboard
- useKeyPress
- useKeysPressed
- useMouse
- useMutationObserver
- useOrientation
- usePageLeave
- useParallax
- usePerformanceObserver
- useResizeObserver
- useScroll
- useScrollIntoView
- useScrollTo
- useSwipe
- useTextSelection
- useVisibility
- useWindowEvent
- useWindowFocus
- useWindowScroll
- useWindowSize
import { useBoolean } from '@siberiacancode/reactuse';
import { Eye, EyeOff } from 'lucide-react';
const Demo = () => {
const [visible, toggle] = useBoolean();
return (
<section className='flex max-w-sm flex-col gap-3'>
<label className='text-sm font-medium' htmlFor='password'>
New password
</label>
<div className='relative'>
<input
className='pr-10'
data-id='password'
defaultValue='mysecretpassword'
id='password'
placeholder='Enter your password'
type={visible ? 'text' : 'password'}
/>
<button
className='absolute top-1/2 right-0 -translate-y-1/2'
data-variant='unstyled'
type='button'
onClick={() => toggle()}
>
{visible ? <EyeOff className='size-4' /> : <Eye className='size-4' />}
</button>
</div>
</section>
);
};
export default Demo;
Installation
pnpm add @siberiacancode/reactuseUsage
const [on, toggle] = useBoolean()Type Declarations
export type UseBooleanReturn = [
/** The current boolean state value */
value: boolean,
/** Function to toggle the boolean state */
toggle: (value?: boolean) => void
];API
Parameters
| Name | Type | Default | Note |
|---|---|---|---|
| initialValue | boolean | false | The initial boolean value |
Returns
UseBooleanReturnContributors
ddebabinbbabin
Last updated on