Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(32)

Unified Diff: third_party/polymer/components/iron-a11y-keys-behavior/README.md

Issue 2113853002: Run bower update (Closed) Base URL: https://github.com/catapult-project/catapult@polymer10-migration
Patch Set: Created 4 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: third_party/polymer/components/iron-a11y-keys-behavior/README.md
diff --git a/third_party/polymer/components/iron-a11y-keys-behavior/README.md b/third_party/polymer/components/iron-a11y-keys-behavior/README.md
index 30ab211dc8a17097e7036917ffad9e038e39e401..b0949871d182e95a0fa6cabafa15d33f3d55b09a 100644
--- a/third_party/polymer/components/iron-a11y-keys-behavior/README.md
+++ b/third_party/polymer/components/iron-a11y-keys-behavior/README.md
@@ -25,11 +25,34 @@ The element takes care of browser differences with respect to Keyboard events
and uses an expressive syntax to filter key presses.
Use the `keyBindings` prototype property to express what combination of keys
-will trigger the event to fire.
-
-Use the `key-event-target` attribute to set up event handlers on a specific
+will trigger the callback. A key binding has the format
+`"KEY+MODIFIER:EVENT": "callback"` (`"KEY": "callback"` or
+`"KEY:EVENT": "callback"` are valid as well). Some examples:
+
+```javascript
+ keyBindings: {
+ 'space': '_onKeydown', // same as 'space:keydown'
+ 'shift+tab': '_onKeydown',
+ 'enter:keypress': '_onKeypress',
+ 'esc:keyup': '_onKeyup'
+ }
+```
+
+The callback will receive with an event containing the following information in `event.detail`:
+
+```javascript
+ _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
+ }
+```
+
+Use the `keyEventTarget` attribute to set up event handlers on a specific
node.
-The `keys-pressed` event will fire when one of the key combinations set with the
-`keys` property is pressed.
+
+See the [demo source code](https://github.com/PolymerElements/iron-a11y-keys-behavior/blob/master/demo/x-key-aware.html)
+for an example.

Powered by Google App Engine
This is Rietveld 408576698