-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Docs/153 deprecated features in migration #158
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
89548b5
refactor (#153): move migration introduction into folder
bencodezen b6b2e3b
docs (#153): add keycodes deprecated section
bencodezen ebd3a3f
docs (#153): update keycode file naming and terminology
bencodezen 4c07b03
Merge branch 'master' into docs/153-deprecated-features-in-migration
bencodezen c76d7da
docs: fix grammar
bencodezen 30b2223
docs: improve display
bencodezen ec1e863
Merge branch 'master' into docs/153-deprecated-features-in-migration
bencodezen 1edc063
Merge branch 'master' into docs/153-deprecated-features-in-migration
bencodezen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# KeyCode Modifiers | ||
|
||
## Overview | ||
|
||
Here is a quick summary of what has changed: | ||
|
||
- **BREAKING**: Using numbers, i.e. keyCodes, as `v-on` modifiers are no longer supported | ||
- **BREAKING**: `config.keyCodes` is no longer supported | ||
|
||
## Previous Syntax | ||
|
||
In Vue 2, keyCodes were supported as a way to modify a `v-on` method. | ||
bencodezen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```html | ||
<!-- keyCode version --> | ||
<input v-on:keyup.13="submit" /> | ||
|
||
<!-- alias version --> | ||
<input v-on:keyup.enter="submit" /> | ||
``` | ||
|
||
In addition, you could define your own aliases via the global `config.keyCodes` option. | ||
|
||
```js | ||
Vue.config.keyCodes = { | ||
f1: 112 | ||
} | ||
``` | ||
|
||
```html | ||
<!-- keyCode version --> | ||
<input v-on:keyup.112="showHelpText" /> | ||
|
||
<!-- custom alias version --> | ||
<input v-on:keyup.f1="showHelpText" /> | ||
``` | ||
|
||
## Current Syntax | ||
|
||
Since [`KeyboardEvent.keyCode` has been deprecated](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode), 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. | ||
|
||
```html | ||
<!-- Vue 3 Key Modifier on v-on --> | ||
<input v-on:keyup.delete="confirmDelete" /> | ||
``` | ||
|
||
As a result, this means that `config.keyCodes` is now also deprecated and will no longer be supported. | ||
|
||
## How to Migrate | ||
|
||
For those using `keyCode` in their codbase, we recommend converting them to their kebab-cased named equivalents. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.