useToggle
function useToggle(
defaultValue: UseStateInitializer<boolean> = false
): ToggleImplementation;
The useToggle
hook is a simple wrapper around useState
that memoizes
toggling a boolean.
Example Usage
import { Button } from "@react-md/core/button/Button";
import { useToggle } from "@react-md/core/useToggle";
import { type ReactElement } from "react";
function Example(): ReactElement {
const { toggled, toggle } = useToggle();
return (
<>
<Button onClick={toggle}>Toggle</Button>
{`Toggled: ${toggled}`}
</>
);
}
Parameters
defaultValue
(optional) - Either aboolean
or a function that returns aboolean
to define the default value
Returns
export interface ToggleImplementation {
toggled: boolean;
setToggled: UseStateSetter<boolean>;
toggle: () => void;
enable: () => void;
disable: () => void;
}