mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2026-03-13 10:22:08 +08:00
14
docs/templates/api_menu_version.template.html
vendored
14
docs/templates/api_menu_version.template.html
vendored
@@ -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">
|
||||
|
||||
44
js/ext/angular/src/service/ionicBackdrop.js
vendored
44
js/ext/angular/src/service/ionicBackdrop.js
vendored
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user