@polymer/iron-a11y-keys

WebJar for @polymer/iron-a11y-keys

License

License

BSD 3-Clause
Categories

Categories

KeY Data Data Formats Formal Verification
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

polymer__iron-a11y-keys
Last Version

Last Version

3.0.1
Release Date

Release Date

Type

Type

jar
Description

Description

@polymer/iron-a11y-keys
WebJar for @polymer/iron-a11y-keys
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

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

Download polymer__iron-a11y-keys

How to add to project

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

Dependencies

compile (2)

Group / Artifact Type Version
org.webjars.npm : polymer__polymer jar [3.0.0,4)
org.webjars.npm : polymer__iron-a11y-keys-behavior jar [3.0.0-pre.26,4)

Project Modules

There are no modules declared in this project.

Published on NPM Build status Published on webcomponents.org

<iron-a11y-keys>

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.

Usage

Installation

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

In an html file

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

    <script>
      // Where to listen for the keys.
      keys.target = document.body;
      keys.addEventListener('keys-pressed', function(event) {
        console.log(event.detail);
      });
    </script>
  </body>
</html>

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"
          on-keys-pressed="onEnter"></iron-a11y-keys>
      <input id="input" placeholder="Type something. Press enter. Check console.">
    `;
  }

  function onEnter() {
    console.log(this.userInput);
  }
}
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
cd iron-a11y-keys
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.npm

Versions

Version
3.0.1