@rooks/use-toggle NPM | npm.io

4.11.2 • Published 3 years ago

Install

Weekly downloads

42

License

MIT

Repository

Last release

3 years ago

@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

npm.io npm.io npm.io npm.io

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)

use react-hooks.org react hooks toggle rooks toggle hook

@everything-registry/sub-chunk-789

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4.0.0-canary.23

3 years ago

4.0.0-canary.22

3 years ago

3 years ago

4.0.0-canary.20

3 years ago

4.0.0-canary.17

3 years ago

4.0.0-canary.19

3 years ago

4.0.0-canary.16

3 years ago

4.0.0-canary.14

3 years ago

4.0.0-canary.13

3 years ago

4.0.0-canary.10

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

3.5.1-canary.20

4 years ago

4 years ago

4 years ago

3.4.4-71d48a96.0

4 years ago

3.4.4-e1839b43.0

4 years ago

3.4.4-a9fb8da1.0

4 years ago

4 years ago

3.4.4-ca7e506a.0

4 years ago

3.4.4-0b6223c4.0

4 years ago

3.4.3-cfbe4783.0

4 years ago

3.4.3-f130c101.0

4 years ago

3.4.3-53abf21e.0

4 years ago

3.4.3-695b2acc.0

4 years ago

3.4.3-bb90b83d.0

4 years ago

3.4.3-5f1a38fa.0

4 years ago

3.4.3-20c504bd.0

4 years ago

4 years ago

3.4.3-efa33040.0

4 years ago

3.4.2-1963d180.0

4 years ago

3.4.2-0668aca8.0

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

3.0.0-3.0.0-beta.2.0

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago