Installation

yarn add @poool/junipero-hooks

Usage

import React from 'react';
import { useEventListener, useTimeout } from '@poool/junipero-hooks';

export default () => {
  useTimeout(() => {
    console.log('This has been executed 1s after first render!');
  }, 1000);

  useEventListener('click', () => {
    console.log('You clicked inside the current document');
  });

  return <div />;
};

Documentation

useEventListener(name: String, handler: Function, target: DOMNode)

• name {String} Event name
• handler {Function}
  • event {Object} Event data
• target {DOMNode} Custom event target (default: global)

useTimeout(handler: Function, time: Number, changes: Array)

• handler {Function} Timeout callback
• time {Number} Time in ms before timeout
• changes {Array} Reset timer when any value changes (just like useEffect)

Contributing

Please check the CONTRIBUTING.md doc for contribution guidelines.

License

This software is licensed under MIT.