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

redux-min-shortcuts

v1.5.0

Published

Shortcuts for redux applications.

Downloads

27

Readme

Shortcuts for Redux

The package provides a small API for creating and dispatching redux actions triggered by keyboard shortcuts.

Installation

npm install redux-min-shortcuts

Example with react hooks

Example using hooks binding Undo/Redo to Ctrl+Z/Ctrl+Y for redux-undo package. All required is to call useGlobalShortcuts() with a list of shortcuts-to-action-creators array:

import { useGlobalShortcuts } from "redux-min-shortcuts";
import { ActionCreators } from "redux-undo";

const shortcutBindings = [
  { key: "z", modifiers: ["Control"], action: ActionCreators.undo },
  { key: "y", modifiers: ["Control"], action: ActionCreators.redo },
];

function App() {

  useGlobalShortcuts(shortcutBindings);

  return <div className="App" />;
}

export default App;

Example without react hooks and custom arguments

Calling handleShortcut() directly without registering global shortcuts is easy. This way, an argument can be passed down to the action creator:

import { useDispatch } from "react-redux";
import { handleShortcut } from "redux-min-shortcuts";

function App() {

  const shortcutBindings = [
    { key: "z", modifiers: ["Control"], action: ActionCreators.undo },
    { key: "y", modifiers: ["Control"], action: ActionCreators.redo },
  ];

  const dispatch = useDispatch();

  const handleChildKeyDown = (event, myArgument) => {
    handleShortcut(event, shortcutBindings, dispatch, myArgument);
  };

  return <div className="App" onChildKeyDown="handleChildKeyDown" />;
}

Notes

Shortcut binding

The shortcut binding consists out of a key, a collection of modifiers-keys, an function that can create an action:

{
  key: "a",
  modifiers: ["Control", "Shift"],
  action: myActionCreator,
}

An optional callback isReady can be specified to check if the shortcut binding is currently active or not. It will get called back everytime the user presses the keyboard shortcut. It get's passed the arguments event and arg that are passed into handleShortcuts(). If the binding is not ready, the event is not processed and neither stopPropagation() nor preventDefault() gets called:

{
  key: "a",
  modifiers: ["Control", "Shift"],
  isReady: (event, arg) => arg.isReady
  action: myActionCreator,
}

An optional property is passDefault which prevents preventDefault() being called even even if the keyboard shortcut was detected and will be executed. This allows a shortcut to execute custom code but at the same time be handled by the browsers default implementation:

{
  key: "a",
  modifiers: ["Control", "Shift"],
  action: myActionCreator,
  passDefault: true
}

Propagation (stopPropagation)

If a event is handled, event.stopPropagation() is always called.

Default (preventDefault)

If a event is handled, by default event.preventDefault() is called. If it should not be called, the argument passDefault: true needs to be passed to the object:

  { key: "y", modifiers: ["Control"], action: ActionCreators.redo, passDefault: true },