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

4.11.2 • Public • Published

@rooks/use-timeout

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

setTimeout hook for react.

Installation

npm install --save @rooks/use-timeout

Importing the hook

import useTimeout from "@rooks/use-timeout"

Usage

function TimeoutComponent() {
  function doAlert() {
    window.alert("timeout expired!");
  }
  const { start, clear } = useTimeout(doAlert, 2000);
  return (
    <>
      <button onClick={start}> Start timeout </button>
      <button onClick={clear}> Clear timeout </button>
    </>
  );
}

render(<TimeoutComponent/>)

Arguments

Arguments Type Description Default value
callback function Function to be executed in timeout undefind
delay Number Number in milliseconds after which callback is to be run 0

Returned Object keys

Returned object attributes Type Description
clear function Clear the timeout
start function Start the timeout
isActive boolean Is the timeout active

Package Sidebar

Install

npm i @rooks/use-timeout

Weekly Downloads

1,803

Version

4.11.2

License

MIT

Unpacked Size

8.84 kB

Total Files

13

Last publish

Collaborators

  • imbhargav5