https://github.com/polymerelements/iron-a11y-keys-behavior
A behavior that enables keybindings for greater a11y
https://github.com/polymerelements/iron-a11y-keys-behavior
Last synced: about 1 year ago
JSON representation
A behavior that enables keybindings for greater a11y
- Host: GitHub
- URL: https://github.com/polymerelements/iron-a11y-keys-behavior
- Owner: PolymerElements
- Created: 2015-05-05T18:53:47.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2023-10-16T14:02:49.000Z (over 2 years ago)
- Last Synced: 2024-05-09T10:09:32.790Z (about 2 years ago)
- Language: HTML
- Homepage:
- Size: 1.77 MB
- Stars: 24
- Watchers: 15
- Forks: 41
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@polymer/iron-a11y-keys-behavior)
[](https://travis-ci.org/PolymerElements/iron-a11y-keys-behavior)
[](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
```