About

chordly is a plug-in library that lets you detect and act upon user keyboard input. This is accomplished by wiring Chordly up to listen for key sequences, known as chords, entered by a user.

Chordly was inspired by John Resig's jQuery.hotkeys. Though we are big fans of jQuery.hotkeys (and John) the plugin lacks functionality we have included in Chordly.

A proud supporter of #mousehate

Features

Trigger events on single, or multiple key presses. Includes Shift, Alt, and Control options
Cross browser compatibility
Custom 'chordlyMatch' event that may be listened for by user code
Optionally ignore input on form elements
Storage of user readable buffer of key presses
Pause and Re-Start key capturing and event firing
Optional automatic timeout of key buffering
Optional Greedy matching
Multiple instances allowed on a single page
...

Usage

Chordly may be attached to any DOM node in order to listen for sequences of keyboard activity within that node and its descendants. In its simplest form Chordly can be enabled like this:

document.querySelector(expression).pushToChordly("bindLiteralSequence", "hello", function() {
  console.log("world");
});

Advanced Usage

Also, be sure to check out the Code Snippet section below that contains useful examples and hints

While the above is great for simple keyboard input it is Chordly's more advance uses where it begins to sing. Chordly offers a variety of configuration options and makes it easy to handle a number of key sequences with a single configuration. A more advanced form of the above would look likes this:

document.querySelector(expression).pushToChordly({
  sequenceMap: [
    {
      sequence: window.chordly.literalStringToSequence("hello"),
      matched: function() {
        console.log("world");
      }
    }
  ]
});

Which admittedly looks unnecessarily more complicated until you realize it allows you to do things like this:

document.querySelector(expression).pushToChordly("bind", [
  {
    sequence: window.chordly.literalStringToSequence("mouse"),
    matched: function() {
      console.log("squeak!");
    }
  },
  {
    sequence: [
      window.chordly.literalStringToSequence("cow"),
      window.chordly.literalStringToSequence("bull")
    ],
    matched: function() {
      console.log("moo!");
    }
  }
]);

Options

In the above examples we are making use of Chordly's options object which may contain the following, otherwise defaults are used:

captureShift (bool) default: [false] Treat shift as a key press.
captureAlt (bool) default: [false] Treat alt as a key press.
captureCtrl (bool) default: [false] Treat ctrl as a key press.
ignoreFormElements (bool) default: [true] Ignore key presses within form elements
keyEvent (string) default: [keyup] the key event that triggers listening. other options are keydown (or any event that stores the key code not ASCII char code within the 'which' property of the event)
maxBufferLength (int) default: [5] the length of the key buffer. Note that the buffer will be auto expanded in order to maintain at minimum the length of the longest sequence to be detected. Modifying this allows for a greater depth of key press history to be kept if desired
clearBufferOnMatch (bool) default: [true] determines if the key buffer should be cleared on a match
paused (bool) default: [false] determines if chordly on the element should start paused (not collecting key)
bufferTimeoutMs (int) default: [0] timeout length for key buffer clearing in ms (value of <1 means no timeout)
greedyTimeoutMs (int) default: [0] timeout length since last recording of a key press before executing a match event. This is reset by next key press. (value of <1 means no greedy matching)
sequenceMap (object array) default: [empty array] an array of objects defining sequence mapping. Defaults to an empty array. Mapping object may have the following attributes
sequence - a sequence, array of sequences, or array of sequence parts to create a sequence from a string use window.chordly.literalStringToSequence(str) or to create a part use window.chordly.makeSequencePart(keyCode, shift, alt, ctrl)
matched - optional function that will be called on sequence completion
lookup - optional lookup code that will be passed to the custom chordlyMatch event on sequence completion

Methods

clearSequenceBuffer clear the sequence buffer, effectively resetting the memory of previously pressed keys document.querySelector(expression).pushToChordly('clearSequenceBuffer')
destroy destroy the chordly instance unbinding events and removing data from element document.querySelector(expression).pushToChordly('destroy')
pause pause the chordly instance document.querySelector(expression).pushToChordly('pause')
resume resume the chordly instance document.querySelector(expression).pushToChordly('resume')
togglePause pause/resume chordly instance if was unpaused/paused document.querySelector(expression).pushToChordly('togglePause')
bind(args) bind new sequence(s) args[0] array of sequence/lookup/matched objects to add to the sequenceMap

