feat($ionicBackdrop): add backdrop show/hide service

Closes #1084
This commit is contained in:
Andy Joslin
2014-04-11 09:06:54 -06:00
parent bc3e223e33
commit 730a33b9c3
2 changed files with 56 additions and 2 deletions

View File

@@ -399,7 +399,19 @@
</ul>
</li>
<!-- Backdrop -->
<li class="menu-section">
<a href="#" class="api-section">
Backdrop
</a>
<ul>
<li>
<a href="{{ page.versionHref }}/api/service/$ionicBackdrop">
$ionicBackdrop
</a>
</li>
</ul>
</li>
<!-- Utility -->
<li class="menu-section">

View File

@@ -1,7 +1,38 @@
angular.module('ionic')
/**
* @private
* @ngdoc service
* @name $ionicBackdrop
* @module ionic
* @description
* Shows and hides a backdrop over the UI. Appears behind popups, loading,
* and other overlays.
*
* Often, multiple UI components require a backdrop, but only one backdrop is
* ever needed in the DOM at a time.
*
* Therefore, each component that requires the backdrop to be shown calls
* `$ionicBackdrop.retain()` when it wants the backdrop, then `$ionicBackdrop.release()`
* when it is done with the backdrop.
*
* For each time `retain` is called, the backdrop will be shown until `release` is called.
*
* For example, if `retain` is called three times, the backdrop will be shown until `release`
* is called three times.
*
* @usage
*
* ```js
* function MyController($scope, $ionicBackdrop, $timeout) {
* //Show a backdrop for one second
* $scope.action = function() {
* $ionicBackdrop.retain();
* $timeout(function() {
* $ionicBackdrop.release();
* }, 1000);
* };
* }
* ```
*/
.factory('$ionicBackdrop', [
'$document',
@@ -13,7 +44,18 @@ function($document) {
$document[0].body.appendChild(el[0]);
return {
/**
* @ngdoc method
* @name $ionicBackdrop#retain
* @description Retains the backdrop.
*/
retain: retain,
/**
* @ngdoc method
* @name $ionicBackdrop#retain
* @description
* Releases the backdrop.
*/
release: release,
// exposed for testing
_element: el