toukey

Toukey

Toukey is a simple and efficient keyboard events library. That's toukey's doc site.

Install

npm i toukey --save

or

pnpm add toukey --save

Use

Browser

You could download and link toukey.js in your HTML, It can also be downloaded via UNPKG | jsDelivr

<script src="https://unpkg.com/toukey/dist/toukey.umd.min.js"></script>
<script>
  toukey.subscribe('space', function() {
    console.log('space');
  });
</script>

React

It is easy to use with react.

import { useEffect } from "react";
import { subscribe } from "toukey";

function App() {
  useEffect(() => {
    return subscribe("scope", () => {
      console.log("scope");
    });
  });

  return <div>hello world</div>;
}

And here is a library named react-toukey-hook which build with toukey for react hook.

Basic Use

import * as Toukey from "toukey";

const handler = () => console.log("handler");

// subscribe
Toukey.on("scope", handler);

// unsubscribe
Toukey.off("scope", handler);

import { subscribe } from "toukey";

const unsubsribe = subscribe("scope", () => {
  console.log("scope");
});

Changelog

v1.3.1

compare changes

📖 Documentation

• Fix toc wrong dispaly (b3daf5f)
• Update package manager tabs (7203662)
• Update rspress, add SourceCode (cc930dd)

🏡 Chore

• Change rollup to unbuild (01d68c2)
• Update scripts (866740e)

❤️ Contributors

• Yukiniro (@Yukiniro)