npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@helpful-hooks/use-bool

v1.0.6

Published

Helpful React hook for storing boolean state

Downloads

1

Readme

Use Bool

A simple React hook for storing boolean state

Contents

Installation

If using yarn

yarn add @helpful-hooks/use-bool

For npm

npm install @helpful-hooks/use-bool

Usage

The hook returns an array similar to React's useState hool. The first item contains the boolean state. The second item contains helper functions for setting the stored value.

const [
  state,         // Initially false by default
  stateHandlers   
] = useBool()

const {
  on,            // Set to true
  off,           // Set to false
  toggle,        // Switch between true and false
  set,           // Use like a React setState function
} = stateHandlers

Here is a simple example demonstrating how useBool can be used to show and hide a component

import { useBool } from '@helpful-hooks/use-bool'

// ...

const [show, showHandlers] = useBool()

return (
  <>
    <button onClick={stateHandlers.toggle}>
      TOGGLE
    </button>
    {show ? 'I am visible!' : null}
  </>
)

To set an initial value, pass it as the first argument. The intial value is false by default

const [state] = useBool(true)

// state === true

This hook also supports callbacks which are run when a change in state is made

const onTurnedOff = () => console.log('state === false')
const onTurnedOn = () => console.log('state === true')

const [state, stateHandlers] = useBool(
    // Or false for default behaviour
    true,
    // Pass the callbacks as the second argument
    { onTurnedOff, onTurnedOn },
)

Contributing

All contributions are welcome! If you find a bug or have a feature request, open an issue in the Github Repo

Licence

This package uses the MIT licence. Use or modify it in any morally correct way you choose