# KeyCode Modifiers
breaking
# Overview
Here is a quick summary of what has changed:
- BREAKING: Using numbers, i.e. keyCodes, as
v-on
modifiers is no longer supported - BREAKING:
config.keyCodes
is no longer supported
# 2.x Syntax
In Vue 2, keyCodes
were supported as a way to modify a v-on
method.
<!-- keyCode version -->
<input v-on:keyup.13="submit" />
<!-- alias version -->
<input v-on:keyup.enter="submit" />
2
3
4
5
In addition, you could define your own aliases via the global config.keyCodes
option.
Vue.config.keyCodes = {
f1: 112
}
2
3
<!-- keyCode version -->
<input v-on:keyup.112="showHelpText" />
<!-- custom alias version -->
<input v-on:keyup.f1="showHelpText" />
2
3
4
5
# 3.x Syntax
Since KeyboardEvent.keyCode
has been deprecated (opens new window), it no longer makes sense for Vue 3 to continue supporting this as well. As a result, it is now recommended to use the kebab-case name for any key you want to use as a modifier.
<!-- Vue 3 Key Modifier on v-on -->
<input v-on:keyup.page-down="nextPage">
<!-- Matches both q and Q -->
<input v-on:keypress.q="quit">
2
3
4
5
As a result, this means that config.keyCodes
is now also deprecated and will no longer be supported.
# Migration Strategy
For those using keyCode
in their codebase, we recommend converting them to their kebab-cased named equivalents.
The keys for some punctuation marks can just be included literally. e.g. For the ,
key:
<input v-on:keypress.,="commaPress">
Limitations of the syntax prevent certain characters from being matched, such as "
, '
, /
, =
, >
, and .
. For those characters you should check event.key
inside the listener instead.
CONFIG_KEY_CODES
V_ON_KEYCODE_MODIFIER