← Back

iron-a11y-keys-behavior

A behavior that enables keybindings for greater a11y

Author

Rating

Popularity

<100

Polymer.IronA11yKeysBehavior provides a normalized interface for processing keyboard commands that pertain to WAI-ARIA best practices. The element takes care of browser differences with respect to Keyboard events and uses an expressive syntax to filter key presses.

See: Documentation, Demo.

Usage

Installation

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

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import {mixinBehaviors} from '@polymer/polymer/lib/legacy/class.js';
import {IronA11yKeysBehavior} from '@polymer/iron-a11y-keys-behavior/iron-a11y-keys-behavior.js';

class SampleElement extends  extends mixinBehaviors([IronA11yKeysBehavior], PolymerElement) {
  static get template() {
    return html`
      <pre>[[pressed]]</pre>
    `;
  }

  static get properties() {
    return {
      pressed: {type: String, readOnly: true, value: ''},
      keyBindings: {
        'space': '_onKeydown', // same as 'space:keydown'
        'shift+tab': '_onKeydown',
        'enter:keypress': '_onKeypress',
        'esc:keyup': '_onKeyup'
      }
    }
  }

  function _onKeydown: function(event) {
    console.log(event.detail.combo); // KEY+MODIFIER, e.g. "shift+tab"
    console.log(event.detail.key); // KEY only, e.g. "tab"
    console.log(event.detail.event); // EVENT, e.g. "keydown"
    console.log(event.detail.keyboardEvent); // the original KeyboardEvent
  }
}
customElements.define('sample-element', SampleElement);

Contributing

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

Installation

git clone https://github.com/PolymerElements/iron-a11y-keys-behavior
cd iron-a11y-keys-behavior
npm install
npm install -g polymer-cli

Running the demo locally

polymer serve --npm
open http://127.0.0.1:<port>/demo/

Running the tests

polymer test --npm

Compatibility

(Loading compatibility data...)

Was this helpful? Need more help?
Leave a comment or a question below. You can also join the chat on Discord or ask questions on StackOverflow.

Version

Dependencies

@polymer/polymer#^3.0.0

Released: 2018-09-14
Maturity: IMPORTED
License: BSD 3-clause "New" or "Revised" License

Compatibility

Framework: Polymer 1.0+; Polymer 3.0+; Polymer 2.0+ in 2.1.1
Browser: Browser Independent

iron-a11y-keys-behavior - Vaadin Add-on Directory

Name: iron-a11y-keys-behavior
Availability: InStock
Rating: 5 (121 reviews)
Author: PolymerElements

A behavior that enables keybindings for greater a11y

iron-a11y-keys-behavior - Vaadin Add-on Directory

