useToggle

Toggle a boolean value.

State

API Reference

terminal

pnpm add @shak-hooks/usehooks

import.ts

import { useToggle } from "@shak-hooks/usehooks";

Source: packages/react/src/useToggle.ts

signature.ts

export function useToggle(initialValue: boolean = false)

Name	Type	Optional	Default
initialValue	boolean	Yes	false

unknown

use-toggle.ts

1import { useState, useCallback } from "react";

3export function useToggle(initialValue: boolean = false) {

4 const [value, setValue] = useState(initialValue);

6 const toggle = useCallback(() => {

7 setValue((v) => !v);

8 }, []);

10 return [value, toggle] as const;

11}

Google Ads

example.tsx

1import { useToggle } from "@shak-hooks/usehooks";

3const result = useToggle(undefined);

4// result: unknown

5// Use values directly (React state).