Files
ionic-framework/js/angular/service/navBarDelegate.js
2014-11-12 09:15:21 -06:00

75 lines
2.0 KiB
JavaScript

/**
* @ngdoc service
* @name $ionicNavBarDelegate
* @module ionic
* @description
* Delegate for controlling the {@link ionic.directive:ionNavBar} directive.
*
* @usage
*
* ```html
* <body ng-controller="MyCtrl">
* <ion-nav-bar>
* <button ng-click="setNavTitle('banana')">
* Set title to banana!
* </button>
* </ion-nav-bar>
* </body>
* ```
* ```js
* function MyCtrl($scope, $ionicNavBarDelegate) {
* $scope.setNavTitle = function(title) {
* $ionicNavBarDelegate.setTitle(title);
* }
* }
* ```
*/
IonicModule
.service('$ionicNavBarDelegate', delegateService([
/**
* @ngdoc method
* @name $ionicNavBarDelegate#align
* @description Aligns the title with the buttons in a given direction.
* @param {string=} direction The direction to the align the title text towards.
* Available: 'left', 'right', 'center'. Default: 'center'.
*/
'align',
/**
* @ngdoc method
* @name $ionicNavBarDelegate#showBackButton
* @description
* Set/get whether the {@link ionic.directive:ionNavBackButton} is shown
* (if it exists).
* @param {boolean=} show Whether to show the back button.
* @returns {boolean} Whether the back button is shown.
*/
'showBackButton',
/**
* @ngdoc method
* @name $ionicNavBarDelegate#showBar
* @description
* Set/get whether the {@link ionic.directive:ionNavBar} is shown.
* @param {boolean} show Whether to show the bar.
* @returns {boolean} Whether the bar is shown.
*/
'showBar',
/**
* @ngdoc method
* @name $ionicNavBarDelegate#title
* @description
* Set the title for the {@link ionic.directive:ionNavBar}.
* @param {string} title The new title to show.
*/
'title',
/**
* @ngdoc method
* @name $ionicNavBarDelegate#update
* @description
* Updates the {@link ionic.directive:ionNavBar} with a transition using the
* supplied view data.
* @param {object} viewData An object containing `title`, `showBar` properties.
*/
'update'
]));