Skip to content

codex-team/codex.shortcuts

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

CodeX Shortcuts

CodeX shortcuts is a micro-library for dispatching keyboard shortcuts in Javascript. You don't need external dependencies.

Installation

Package is available on NPM

npm install @codexteam/shortcuts --save

Usage

Require module if you use Webpack or ES6

const Shortcut = require('@codexteam/shortcuts');

or

import Shortcut from '@codexteam/shortcuts'

Creating a shortcut

library provided as class, so to create a new shortcut, make a Shortcut instance with specified options.

Example:

let cmdA = new Shortcut({
    name : 'CMD+A',
    on : document.body,
    callback: function(event) {
        // your handler
    }
});

name - this is shortcut name, keys must be separated by +

on - binding element. Shortcut will be fired only on passed (this) element

callback - you code that defines the behaviour

If you have a single-page web application and you don't need shortcuts handler you can easily remove it

cmdA.remove();

How it works

Library parses data given on constructor, defines commands and keys.

Supported commands : shift, cmd, command, ctrl, control, windows, alt.

other words we pass as keys and special commands. Special commands are: backspace, enter, right, left, up, down, escape, insert, delete.

Contribution

To contribute, please fork, add your patch and tests for it (in the test/ folder) and submit a pull request.

CodeX is a team united of passionate people who loves web development, design and marketing.
We build a full-valued projects on the world area.

Feel free to give us a feedback team@ifmo.su

Follow us on:

VK: https://vk.com/codex_team

Telegram: https://t.me/codex_team

Instagram: https://www.instagram.com/codex_team

About

Micro-library for dispatching keyboard shortcuts in Javascript

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published