x-ms-acceleratorkey

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

The x-ms-acceleratorkey attribute accessibly declares that an accelerator key has been assigned to an element: the element is activated via JavaScript when the key(s) are pressed on a keyboard.

This proprietary property is specific to Internet Explorer and Microsoft Edge.

x-ms-acceleratorkey exposes a notification in the accessibility tree, for screen readers and other assistive technologies, that an accelerator key exists for that element. This attribute does not provide the accelerator key behavior. You must provide JavaScript event handlers, like onkeypress, onkeydown, or onkeyup, to listen for your declared accelerator keys and activate the element accordingly.

To provide a keyboard shortcut for an element that does not need JavaScript, use the accesskey attribute.

Syntax

<button x-ms-acceleratorkey="[explanation of key combination]">…</button>

Value

The accelerator key combination. For example:

  • "Ctrl+B" for a combination of the Ctrl and B keys.
  • "J" for just the J key.
  • "Ctrl+; then K" for a shortcut similar to FogBugz's old keyboard mode. This approach is more complicated, but does not override existing keyboard shortcuts provided by the user's browser or operating system.

See also