-
-
Notifications
You must be signed in to change notification settings - Fork 70
Add Target Action Support deprecation guide #1410
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
Draft
wagenet
wants to merge
2
commits into
ember-learn:main
Choose a base branch
from
wagenet:target-action
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
--- | ||
title: Deprecate Target Action Support | ||
until: 7.0.0 | ||
since: 6.8.0 | ||
--- | ||
|
||
The `actions` hash on components, controllers, and routes, along with the `send` method, is deprecated. These APIs were primarily used with the previously-deprecated `{{action}}` modifier and helper. | ||
|
||
The modern approach is to use standard class methods decorated with the `@action` decorator, and to pass functions directly. | ||
|
||
### `actions` hash and `send` | ||
|
||
**Old Pattern** | ||
|
||
Previously, you would define actions in an `actions` hash and use `this.send('actionName')` to call them. | ||
|
||
```javascript | ||
// app/components/my-component.js | ||
import Component from '@ember/component'; | ||
|
||
export default Component.extend({ | ||
actions: { | ||
save() { | ||
// ... saving logic | ||
}, | ||
cancel() { | ||
// ... cancel logic | ||
} | ||
}, | ||
|
||
someMethod() { | ||
this.send('save'); | ||
} | ||
}); | ||
``` | ||
|
||
**New Pattern** | ||
|
||
With modern classes, you can define methods directly on the class and decorate them with `@action`. You can then call them like any other method. | ||
|
||
```javascript | ||
// app/components/my-component.js | ||
import Component from '@glimmer/component'; | ||
import { action } from '@ember/object'; | ||
|
||
export default class MyComponent extends Component { | ||
@action | ||
save() { | ||
// ... saving logic | ||
} | ||
|
||
@action | ||
cancel() { | ||
// ... cancel logic | ||
} | ||
|
||
someMethod() { | ||
this.save(); | ||
} | ||
} | ||
``` |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
speaking of
@action
-- do we ever update deprecation guides? the recommendation will change once we actually get plain methods working for realThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't we just deprecate
@action
at that point?Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we could -- tho that would be hugely disruptive across the ecosystem, so I think I'd want to wait a smidge.
There was huge resistance to deprecating
@action
here: emberjs/rfcs#1045 (which the RFC wasn't even proposing)maybe that'll change once the alternative ships