Giter VIP home page Giter VIP logo

react-hotkeys's Introduction

@baked/react-hotkeys

Usage

Wrap your app in a HotkeyProvider

import React from "react";
import ReactDOM from "react-dom";
import { Provider, Manager } from "@baked/react-hotkeys";
import App from "./App";

const manager = new Manager();

const rootElement = document.getElementById("root");
ReactDOM.render(
  <Provider manager={manager}>
    <App />
  </Provider>,
  rootElement
);

with hooks

import React, { useEffect } from "react";
import { useHotkeyManager } from "@baked/react-hotkeys";

const Example = () => {
  const manager = useHotkeyManager();
  // the registerHotkey(s) methods return an uregister method
  // that can be called by useEffect to unregister the hotkey
  // when the component unmouts.
  useEffect(
    manager.registerHotkey({
      key: "a",
      ctrl: true,
      shift: true,
      callback: () => alert("Hotkey triggered."),
    }),
    []
  );
  return <></>;
};

export default Example;

with class components

import React, { Component } from "react";
import { withHotkeyManager } from "@baked/react-hotkeys";

class Example extends Component {
  componentDidMount = () => {
    this.unregister = this.props.manager.registerHotkey({
      key: "a",
      ctrl: true,
      shift: true,
      callback: () => alert("Hotkey triggered."),
    });
  };
  componentWillUnmount = () => {
    this.unregister();
  };

  render = () => <></>;
}

export default withHotkeyManager(Example);
with typescript:
import React, { Component } from "react";
import {
  withHotkeyManager,
  HotkeyManagerComponentProps,
} from "@baked/react-hotkeys";

type ExampleInitialProps = {};

type ExampleProps = HotkeyManagerComponentProps & ExampleInitialProps;

class Example extends Component<ExampleProps> {
  componentDidMount = () => {
    this.unregister = this.props.manager.registerHotkey({
      key: "a",
      ctrl: true,
      shift: true,
      callback: () => alert("Hotkey triggered."),
    });
  };
  componentWillUnmount = () => {
    this.unregister();
  };

  render = () => <></>;
}

export default withHotkeyManager(Example);

react-hotkeys's People

Contributors

baked-dev avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.