@rooks/use-toggle
TypeScript icon, indicating that this package has built-in type declarations

4.11.2 • Public • Published

@rooks/use-toggle

Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using

npm install rooks

or

yarn add rooks

Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!

TitleCard

Build Status

About

Toggle (between booleans or custom data)hook for React.

Installation

npm install --save @rooks/use-toggle

Importing the hook

import useToggle from "@rooks/use-toggle"

Usage

const customToggleFunction = v => (v === "start" ? "stop" : "start");

function Demo() {
  const  [value1, toggleValue1] = useToggle();
  const [value2, toggleValue2]  = useToggle(true);
  const [value3, toggleValue3]  = useToggle(
    "start",
    customToggleFunction
  );

  return (
    <>
      <section>
        <h3>Base</h3>
        <button onClick={toggleValue1}>{value1.toString()}</button>
        <hr />
      </section>
      <section>
        <h3>Initial true</h3>
        <button onClick={toggleValue2}>{value2.toString()}</button>
        <hr />
      </section>
      <section>
        <h3>Custom values</h3>
        <button onClick={toggleValue3}>{value3}</button>
      </section>
    </>
  );
}

render(<Demo/>)

Arguments

Arguments Type Description Default value
initialValue boolean Initial value of the state false
toggleFunction function Function which determines how to toggle a value v => !v

Returned array items

Returned Array items Type Description
value Any Current value
toggleValue function Toggle function which changes the value to the other value in the list of 2 acceptable values. (Mostly true or false)

Package Sidebar

Install

npm i @rooks/use-toggle

Weekly Downloads

207

Version

4.11.2

License

MIT

Unpacked Size

7.66 kB

Total Files

13

Last publish

Collaborators

  • imbhargav5