Skip to content
This repository has been archived by the owner. It is now read-only.
Simple keyboard plugin for aurelia
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

Aurelia Keyboard Plugin

This is an easy to use keyboard navigation plugin for aurelia. It is based on the popular mousetrap javascript library.

Installing the plugin

  1. Ensure that NodeJS and jspm is installed. This provides the platform on which the build tooling runs.
  2. Install jspm.
  3. Install aurelia
  4. Install aurelia-keyboard-navigation
  jspm install aurelia-keyboard-plugin
  1. Configure aurelia-keyboard-navigation
  import { AKPConfiguration } from 'aurelia-keyboard-plugin';

   aurelia.use.plugin('aurelia-keyboard-plugin', (config: AKPConfiguration) => {

Possible configuration options are: value(default setting)

  • preventBubbleClass('akp-nobubble') : Class name to give inputs that should bypass keys bound by plugin
  • defaultPreventInputBubble(false): Should inputs not respond to binding by default
  • defaultPrevent(false): Should callbacks fire e.preventDefault(); by default
  • defaultGlobal(true): Should keybinds be global by default
  1. You are done. Read the tutorial to learn how to use the plugin

Using the plugin

To understand the trigger combinations. Read more about Mousetrap on

The plugin exposes a global custom attribute called keybind="", it has several properties to bind to.

  • trigger: Which keys should trigger
  • delegate: Callback, when no delegate is defined is default.
  • prevent: Should call e.preventDefault(); (default false)
  • global: Is global, otherwise will only fire when scope is in focus (inputs) (default true)


Simple keybind to make enter click your button, because no delegate is given the plugin will fire

 <input type="text" value="Something to post"/>
 <button type="submit" keybind="trigger: enter;">Submit form</submit>

Simple keybind to perform search when in search input scope, because global is set to false it will only trigger when focus is inside the input

<input type="text" placeholder="Search for something" keybind="trigger: enter; doSearch(); global: false;" />

Simple keybind to navigate, when args is defined the plugin passes a KeyboardEvent parameter to the delegate, the parameter must be called args.


<table keybind="trigger: up, down; doNavigation(args);>
<tbody repeat.for="item of items">
<td>Selected: ${item.selected}</td>

doNavigation(args) {
    let currentIndex = (i) {
            return i.selected;
    let isDown = args.keyCode === 40;
    items[currentIndex].selected = false;
    if (isDown) {
      items[++currentIndex].selected = true;
    } else {
      items[--currentIndex].selected = true;

Simple keybind to perform save. Prevent is set to true to prevent webbrowser from opening default save dialog.

 <textarea keybind="trigger: ctrl+s; silentSave(); prevent: true; global:false;"></textarea>

Based on aurelia-skeleton-plugin

ZenHub Join the chat at

This skeleton is part of the Aurelia platform. It sets up a standard aurelia plugin using gulp to build your ES6 code with the Babel compiler. Karma/Jasmine testing is also configured.

To keep up to date on Aurelia, please visit and subscribe to the official blog. If you have questions, we invite you to join us on Gitter. If you would like to have deeper insight into our development process, please install the ZenHub Chrome Extension and visit any of our repository's boards. You can get an overview of all Aurelia work by visiting the framework board.

Building The Code

To build the code, follow these steps.

  1. Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.
  2. From the project folder, execute the following command:
npm install
  1. Ensure that Gulp is installed. If you need to install it, use the following command:
npm install -g gulp
  1. To build the code, you can now run:
gulp build
  1. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

  2. See gulpfile.js for other tasks related to generating the docs and linting.

Running The Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

  1. Ensure that the Karma CLI is installed. If you need to install it, use the following command:
npm install -g karma-cli
  1. Ensure that jspm is installed. If you need to install it, use the following commnand:
npm install -g jspm
  1. Install the client-side dependencies with jspm:
jspm install
  1. You can now run the tests with this command:
karma start
You can’t perform that action at this time.