-
-
Notifications
You must be signed in to change notification settings - Fork 407
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #194 from GavinJoyce/gj/deprecate-custom-event-man…
…anger Deprecate component `eventManager`
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,38 @@ | ||
- Start Date: (fill me in with today's date, YYYY-MM-DD) | ||
- RFC PR: (leave this empty) | ||
- Ember Issue: (leave this empty) | ||
|
||
# Summary | ||
|
||
Support for component `eventManger`s is a seldom used feature and should | ||
be deprecated. | ||
|
||
# Motivation | ||
|
||
We should strive to simplify the Ember API and source code where possible. As | ||
the custom `eventManager` feature is rarely used in apps, we should deprecate | ||
it. | ||
|
||
# Detailed design | ||
|
||
We'll introduce a deprecation warning which will be displayed when a component | ||
defines an `eventManager` property or when `canDispatchToEventManager` is set to | ||
true on `EventDispatcher`. The warning will have a target version of `3.0`. | ||
|
||
If required, we can create an addon which extends the `EventDispatcher` allowing | ||
for opt-in custom `eventManager`s in Ember apps. | ||
|
||
# How We Teach This | ||
|
||
As this is a seldom used feature, we can simply note the deprecation in a | ||
future release blog post. | ||
|
||
# Drawbacks | ||
|
||
This adds a little more churn for apps that rely on this feature. | ||
|
||
# Alternatives | ||
|
||
This feature was [recently made pay-as-you-go](https://github.com/emberjs/ember.js/pull/14756), | ||
so the immediate performance concerns have been addressed. We could decide to | ||
leave this in the framework as an opt-in feature. |