-
Notifications
You must be signed in to change notification settings - Fork 4.7k
docs (#155): add filters api migration docs #164
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 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
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,75 @@ | ||
--- | ||
types: | ||
- removed | ||
- breaking | ||
--- | ||
|
||
# Filters <span v-for="type in $frontmatter.types" class="badge" :key="`type-${type}`">{{ type }}</span> | ||
|
||
## Overview | ||
|
||
Filters are removed from Vue 3.0 and no longer be supported. | ||
|
||
## 2.x Syntax | ||
|
||
In 2.x, developers could use filters in order to apply common text formatting. | ||
|
||
For example: | ||
|
||
```html | ||
<template> | ||
<h1>Bank Account Balance</h1> | ||
<p>{{ accountBalance | currencyUSD }}</p> | ||
</template> | ||
|
||
<script> | ||
export default { | ||
props: { | ||
accountBalance: { | ||
type: Number, | ||
required: true | ||
} | ||
}, | ||
filters: { | ||
currencyUSD(value) { | ||
return '$' + value | ||
} | ||
} | ||
} | ||
</script> | ||
``` | ||
|
||
While this seems like a convenience, it requires a custom syntax that breaks the assumption of expressions inside of curly braces being "just JavaScript," which has both learning and implementation costs. | ||
|
||
## 3.x Update | ||
|
||
In 3.x, filters are removed and no longer supported. Instead, we recommend replacing with method calls or computed properties instead. | ||
|
||
Using the example above, here is one example of how it could be implemented. | ||
|
||
```html | ||
<template> | ||
<h1>Bank Account Balance</h1> | ||
<p>{{ accountInUSD }}</p> | ||
</template> | ||
|
||
<script> | ||
export default { | ||
props: { | ||
accountBalance: { | ||
type: Number, | ||
required: true | ||
} | ||
}, | ||
computed: { | ||
accountInUSD() { | ||
return '$' + this.accountBalance | ||
} | ||
} | ||
} | ||
</script> | ||
``` | ||
|
||
## How to Migrate | ||
|
||
Instead of using filters, we recommend replacing them with computed properties or methods. |
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.