npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-mousetrap-mixin

v0.1.1

Published

React mixin for mousetrap

Downloads

23

Readme

react-mousetrap-mixin Build Status npm version

React component and mixin for mousetrap.

Demo

View Demo

Installation

npm install --save react-mousetrap-mixin

Component API

Mousetrap

Props

propTypes: {
  mousetrap: React.PropTypes.object
}
  • mousetrap:

    mousetrap bindings keys: callback pairs

    or shapes in

    keys: {
      callback: function(){},
      action: function()
    }

Example:

let mousetrap = {
  'up up down down left right left right b a'() {
    alert('Konami');
  },
  'up x down b l y r a'(){
    alert('カカロットォ');
  },
  'esc':{
    callback() {console.log('esc');},
    action: 'keyup'
  }
}

Keys, callbacks and actions are passed to Mousetrap.bind.

See also https://craig.is/killing/mice for detail.

Usage example


import Mousetrap  from 'react-mousetrap-mixin';

class App extends React.Component {
  constructor(props) {
    super(props);
    this.state = {}
  }

  render() {
    let mousetrap = {
      'up up down down left right left right b a'() {
        alert('Konami');
      },
      'up x down b l y r a'(){
        alert('カカロットォ');
      },
      'esc': {
        callback() {console.log('esc');},
        action: 'keyup'
      }
    }
    return (
      <div>
        <Mousetrap mousetrap={mousetrap} />
      </div>
    );
  }
};

See also example


Mixin API

It is also exported as Mixin.

MousetrapMixin

  • getMousetrap:

    Will be called on componentDidMount.

    must return mousetrap key-callback object like prop.

  • addMousetrap(key, callback, action):

    Add new mousetrap binding.

  • removeMousetrap(key, action):

    Remove existing mousetrap binding.

Usage example


import React from 'react';
import {MousetrapMixin}  from 'react-mousetrap-mixin';

let MyMousetrap = React.createClass({
  mixins: [MousetrapMixin],

  getInitialState(){
    return {
      color: 'red',
      greenChecked: false
    }
  },
  getMousetrap(){
    return {
      'y e l l o w':() => {
        this.setState({
          color: 'yellow'
        });
      },
      'b l u e':() => {
        this.setState({
          color: 'blue'
        });
      }
    };
  },

  onChange(event){
    this.setState({
      greenChecked: event.target.checked
    }, () => {
      if (this.state.greenChecked){
        this.addMousetrap('g r e e n', () => {
          this.setState({
            color: 'green'
          });
        });
      } else {
        this.removeMousetrap('g r e e n');
      }
    });
  },

  render() {
    let style = {
      backgroundColor: this.state.color
    }
    return (
      <div>
        <div style={style}>
          Type 'yellow' or 'blue'
        </div>
        <input type='checkbox' onChange={this.onChange} checked={this.state.greenChecked} />
        Enable 'green'
      </div>
    );
  }
});

See also example

npm install
npm run start:example

Tests

npm test