docs(modal): add note about modal.removed,hidden,shown in $ionicModal

This commit is contained in:
Andrew Joslin
2014-06-10 12:51:36 -06:00
parent 374d65e5fe
commit b2caa16c77

View File

@@ -7,6 +7,13 @@
* temporarily. Usually used for making a choice or editing an item.
* Note that you need to put the content of the modal inside a div with the class `modal`.
*
* Hint: Be sure to call [remove()](#remove) when you are done with each modal
* to clean it up and avoid memory leaks.
*
* Note: a modal will broadcast 'modal.shown', 'modal.hidden', and 'modal.removed' events from its originating
* scope, passing in itself as an event argument. Note: both modal.removed and modal.hidden are
* called when the modal is removed.
*
* @usage
* ```html
* <script id="my-modal.html" type="text/ng-template">
@@ -72,8 +79,9 @@ function($rootScope, $document, $compile, $timeout, $ionicPlatform, $ionicTempla
* Hint: Be sure to call [remove()](#remove) when you are done with each modal
* to clean it up and avoid memory leaks.
*
* Note: a modal will broadcast 'modal.shown' and 'modal.hidden' events from its originating
* scope, passing in itself as an event argument.
* Note: a modal will broadcast 'modal.shown', 'modal.hidden', and 'modal.removed' events from its originating
* scope, passing in itself as an event argument. Note: both modal.removed and modal.hidden are
* called when the modal is removed.
*/
var ModalView = ionic.views.Modal.inherit({
/**