Package Exports

use-keyup

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (use-keyup) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

useKeyup

Get window size by hooks keyup event without side-effect.

Install

$ npm install use-keyup

How to use?

This example will auto removeEventListener when component unmounted.

import useKeyup from 'use-keyup';
const demo = () => {
  const [key, setKey] = useState([]);
  useKeyup(e => setKey(e.code));
  return <p>keyup {key}</p>;
};

Explicity Clean the handler.

import useKeyup from 'use-keyup';
const demo = () => {
  const [key, setKey] = useState([]);
  const [cleanUp] = useKeyup(e => setKey(e.code));
  useEffect(() => {
    setTimeout(cleanUp, 3000);
    // Set timer when mounted & after 3sec clean keyup
  }, []);
  return <p>keyup {key}</p>;
};

What I Do?

Call clean-up function (to removeEventListener) when component has been unmounted.

Also, I export a cleanUp function, you can use this to explicity remove events when you need.

Why This has a dependency of `useEventTarget`

This is a hooks infrastructure for easily package a event hooks.

See more useEventTarget.

use-keyup