iron-a11y-keys-behavior

WebJar for iron-a11y-keys-behavior

License

License

BSD 3-Clause
Categories

Categories

KeY Data Data Formats Formal Verification
GroupId

GroupId

org.webjars.bowergithub.polymerelements
ArtifactId

ArtifactId

iron-a11y-keys-behavior
Last Version

Last Version

2.1.1
Release Date

Release Date

Type

Type

jar
Description

Description

iron-a11y-keys-behavior
WebJar for iron-a11y-keys-behavior
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/PolymerElements/iron-a11y-keys-behavior

Download iron-a11y-keys-behavior

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.bowergithub.polymerelements/iron-a11y-keys-behavior/ -->
<dependency>
    <groupId>org.webjars.bowergithub.polymerelements</groupId>
    <artifactId>iron-a11y-keys-behavior</artifactId>
    <version>2.1.1</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.bowergithub.polymerelements/iron-a11y-keys-behavior/
implementation 'org.webjars.bowergithub.polymerelements:iron-a11y-keys-behavior:2.1.1'
// https://jarcasting.com/artifacts/org.webjars.bowergithub.polymerelements/iron-a11y-keys-behavior/
implementation ("org.webjars.bowergithub.polymerelements:iron-a11y-keys-behavior:2.1.1")
'org.webjars.bowergithub.polymerelements:iron-a11y-keys-behavior:jar:2.1.1'
<dependency org="org.webjars.bowergithub.polymerelements" name="iron-a11y-keys-behavior" rev="2.1.1">
  <artifact name="iron-a11y-keys-behavior" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.bowergithub.polymerelements', module='iron-a11y-keys-behavior', version='2.1.1')
)
libraryDependencies += "org.webjars.bowergithub.polymerelements" % "iron-a11y-keys-behavior" % "2.1.1"
[org.webjars.bowergithub.polymerelements/iron-a11y-keys-behavior "2.1.1"]

Dependencies

compile (1)

Group / Artifact Type Version
org.webjars.bowergithub.polymer : polymer jar [1.9.0,3)

Project Modules

There are no modules declared in this project.

Published on NPM Build status Published on webcomponents.org

<iron-a11y-keys-behavior>

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
org.webjars.bowergithub.polymerelements

Versions

Version
2.1.1
2.1.0
2.0.1
1.1.9