iron-a11y-keys | Vaadin

A basic element implementation of iron-a11y-keys-behavior

Published on NPM Build status Published on


iron-a11y-keys provides a cross-browser interface for processing keyboard commands. The interface adheres to WAI-ARIA best practices. It uses an expressive syntax to filter key presses.

See: Documentation, Demo.



npm install --save @polymer/iron-a11y-keys

In an html file

    <script type="module">
      import '@polymer/iron-a11y-keys/iron-a11y-keys.js';
    <iron-a11y-keys id="keys" keys="left right down up"></iron-a11y-keys>

      // Where to listen for the keys. = document.body;
      keys.addEventListener('keys-pressed', function(event) {

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/iron-a11y-keys/iron-a11y-keys.js';

class SampleElement extends PolymerElement {
  static get properties() {
    return {
      target: {
        type: Object,
        value: function() {
          return this.$.input;

  static get template() {
    return html`
      <iron-a11y-keys id="a11y"
          target="[[target]]" keys="enter"
      <input id="input" placeholder="Type something. Press enter. Check console.">

  function onEnter() {
customElements.define('sample-element', SampleElement);


If you want to send a PR to this element, here are the instructions for running the tests and demo locally:


git clone
cd iron-a11y-keys
npm install
npm install -g polymer-cli

Running the demo locally

polymer serve --npm

Running the tests

polymer test --npm


Link to this version
ImportedReleased 14 September 2018BSD 3-clause "New" or "Revised" License
Framework Support
Polymer 3.0+
Also supported:
Polymer 1 (1.0.9)Polymer 2 (2.1.2)
Browser Independent
Install with
npm install @polymer/iron-a11y-keys"@3.0.1"
Run the above npm command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 3.0.1


  • @polymer/polymer#^3.0.0
  • @polymer/iron-a11y-keys-behavior#^3.0.0-pre.26