document.querySelector(expression).pushToChordly('bind', {
    sequence: window.chordly.literalStringToSequence('mouse'),
    matched: function () {
        console.log('squeak!')
    }
});

unbind(args) unbind each occurrence of a sequence args[0] the sequence to unbind document.querySelector(expression).pushToChordly('unbind', window.chordly.literalStringToSequence('mouse'));
actOnBuffer act on data in buffer as if a listen event has occurred document.querySelector(expression).pushToChordly('actOnBuffer')
pushSequence(args) push a sequence onto the buffer. Not that this will not cause a listen to be fired. You must call actOnBuffer if a reaction is desired. To push and act on buffer call pushSequenceAndAct args[0] sequence to push (array of sequence parts) document.querySelector(expression).pushToChordly('pushSequence', window.chordly.literalStringToSequence('dog'))
pushSequenceAndActOnBuffer(args) push a sequence onto the buffer and act upon it args[0] sequence to push (array of sequence parts) document.querySelector(expression).pushToChordly('pushSequenceAndAct', window.chordly.literalStringToSequence('dog'))

Events

Chordly also makes available a custom 'chordlyMatch' event. This event object will contain the following NEW properties:

originalEvent - the original triggering event event
lookup - the lookup as defined in the sequence map
sequence - the sequence that triggered the event
sequenceString - the triggering sequence as a string

Below is an example of a handler of the chordlyMatch event.

document.querySelector(expression).addEventListener("chordlyMatch", function(e) {
  console.log("chordlyMatch event:");
  console.log("\t event:", e);
  console.log("\t lookup:", e.lookup);
  console.log("\t sequence:", e.sequence);
  console.log("\t sequenceString:", e.sequenceString);
  console.log("\t originalEvent:", e.originalEvent);
});

Code Snippets

The Sky is the limit with Chordly, or at the very least the keyboard. The following are some code examples of how chordly may be used to make interacting with your website better.

Konami Code

This example fires of an method, in this case an alert stating "Konami Code!", when the Konami Code is entered.

$(document).ready(function () {
  document.querySelector('body').pushToChordly('bindSequence', 'UpArrow UpArrow DownArrow DownArrow LeftArrow RightArrow LeftArrow RightArrow B A Enter', function () { alert("Konami Code!"); });
});

Page Redirection

This example shows how chordly definition may be chained to have key presses of G then H, G then F, and G then A redirect the browser to home.html, faq.html, and about.html respectively

$(document).ready(function () {
  const body = document.querySelector('body');
  body.pushToChordly('bindSequence', 'G H', function() { window.location = 'home.html'; });
  body.pushToChordly('bindSequence', 'G F', function() { window.location = 'faq.html'; });
  body.pushToChordly('bindSequence', 'G A', function() { window.location = 'about.html'; });
});

Greedy Sequence Matching

This example shows how Chordly may be set up so that it will attempt to match on the longest possible key entry before defaulting to a smaller defined one. In this case entering 'cows' will not trigger the 'cow' event, yet both may still be fired.

$(document).ready(function() {
  var $document = document.querySelector(expression);
  $document.pushToChordly({
    bufferTimeoutMs: 400, // buffer auto-clears after 400 ms
    greedyTimeoutMs: 225 // wait 225 ms for more keys before declaring a match
  });
  $document.pushToChordly("bindSequence", "C O W", function() {
    alert("one cow: Moo!");
  });
  $document.pushToChordly("bindSequence", "C O W S", function() {
    alert("two cows: Moo! Moo!");
  });
});

On Screen 'J/K' Style Navigation

This is an example snippet of how chordly can be used to accomplish J/K style navigation on a web page. J and K buttons may be used to optionally navigate tags marked with the 'data-selectable' attribute. Once selected a pressing the Enter key activates the link associated with the current item.

see chordly example of J/K navigation Gist

Copyright

Copyright 2018 National Technology & Engineering Solutions of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

sandialabs / Chordly

Programming Languages

Labels

Projects that are alternatives of or similar to Chordly