U4-11412 documented umbConfirm directive
This commit is contained in:
@@ -1,12 +1,51 @@
|
||||
/**
|
||||
* @ngdoc directive
|
||||
* @name umbraco.directives.directive:umbConfirm
|
||||
* @function
|
||||
* @description
|
||||
* A confirmation dialog
|
||||
*
|
||||
* @restrict E
|
||||
*/
|
||||
@ngdoc directive
|
||||
@name umbraco.directives.directive:umbConfirm
|
||||
@restrict E
|
||||
@scope
|
||||
|
||||
@description
|
||||
A confirmation dialog
|
||||
|
||||
|
||||
<h3>Markup example</h3>
|
||||
<pre>
|
||||
<div ng-controller="My.Controller as vm">
|
||||
|
||||
<umb-confirm caption="Title" on-confirm="vm.onConfirm()" on-cancel="vm.onCancel()"></umb-confirm>
|
||||
|
||||
</div>
|
||||
</pre>
|
||||
|
||||
<h3>Controller example</h3>
|
||||
<pre>
|
||||
(function () {
|
||||
"use strict";
|
||||
|
||||
function Controller() {
|
||||
|
||||
var vm = this;
|
||||
|
||||
vm.onConfirm = function() {
|
||||
alert('Confirm clicked');
|
||||
};
|
||||
|
||||
vm.onCancel = function() {
|
||||
alert('Cancel clicked');
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
angular.module("umbraco").controller("My.Controller", Controller);
|
||||
|
||||
})();
|
||||
</pre>
|
||||
|
||||
@param {string} caption (<code>attribute</code>): The caption shown above the buttons
|
||||
@param {callback} on-confirm (<code>attribute</code>): The call back when the "OK" button is clicked. If not set the button will not be shown
|
||||
@param {callback} on-cancel (<code>atribute</code>): The call back when the "Cancel" button is clicked. If not set the button will not be shown
|
||||
**/
|
||||
function confirmDirective() {
|
||||
return {
|
||||
restrict: "E", // restrict to an element
|
||||
|
||||
Reference in New Issue
Block a user