This Ember mixin is a Get Out of Jail Free Card that injects a 'beforeDestroy' hook and 'pardon'/'unpardon' methods which allow for the halt or continuation of an object's destruction.
npm install --save-dev ember-pardon
import Ember from 'ember';
import EmberPardon from 'ember-pardon';
// as a mixin:
var NewObject = Ember.Object.extend(EmberPardon,{
// ...
});
// or add to the original class:
Ember.View.reopen(EmberPardon);
Please Note: For Ember.View it is recommended to reopen the class because of how Ember organizes and manages virtual parent views. It is definitely possible to add as a mixin only, but keep in mind that Ember will destroy the view's virtual parent first. Ember Pardon checks its parent to see if it is virtual, and then checks to see if it can be pardoned. If so, then it pardons the parent, allowing the natural Ember view order to be maintained. Unpardoning the child does the inverse, and will attempt to unpardon the parent as well, but only if the parent is virtual.
Ember Pardon gives your objects freedom once each cycle. It adds the following:
-
beforeDestroy()
Called beforewillDestroy
. Overriding this function and callingthis.pardon()
will save the object from being destroyed, which includes being removed from the DOM in the case of a View. -
pardon()
Retains the object from destruction during this one cycle. -
unpardon()
Reverts the object to default behavior, allowing it to be destroyed. -
_isPardoned
: Private
Private variable that tracks whether or not the object should be pardoned.
The following creates an example class that pardons the first time destroy
is called, but will retain original behavior the second time around.
unpardon()
only exists for those rare times that you want to cancel a previous pardon. PLEASE NOTE: Pardon and Unpardon are reset after each destroy cycle.
import Ember from 'ember';
import EmberPardon from 'ember-pardon';
Ember.View.reopen(EmberPardon);
var ExampleView = Ember.View.extend({
shouldStickAround:true,
beforeDestroy:function(){
if (this.shouldStickAround){
this.set('shouldStickAround', false);
this.pardon();
return;
}
/**
unpardon used here doesn't really do anything
because nothing was changed above. Use this
to cancel out previous calls to pardon().
**/
this.unpardon();
}
});
export default ExampleView;
For more information on using ember-cli, visit http://www.ember-cli.com/.