# @build-own-hooks/use-toggle

> A hook to toggle state between true and false

Latest version **1.2.4** (published 2022-10-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install @build-own-hooks/use-toggle
pnpm add @build-own-hooks/use-toggle
yarn add @build-own-hooks/use-toggle
bun add @build-own-hooks/use-toggle
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.4 |
| Published | 2022-10-19 |
| First published | 2022-10-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | wlcharlie |
| Maintainers | wlcharlie |
| Keywords | react, react-hook, hook, toggle, state |

## Links

- npm: https://www.npmjs.com/package/@build-own-hooks/use-toggle
- Repository: https://github.com/wlcharlie/react-use-toggle
- Homepage: https://github.com/wlcharlie/react-use-toggle#readme
- Issues: https://github.com/wlcharlie/react-use-toggle/issues
- npm.io page: https://npm.io/package/@build-own-hooks/use-toggle

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.2.4 (latest) — 2022-10-19
- 1.2.3 — 2022-10-13
- 1.2.2 — 2022-10-13
- 1.2.1 — 2022-10-13
- 1.2.0 — 2022-10-13
- 1.1.3 — 2022-10-12
- 1.1.2 — 2022-10-12
- 1.1.1 — 2022-10-12
- 1.1.0 — 2022-10-12
- 1.0.9 — 2022-10-12
- 1.0.8 — 2022-10-12
- 1.0.7 — 2022-10-12
- 1.0.6 — 2022-10-12
- 1.0.5 — 2022-10-12
- 1.0.4 — 2022-10-12
- … 4 more at https://npm.io/package/@build-own-hooks/use-toggle/versions

## README

# react-use-toggle

A hook to toggle state between true and false.

## Demo

[DEMO - useToggle Plus](https://build-own-hooks.vercel.app/hooks/use-toggle-plus)

## Install

```bash
npm i @build-own-hooks/use-toggle
```

## Usage

```jsx
import useToggle from "@build-own-hooks/use-toggle"

function App() {
  const { isOn, toggle, toggleOn, toggleOff } = useToggle({
    defaultState, onOn, onOff  //optional
  })

  return (
    <div>
      {isOn && "ON"}
      <button onClick={() => toggle}>toggle!</button>
    </div>
  )
}
```

---
_Source: https://npm.io/package/@build-own-hooks/use-toggle · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._