Shortcut keys

Your most
accessible application

Make it easy for your user to perform actions
in your app by adding shortcuts.

Documentation

Features and support

Add event to element

Function:add(shortcut, handler, options)

  • shortcut * - Shortcut to trigger action.
  • handler * - Action triggered when shortcut is pressed.
  • options - Extra settings
    • description - Event description
    • multiPlatform - When true, 'control' and 'command' are enabled together.
    • prevent - When true, activates event.preventDefault().
    • eventType - Sets event type. See more events

Remove existing event

Function: remove(shortcut)

  • shortcut * - Shortcut to be removed.

Remove all existing events

Function: removeAll()


List all existing events

Function: list()

  • key - Shortcut to trigger action.
  • info - All information about the shortcut.

Quick examples

How install Shortcut keys ?

Installing and using shortcut-keys is very easy. And to make your life even easier, here are some working examples.

HTML 5

HTML 5

Simple project using HTML 5

Open example
ReactJS

ReactJS

Simple project using ReactJS

Open example
Remix

Remix

Simple project using Remix

Open example
NextJS

NextJS

Simple project using NextJS

Open example