Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@rooks/use-interval-when

imbhargav52.2kMIT4.11.2TypeScript support: included

Sets an interval immediately when a condition is true

use, react, hooks, rooks, react-hooks.org

readme




Build Status Release script All Contributors


A super awesome collection of regularly used custom hooks as utils for React.

Complete Documentation

Image from Gyazo

List of all hooks

Features

✅ Collection of 62 hooks as standalone modules.

✅ Standalone package with all the hooks at one place

✅ CommonJS, UMD and ESM Support

Installation

npm i -s rooks

Import any hook from "rooks" and start using them!

import { useDidMount } from "rooks";

Usage

function App() {
  useDidMount(() => {
    alert("mounted");
  });
  return (
    <div className="App">
      <h1>Hello CodeSandbox</h1>
      <h2>Start editing to see some magic happen!</h2>
    </div>
  );
}

Standalone Package

Package containing all the hooks is over here. - Docs and Npm Install


License

MIT

Contributors

Thanks goes to these wonderful people (emoji key):


Bhargav Ponnapalli

💻 🤔 🎨 📖 🐛

Tsvetan

💻

Wei Zhu

💻

Akshay Kadam (A2K)

💻

Austin Peterson

💻

Frank Hellwig

💻

Neilor Caldeira

💻

Cong Zhang

💻

Brian Steere

💻

anil kumar chaudhary

💻

Harsh Zalavadiya

💻

maciek_grzybek

💻

CT Wu

💻 🤔

Braxton Christensen

💻

Lionel

💻

Max Stoiber

💻

Stupid

💻

Michael Moore

💻

Arman

💻

zeritte

💻

Cal Courtney

💻

wes christiansen

💻

Daniel Holmes

💻

Adrien Lemaire

💻

Harshil Parmar

💻

Yakko Majuri

💻

Branden Visser

💻

thodubois

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

changelog

v3.6.0-canary.0 (2019-12-25)

:rocket: New Feature

  • fullscreen, storybook

:house: Internal

  • boundingclientrect-ref, countdown, docusaurus, fork-ref, geolocation, intersection-observer-ref, isomorphic-effect, mutation-observer-ref, outside-click-ref
  • Other

:memo: Documentation

v3.5.1 (2019-12-18)

:memo: Documentation

:house: Internal

3.4.3

  • Added new useCountdown hook

3.4.2

  • Fix types for useOutsideClickRef hook
  • Internal bug fixes

v3.4.0

  • New useBoundingclientrectRef hook
  • New useForkRef hook
  • New useOutsideClickRef hook
  • New useIsomorphicEffect hook
  • New useMutationObserverRef hook
  • New useIntersectionObserverRef hook
  • Minor bug fixes

v3.3.0

  • New useGeolocation hook
  • New useThrottle hook
  • Minor bug fixes

v3.2.2

  • Fix a minor bug in useKeys

v3.2.0

  • New hooks added

    • useOnWindowResize
    • useOnWindowScroll
    • useKeys
  • Allow localStorage and sessionStorage to store all kinds of values.

v3.1

  • New hook added useDebounce

v3

  • Critical bug with useKey with refs not detected was fixed
  • useWindowSize now returns innerHeight, innerWidth, outerHeight and outerWidth. It no longer returns height and width which were ambiguous.
  • useWorker has a new signature.
  • useInterval had issues with useState which have been resolved
  • usePrevious has a much simpler implementation using useRef
  • typescript types have been added to all the hooks
  • Storybook website has been added
  • Uniform major package version for all packages. It makes development easier and it also helps tracking compatibility.

v2

  • useToggle v2.0.0 Return value is now an array with two values instead of an object

Older

  • useInterval

    -1.1.1 (2019-01-20)

  • useOutsideClick

    • Fix SSR bug introduced
    • Also look for touch listeners now
  • rooks