[![Published on NPM](https://img.shields.io/npm/v/@polymer/iron-a11y-keys-behavior.svg)](https://www.npmjs.com/package/@polymer/iron-a11y-keys-behavior) [![Build status](https://travis-ci.org/PolymerElements/iron-a11y-keys-behavior.svg?branch=master)](https://travis-ci.org/PolymerElements/iron-a11y-keys-behavior) [![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://webcomponents.org/element/@polymer/iron-a11y-keys-behavior) ## <iron-a11y-keys-behavior> `Polymer.IronA11yKeysBehavior` provides a normalized interface for processing keyboard commands that pertain to [WAI-ARIA best practices](http://www.w3.org/TR/wai-aria-practices/#kbd_general_binding). The element takes care of browser differences with respect to Keyboard events and uses an expressive syntax to filter key presses. See: [Documentation](https://www.webcomponents.org/element/@polymer/iron-a11y-keys-behavior), [Demo](https://www.webcomponents.org/element/@polymer/iron-a11y-keys-behavior/demo/demo/index.html). ## Usage ### Installation ``` npm install --save @polymer/iron-a11y-keys-behavior ``` ### In a Polymer 3 element ```js import {PolymerElement, html} from '@polymer/polymer'; import {mixinBehaviors} from '@polymer/polymer/lib/legacy/class.js'; import {IronA11yKeysBehavior} from '@polymer/iron-a11y-keys-behavior/iron-a11y-keys-behavior.js'; class SampleElement extends extends mixinBehaviors([IronA11yKeysBehavior], PolymerElement) { static get template() { return html`

[[pressed]]

`; } static get properties() { return { pressed: {type: String, readOnly: true, value: ''}, keyBindings: { 'space': '_onKeydown', // same as 'space:keydown' 'shift+tab': '_onKeydown', 'enter:keypress': '_onKeypress', 'esc:keyup': '_onKeyup' } } } function _onKeydown: function(event) { console.log(event.detail.combo); // KEY+MODIFIER, e.g. "shift+tab" console.log(event.detail.key); // KEY only, e.g. "tab" console.log(event.detail.event); // EVENT, e.g. "keydown" console.log(event.detail.keyboardEvent); // the original KeyboardEvent } } customElements.define('sample-element', SampleElement); ``` ## Contributing If you want to send a PR to this element, here are the instructions for running the tests and demo locally: ### Installation ```sh git clone https://github.com/PolymerElements/iron-a11y-keys-behavior cd iron-a11y-keys-behavior npm install npm install -g polymer-cli ``` ### Running the demo locally ```sh polymer serve --npm open http://127.0.0.1:/demo/ ``` ### Running the tests ```sh polymer test --npm ```

Online Demo
View on NPM
View on GitHub
Documentation
GitHub Homepage
Issue tracker
License

iron-a11y-keys-behavior version 0.9.0
### Dependencies * polymer#polymer/polymer#v0.9.0-rc.1

iron-a11y-keys-behavior version 0.9.1
### Dependencies * webcomponentsjs#webcomponents/webcomponentsjs#^0.7.0 * polymer#Polymer/polymer#^0.9.0

iron-a11y-keys-behavior version 0.9.2
### Dependencies * polymer#Polymer/polymer#^0.9.0

iron-a11y-keys-behavior version 0.9.3
### Dependencies * polymer#Polymer/polymer#^0.9.0

iron-a11y-keys-behavior version 0.9.4
### Dependencies * polymer#Polymer/polymer#^0.9.0

iron-a11y-keys-behavior version 1.0.0
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.0.1
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.0.2
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.0.3
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.0.4
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.0.5
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.0.6
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.0.7
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.0.8
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.0.9
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.1.0
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.1.1
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 0.0.1
### Dependencies * @polymer/polymer#^1.2.5-npm-test.2

iron-a11y-keys-behavior version 0.0.3
### Dependencies * @polymer/polymer#^1.2.5-npm-test.2

iron-a11y-keys-behavior version 1.1.2
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.1.3
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.1.4
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.1.5
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.1.6
### Dependencies * polymer#Polymer/polymer#^1.0.0

iron-a11y-keys-behavior version 1.1.7
### Dependencies * polymer#Polymer/polymer#^1.1.0

iron-a11y-keys-behavior version 1.1.8
### Dependencies * polymer#Polymer/polymer#^1.1.0

iron-a11y-keys-behavior version 1.1.9
### Dependencies * polymer#Polymer/polymer#^1.1.0

iron-a11y-keys-behavior version 2.0.0
### Dependencies * polymer#Polymer/polymer#1.9 - 2

iron-a11y-keys-behavior version 2.0.1
### Dependencies * polymer#Polymer/polymer#1.9 - 2

iron-a11y-keys-behavior version 3.0.0-pre.1
### Dependencies * @polymer/polymer#^3.0.0-pre.1

iron-a11y-keys-behavior version 3.0.0-pre.2
### Dependencies * @polymer/polymer#^3.0.0-pre.1

iron-a11y-keys-behavior version 3.0.0-pre.3
### Dependencies * @polymer/polymer#^3.0.0-pre.3

iron-a11y-keys-behavior version 3.0.0-pre.4
### Dependencies * @polymer/polymer#^3.0.0-pre.4

iron-a11y-keys-behavior version 3.0.0-pre.6
### Dependencies * @polymer/polymer#^3.0.0-pre.6

iron-a11y-keys-behavior version 3.0.0-pre.7
### Dependencies * @polymer/polymer#^3.0.0-pre.7

iron-a11y-keys-behavior version 3.0.0-pre.8
### Dependencies * @polymer/polymer#^3.0.0-pre.7

iron-a11y-keys-behavior version 2.1.0
### Dependencies * polymer#Polymer/polymer#1.9 - 2

iron-a11y-keys-behavior version 3.0.0-pre.10
### Dependencies * @polymer/polymer#^3.0.0-pre.10

iron-a11y-keys-behavior version 3.0.0-pre.11
### Dependencies * @polymer/polymer#^3.0.0-pre.10

iron-a11y-keys-behavior version 3.0.0-pre.12
### Dependencies * @polymer/polymer#3.0.0-pre.12

iron-a11y-keys-behavior version 2.1.1
### Dependencies * polymer#Polymer/polymer#1.9 - 2

iron-a11y-keys-behavior version 3.0.0-pre.13
### Dependencies * @polymer/polymer#^3.0.0-pre.13

iron-a11y-keys-behavior version 3.0.0-pre.14
### Dependencies * @polymer/polymer#^3.0.0-pre.13

iron-a11y-keys-behavior version 3.0.0-pre.15
### Dependencies * @polymer/polymer#^3.0.0-pre.13

iron-a11y-keys-behavior version 3.0.0-pre.16
### Dependencies * @polymer/polymer#^3.0.0-pre.13

iron-a11y-keys-behavior version 3.0.0-pre.17
### Dependencies * @polymer/polymer#^3.0.0-pre.13

iron-a11y-keys-behavior version 3.0.0-pre.18
### Dependencies * @polymer/polymer#^3.0.0

iron-a11y-keys-behavior version 3.0.0-pre.19
### Dependencies * @polymer/polymer#^3.0.0

iron-a11y-keys-behavior version 3.0.0-pre.20
### Dependencies * @polymer/polymer#^3.0.0

iron-a11y-keys-behavior version 3.0.0-pre.21
### Dependencies * @polymer/polymer#^3.0.0

iron-a11y-keys-behavior version 3.0.0-pre.22
### Dependencies * @polymer/polymer#^3.0.0

iron-a11y-keys-behavior version 3.0.0-pre.23
### Dependencies * @polymer/polymer#^3.0.0

iron-a11y-keys-behavior version 3.0.0-pre.24
### Dependencies * @polymer/polymer#^3.0.0

iron-a11y-keys-behavior version 3.0.0-pre.25
### Dependencies * @polymer/polymer#^3.0.0

iron-a11y-keys-behavior version 3.0.0-pre.26
### Dependencies * @polymer/polymer#^3.0.0

iron-a11y-keys-behavior version 3.0.0
### Dependencies * @polymer/polymer#^3.0.0

iron-a11y-keys-behavior version 3.0.1
### Dependencies * @polymer/polymer#^3.0.0

Directory