ngbootbox

ngBootbox
=========

AngularJS wrapper for Bootbox.js. Bootbox.js allowes you to easily make use of Twitter Bootstrap modals for javascript alerts, confirms and prompts. ngBootbox includes three directives, one for each of alert, confirm and prompt.

Installation
=========

bower install ngBootbox

npm install ngbootbox

Development mode
----------------

Production mode
---------------

Initialize module
-----------------
angular.module('yourApp', ['ngBootbox']);

Minification
------------

ngBootbox is minification safe, so to minify your own development files, use Gulp or Grunt with ngAnnotate (gulp-ng-annotate or grunt-ng-annotate).

Demo
====

Visit this page for a working demo.

Directives
==========

ng-bootbox-alert
----------------

Alert

ng-bootbox-confirm
------------------

ng-bootbox-confirm-action="confirmCallbackMethod(attr1, attr2)" ng-bootbox-confirm-action-cancel="confirmCallbackCancel(attr1, attr2)">
Confirm

ng-bootbox-prompt
-----------------

ng-bootbox-prompt-action="promptCallback(result)" ng-bootbox-prompt-action-cancel="promptCallbackCancelled(result)">
Prompt

ng-bootbox-custom-dialog
------------------------

ng-bootbox-title="A cool title!"
ng-bootbox-custom-dialog="Some custom text"
ng-bootbox-buttons="customDialogButtons"
ng-bootbox-class-name="some-class">
Custom dialog

Custom dialog with HTML Template
--------------------------------

ng-bootbox-title="A cool title!"
ng-bootbox-custom-dialog
ng-bootbox-custom-dialog-template="custom-dialog.tpl.html"
ng-bootbox-buttons="customDialogButtons">
Custom dialog with template

Custom dialog options
---------------------

An options object can also be used to configure a custom dialog. A full list of available options can be found in the official Bootbox.js documentation.

ng-bootbox-custom-dialog
ng-bootbox-options="customDialogOptions">
Custom dialog options

Scope passing to custom dialog
------------------------------
You can pass $scope to a custom dialog by specifying the scope parameter in options.

This allows your modal to interact with your controller's scope and bind data in a custom template.

$ngBootbox service
==================

The $ngBootbox service can be used to utilize bootbox.js from within your angular code.

Usage
-----
Inject the $ngBootbox service in your own angular controller, service, directive, etc.

angular.module('yourApp')
.controller('yourCtrl', function($ngBootbox) { ... });

Methods
-------

$3

Returns a promise that is resolved when the dialog is closed.

Example

$ngBootbox.alert('An important message!')
.then(function() {
console.log('Alert closed');
});

$ngBootbox.alert({message:'Another important message!', title:'Ops!'})
.then(function() {
console.log('Alert closed');
});

$3

Returns a promise that is resolved when if confirmed and rejected if dismissed.

Example

$ngBootbox.confirm('A question?')
.then(function() {
console.log('Confirmed!');
}, function() {
console.log('Confirm dismissed!');
});

$ngBootbox.confirm({message:"Another question?", title:'Please answer'})
.then(function() {
console.log('Confirmed!');
}, function() {
console.log('Confirm dismissed!');
});

$3

Returns a promise that is resolved when submitted and rejected if dismissed.

Example

$ngBootbox.prompt('Enter something')
.then(function(result) {
console.log('Prompt returned: ' + result);
}, function() {
console.log('Prompt dismissed!');
});

$3

Example

var options = {
message: 'This is a message!',
title: 'The title!',
className: 'test-class',
buttons: {
warning: {
label: "Cancel",
className: "btn-warning",
callback: function() { ... }
},
success: {
label: "Ok",
className: "btn-success",
callback: function() { ... }
}
}
};

$ngBootbox.customDialog(options);

A full list of available options can be found in the official Bootbox.js documentation.

$3

New in 0.0.4: There is now support for specifying a HTML template also when using the $ngBootbox service for displaying custom dialogs.

$scope.customDialogOptions = {
templateUrl: 'custom-dialog.tpl.html',
scope: $scope,
title: 'The title!',
buttons: $scope.customDialogButtons
};

When doing this, the message property will be overwritten by the content of the HTML template.

$3

Used to set default values for all your Bootbox alerts, confirms, prompts and dialogs.

Example

$ngBootbox.setDefaults({
animate: false,
backdrop: false
});

A full list of available options can be found in the official Bootbox.js documentation.

$3

Hide all currently active bootbox dialogs.

Example

$ngBootbox.hideAll();

$3

Allows the user to add a custom translation for each of the built-in command buttons. The values object should be in this format:

{
OK : '',
CANCEL : '',
CONFIRM : ''
}

$3

Allows the user to remove a locale from the available locale settings.

$3

Allows the user to select a locale rather than using setDefaults("locale", ...).

Configuration
============

$ngBootboxConfigProvider
------------------------

angular.module('yourApp')
.config(function($ngBootboxConfigProvider) {
$ngBootboxConfigProvider.setDefaultLocale('sv');

$ngBootboxConfigProvider.addLocale('ex', { OK: 'OK', CANCEL: 'Avbryt', CONFIRM: 'Bekräfta' });

$ngBootboxConfigProvider.removeLocale('ex');
})
.controller('TestCtrl', function($ngBootboxConfig) {
var defaultLocale = $ngBootboxConfig.getDefaultLocale();
});