1 /// crmUi: Sundry UI helpers
2 (function (angular
, $, _
) {
6 angular
.module('crmUi', [])
8 // example <div crm-ui-accordion crm-title="ts('My Title')" crm-collapsed="true">...content...</div>
9 // WISHLIST: crmCollapsed should support two-way/continous binding
10 .directive('crmUiAccordion', function() {
15 template
: '<div ng-class="cssClasses"><div class="crm-accordion-header">{{crmUiAccordion.title}} <a crm-ui-help="help" ng-if="help"></a></div><div class="crm-accordion-body" ng-transclude></div></div>',
17 link: function (scope
, element
, attrs
) {
19 'crm-accordion-wrapper': true,
20 collapsed
: scope
.crmUiAccordion
.collapsed
23 scope
.$watch('crmUiAccordion', function(crmUiAccordion
) {
24 if (crmUiAccordion
&& crmUiAccordion
.help
) {
25 scope
.help
= crmUiAccordion
.help
.clone({}, {
26 title
: crmUiAccordion
.title
35 // crmUiAlert({text: 'My text', title: 'My title', type: 'error'});
36 // crmUiAlert({template: '<a ng-click="ok()">Hello</a>', scope: $scope.$new()});
37 // var h = crmUiAlert({templateUrl: '~/crmFoo/alert.html', scope: $scope.$new()});
39 .service('crmUiAlert', function($compile
, $rootScope
, $templateRequest
, $q
) {
41 return function crmUiAlert(params
) {
42 var id
= 'crmUiAlert_' + (++count
);
44 if (params
.templateUrl
) {
45 tpl
= $templateRequest(params
.templateUrl
);
47 else if (params
.template
) {
48 tpl
= params
.template
;
51 params
.text
= '<div id="' + id
+ '"></div>'; // temporary stub
53 var result
= CRM
.alert(params
.text
, params
.title
, params
.type
, params
.options
);
55 $q
.when(tpl
, function(html
) {
56 var scope
= params
.scope
|| $rootScope
.$new();
57 var linker
= $compile(html
);
58 $('#' + id
).append($(linker(scope
)));
65 // Simple wrapper around $.crmDatepicker.
66 // example with no time input: <input crm-ui-datepicker="{time: false}" ng-model="myobj.datefield"/>
67 // example with custom date format: <input crm-ui-datepicker="{dateFormat: 'm/d/y'}" ng-model="myobj.datefield"/>
68 .directive('crmUiDatepicker', function () {
75 link: function (scope
, element
, attrs
, ngModel
) {
76 ngModel
.$render = function () {
77 element
.val(ngModel
.$viewValue
).change();
81 .crmDatepicker(scope
.crmUiDatepicker
)
82 .on('change', function() {
83 var requiredLength
= 19;
84 if (scope
.crmUiDatepicker
&& scope
.crmUiDatepicker
.time
=== false) {
87 if (scope
.crmUiDatepicker
&& scope
.crmUiDatepicker
.date
=== false) {
90 ngModel
.$setValidity('incompleteDateTime', !($(this).val().length
&& $(this).val().length
!== requiredLength
));
96 // Display debug information (if available)
97 // For richer DX, checkout Batarang/ng-inspector (Chrome/Safari), or AngScope/ng-inspect (Firefox).
98 // example: <div crm-ui-debug="myobject" />
99 .directive('crmUiDebug', function ($location
) {
105 template: function() {
106 var args
= $location
.search();
107 return (args
&& args
.angularDebug
) ? '<div crm-ui-accordion=\'{title: ts("Debug (%1)", {1: crmUiDebug}), collapsed: true}\'><pre>{{data|json}}</pre></div>' : '';
109 link: function(scope
, element
, attrs
) {
110 var args
= $location
.search();
111 if (args
&& args
.angularDebug
) {
112 scope
.ts
= CRM
.ts(null);
113 scope
.$parent
.$watch(attrs
.crmUiDebug
, function(data
) {
121 // Display a field/row in a field list
122 // example: <div crm-ui-field="{title: ts('My Field')}"> {{mydata}} </div>
123 // example: <div crm-ui-field="{name: 'subform.myfield', title: ts('My Field')}"> <input crm-ui-id="subform.myfield" name="myfield" /> </div>
124 // example: <div crm-ui-field="{name: 'subform.myfield', title: ts('My Field')}"> <input crm-ui-id="subform.myfield" name="myfield" required /> </div>
125 // example: <div crm-ui-field="{name: 'subform.myfield', title: ts('My Field'), help: hs('help_field_name')}"> {{mydata}} </div>
126 .directive('crmUiField', function() {
127 // Note: When writing new templates, the "label" position is particular. See/patch "var label" below.
129 default: '~/crmUi/field.html',
130 checkbox
: '~/crmUi/field-cb.html'
134 require
: '^crmUiIdScope',
137 // {title, name, help, helpFile}
140 templateUrl: function(tElement
, tAttrs
){
141 var layout
= tAttrs
.crmLayout
? tAttrs
.crmLayout
: 'default';
142 return templateUrls
[layout
];
145 link: function (scope
, element
, attrs
, crmUiIdCtrl
) {
146 $(element
).addClass('crm-section');
148 scope
.$watch('crmUiField', function(crmUiField
) {
149 if (crmUiField
&& crmUiField
.help
) {
150 scope
.help
= crmUiField
.help
.clone({}, {
151 title
: crmUiField
.title
159 // example: <div ng-form="subform" crm-ui-id-scope><label crm-ui-for="subform.foo">Foo:</label><input crm-ui-id="subform.foo" name="foo"/></div>
160 .directive('crmUiId', function () {
162 require
: '^crmUiIdScope',
165 pre: function (scope
, element
, attrs
, crmUiIdCtrl
) {
166 var id
= crmUiIdCtrl
.get(attrs
.crmUiId
);
167 element
.attr('id', id
);
173 // for example, see crmUiHelp
174 .service('crmUiHelp', function(){
175 // example: var h = new FieldHelp({id: 'foo'}); h.open();
176 function FieldHelp(options
) {
177 this.options
= options
;
179 angular
.extend(FieldHelp
.prototype, {
181 return this.options
[n
];
183 open
: function open() {
184 CRM
.help(this.options
.title
, {id
: this.options
.id
, file
: this.options
.file
});
186 clone
: function clone(options
, defaults
) {
187 return new FieldHelp(angular
.extend({}, defaults
, this.options
, options
));
191 // example: var hs = crmUiHelp({file: 'CRM/Foo/Bar'});
192 return function(defaults
){
193 // example: hs('myfield')
194 // example: hs({id: 'myfield', title: 'Foo Bar', file: 'Whiz/Bang'})
195 return function(options
) {
196 if (_
.isString(options
)) {
197 options
= {id
: options
};
199 return new FieldHelp(angular
.extend({}, defaults
, options
));
204 // Display a help icon
205 // Example: Use a default *.hlp file
206 // scope.hs = crmUiHelp({file: 'Path/To/Help/File'});
207 // HTML: <a crm-ui-help="hs({title:ts('My Field'), id:'my_field'})">
208 // Example: Use an explicit *.hlp file
209 // HTML: <a crm-ui-help="hs({title:ts('My Field'), id:'my_field', file:'CRM/Foo/Bar'})">
210 .directive('crmUiHelp', function() {
213 link: function(scope
, element
, attrs
) {
214 setTimeout(function() {
215 var crmUiHelp
= scope
.$eval(attrs
.crmUiHelp
);
216 var title
= crmUiHelp
&& crmUiHelp
.get('title') ? ts('%1 Help', {1: crmUiHelp
.get('title')}) : ts('Help');
217 element
.attr('title', title
);
221 .addClass('helpicon')
223 .on('click', function(e
) {
225 scope
.$eval(attrs
.crmUiHelp
).open();
231 // example: <div ng-form="subform" crm-ui-id-scope><label crm-ui-for="subform.foo">Foo:</label><input crm-ui-id="subform.foo" name="foo"/></div>
232 .directive('crmUiFor', function ($parse
, $timeout
) {
234 require
: '^crmUiIdScope',
236 template
: '<span ng-class="cssClasses"><span ng-transclude/><span crm-ui-visible="crmIsRequired" class="crm-marker" title="This field is required.">*</span></span>',
238 link: function (scope
, element
, attrs
, crmUiIdCtrl
) {
239 scope
.crmIsRequired
= false;
240 scope
.cssClasses
= {};
242 if (!attrs
.crmUiFor
) return;
244 var id
= crmUiIdCtrl
.get(attrs
.crmUiFor
);
245 element
.attr('for', id
);
248 var updateCss = function () {
249 scope
.cssClasses
['crm-error'] = !ngModel
.$valid
&& !ngModel
.$pristine
;
252 // Note: if target element is dynamically generated (eg via ngInclude), then it may not be available
253 // immediately for initialization. Use retries/retryDelay to initialize such elements.
254 var init = function (retries
, retryDelay
) {
255 var input
= $('#' + id
);
256 if (input
.length
=== 0) {
259 init(retries
-1, retryDelay
);
265 var tgtScope
= scope
;//.$parent;
266 if (attrs
.crmDepth
) {
267 for (var i
= attrs
.crmDepth
; i
> 0; i
--) {
268 tgtScope
= tgtScope
.$parent
;
272 if (input
.attr('ng-required')) {
273 scope
.crmIsRequired
= scope
.$parent
.$eval(input
.attr('ng-required'));
274 scope
.$parent
.$watch(input
.attr('ng-required'), function (isRequired
) {
275 scope
.crmIsRequired
= isRequired
;
279 scope
.crmIsRequired
= input
.prop('required');
282 ngModel
= $parse(attrs
.crmUiFor
)(tgtScope
);
284 ngModel
.$viewChangeListeners
.push(updateCss
);
295 // Define a scope in which a name like "subform.foo" maps to a unique ID.
296 // example: <div ng-form="subform" crm-ui-id-scope><label crm-ui-for="subform.foo">Foo:</label><input crm-ui-id="subform.foo" name="foo"/></div>
297 .directive('crmUiIdScope', function () {
301 controllerAs
: 'crmUiIdCtrl',
302 controller: function($scope
) {
304 this.get = function(name
) {
306 ids
[name
] = "crmUiId_" + (++uidCount
);
311 link: function (scope
, element
, attrs
) {}
315 // Display an HTML blurb inside an IFRAME.
316 // example: <iframe crm-ui-iframe="getHtmlContent()"></iframe>
317 .directive('crmUiIframe', function ($parse
) {
320 crmUiIframe
: '@' // expression which evalutes to HTML content
322 link: function (scope
, elm
, attrs
) {
323 var iframe
= $(elm
)[0];
324 iframe
.setAttribute('width', '100%');
325 iframe
.setAttribute('frameborder', '0');
327 var refresh = function () {
328 // var iframeHtml = '<html><head><base target="_blank"></head><body onload="parent.document.getElementById(\'' + iframe.id + '\').style.height=document.body.scrollHeight + \'px\'"><scr' + 'ipt type="text/javascript" src="https://gist.github.com/' + iframeId + '.js"></sc' + 'ript></body></html>';
329 var iframeHtml
= scope
.$parent
.$eval(attrs
.crmUiIframe
);
331 var doc
= iframe
.document
;
332 if (iframe
.contentDocument
) {
333 doc
= iframe
.contentDocument
;
335 else if (iframe
.contentWindow
) {
336 doc
= iframe
.contentWindow
.document
;
340 doc
.writeln(iframeHtml
);
344 // If the iframe is in a dialog, respond to resize events
345 $(elm
).parent().on('dialogresize dialogopen', function(e
, ui
) {
346 $(this).css({padding
: '0', margin
: '0', overflow
: 'hidden'});
347 iframe
.setAttribute('height', '' + $(this).innerHeight() + 'px');
350 scope
.$parent
.$watch(attrs
.crmUiIframe
, refresh
);
356 // <a ng-click="$broadcast('my-insert-target', 'some new text')>Insert</a>
357 // <textarea crm-ui-insert-rx='my-insert-target'></textarea>
358 // TODO Consider ways to separate the plain-text/rich-text implementations
359 .directive('crmUiInsertRx', function() {
361 link: function(scope
, element
, attrs
) {
362 scope
.$on(attrs
.crmUiInsertRx
, function(e
, tokenName
) {
363 var id
= element
.attr('id');
364 if (CKEDITOR
.instances
[id
]) {
365 CKEDITOR
.instances
[id
].insertText(tokenName
);
366 $(element
).select2('close').select2('val', '');
367 CKEDITOR
.instances
[id
].focus();
370 var crmForEl
= $('#' + id
);
371 var origVal
= crmForEl
.val();
372 var origPos
= crmForEl
[0].selectionStart
;
373 var newVal
= origVal
.substring(0, origPos
) + tokenName
+ origVal
.substring(origPos
, origVal
.length
);
374 crmForEl
.val(newVal
);
375 var newPos
= (origPos
+ tokenName
.length
);
376 crmForEl
[0].selectionStart
= newPos
;
377 crmForEl
[0].selectionEnd
= newPos
;
379 $(element
).select2('close').select2('val', '');
380 crmForEl
.triggerHandler('change');
388 // Define a rich text editor.
389 // example: <textarea crm-ui-id="myForm.body_html" crm-ui-richtext name="body_html" ng-model="mailing.body_html"></textarea>
390 .directive('crmUiRichtext', function ($timeout
) {
393 link: function (scope
, elm
, attr
, ngModel
) {
394 var ck
= CKEDITOR
.replace(elm
[0]);
397 _
.extend(ck
.config
, {
400 filebrowserBrowseUrl
: CRM
.crmUi
.browseUrl
+ '?cms=civicrm&type=files',
401 filebrowserImageBrowseUrl
: CRM
.crmUi
.browseUrl
+ '?cms=civicrm&type=images',
402 filebrowserFlashBrowseUrl
: CRM
.crmUi
.browseUrl
+ '?cms=civicrm&type=flash',
403 filebrowserUploadUrl
: CRM
.crmUi
.uploadUrl
+ '?cms=civicrm&type=files',
404 filebrowserImageUploadUrl
: CRM
.crmUi
.uploadUrl
+ '?cms=civicrm&type=images',
405 filebrowserFlashUploadUrl
: CRM
.crmUi
.uploadUrl
+ '?cms=civicrm&type=flash',
414 ck
.on('blur', function(){
416 scope
.$eval(attr
.ngBlur
);
421 // CRM-16445 - When one inserts an image, none of these events seem to fire at the right time:
422 // afterCommandExec, afterInsertHtml, afterPaste, afterSetData, change, insertElement,
423 // insertHtml, insertText, pasteState. It seems that 'pasteState' is the general equivalent of
424 // what 'change' should be, except (in the case of image insertion) it fires too soon.
425 // The 'key' event is needed to detect changes in "Source" mode.
427 angular
.forEach(['key', 'pasteState'], function(evName
){
428 ck
.on(evName
, function(evt
) {
429 $timeout
.cancel(debounce
);
430 debounce
= $timeout(function() {
431 ngModel
.$setViewValue(ck
.getData());
436 ngModel
.$render = function (value
) {
437 ck
.setData(ngModel
.$viewValue
);
443 // Display a lock icon (based on a boolean).
444 // example: <a crm-ui-lock binding="mymodel.boolfield"></a>
445 // example: <a crm-ui-lock
446 // binding="mymodel.boolfield"
447 // title-locked="ts('Boolfield is locked')"
448 // title-unlocked="ts('Boolfield is unlocked')"></a>
449 .directive('crmUiLock', function ($parse
, $rootScope
) {
450 var defaultVal = function (defaultValue
) {
451 var f = function (scope
) {
454 f
.assign = function (scope
, value
) {
460 // like $parse, but accepts a defaultValue in case expr is undefined
461 var parse = function (expr
, defaultValue
) {
462 return expr
? $parse(expr
) : defaultVal(defaultValue
);
467 link: function (scope
, element
, attrs
) {
468 var binding
= parse(attrs
.binding
, true);
469 var titleLocked
= parse(attrs
.titleLocked
, ts('Locked'));
470 var titleUnlocked
= parse(attrs
.titleUnlocked
, ts('Unlocked'));
472 $(element
).addClass('ui-icon lock-button');
473 var refresh = function () {
474 var locked
= binding(scope
);
477 .removeClass('ui-icon-unlocked')
478 .addClass('ui-icon-locked')
479 .prop('title', titleLocked(scope
))
484 .removeClass('ui-icon-locked')
485 .addClass('ui-icon-unlocked')
486 .prop('title', titleUnlocked(scope
))
491 $(element
).click(function () {
492 binding
.assign(scope
, !binding(scope
));
494 $rootScope
.$digest();
497 scope
.$watch(attrs
.binding
, refresh
);
498 scope
.$watch(attrs
.titleLocked
, refresh
);
499 scope
.$watch(attrs
.titleUnlocked
, refresh
);
506 // CrmUiOrderCtrl is a controller class which manages sort orderings.
508 // JS: $scope.myOrder = new CrmUiOrderCtrl(['+field1', '-field2]);
509 // $scope.myOrder.toggle('field1');
510 // $scope.myOrder.setDir('field2', '');
511 // HTML: <tr ng-repeat="... | order:myOrder.get()">...</tr>
512 .service('CrmUiOrderCtrl', function(){
514 function CrmUiOrderCtrl(defaults
){
515 this.values
= defaults
;
517 angular
.extend(CrmUiOrderCtrl
.prototype, {
518 get: function get() {
521 getDir
: function getDir(name
) {
522 if (this.values
.indexOf(name
) >= 0 || this.values
.indexOf('+' + name
) >= 0) {
525 if (this.values
.indexOf('-' + name
) >= 0) {
530 // @return bool TRUE if something is removed
531 remove
: function remove(name
) {
532 var idx
= this.values
.indexOf(name
);
534 this.values
.splice(idx
, 1);
541 setDir
: function setDir(name
, dir
) {
542 return this.toggle(name
, dir
);
544 // Toggle sort order on a field.
545 // To set a specific order, pass optional parameter 'next' ('+', '-', or '').
546 toggle
: function toggle(name
, next
) {
547 if (!next
&& next
!== '') {
549 if (this.remove(name
) || this.remove('+' + name
)) {
552 if (this.remove('-' + name
)) {
558 this.values
.unshift('+' + name
);
560 else if (next
== '-') {
561 this.values
.unshift('-' + name
);
565 return CrmUiOrderCtrl
;
568 // Define a controller which manages sort order. You may interact with the controller
569 // directly ("myOrder.toggle('fieldname')") order using the helper, crm-ui-order-by.
571 // <span crm-ui-order="{var: 'myOrder', defaults: {'-myField'}}"></span>
572 // <th><a crm-ui-order-by="[myOrder,'myField']">My Field</a></th>
573 // <tr ng-repeat="... | order:myOrder.get()">...</tr>
574 // <button ng-click="myOrder.toggle('myField')">
575 .directive('crmUiOrder', function(CrmUiOrderCtrl
) {
577 link: function(scope
, element
, attrs
){
578 var options
= angular
.extend({var: 'crmUiOrderBy'}, scope
.$eval(attrs
.crmUiOrder
));
579 scope
[options
.var] = new CrmUiOrderCtrl(options
.defaults
);
584 // For usage, see crmUiOrder (above)
585 .directive('crmUiOrderBy', function() {
587 link: function(scope
, element
, attrs
) {
588 function updateClass(crmUiOrderCtrl
, name
) {
589 var dir
= crmUiOrderCtrl
.getDir(name
);
591 .toggleClass('sorting_asc', dir
=== '+')
592 .toggleClass('sorting_desc', dir
=== '-')
593 .toggleClass('sorting', dir
=== '');
596 element
.on('click', function(e
){
597 var tgt
= scope
.$eval(attrs
.crmUiOrderBy
);
598 tgt
[0].toggle(tgt
[1]);
599 updateClass(tgt
[0], tgt
[1]);
604 var tgt
= scope
.$eval(attrs
.crmUiOrderBy
);
605 updateClass(tgt
[0], tgt
[1]);
610 // Display a fancy SELECT (based on select2).
611 // usage: <select crm-ui-select="{placeholder:'Something',allowClear:true,...}" ng-model="myobj.field"><option...></select>
612 .directive('crmUiSelect', function ($parse
, $timeout
) {
618 link: function (scope
, element
, attrs
, ngModel
) {
619 // In cases where UI initiates update, there may be an extra
620 // call to refreshUI, but it doesn't create a cycle.
623 ngModel
.$render = function () {
624 $timeout(function () {
625 // ex: msg_template_id adds new item then selects it; use $timeout to ensure that
626 // new item is added before selection is made
627 element
.select2('val', ngModel
.$viewValue
);
631 function refreshModel() {
632 var oldValue
= ngModel
.$viewValue
, newValue
= element
.select2('val');
633 if (oldValue
!= newValue
) {
634 scope
.$parent
.$apply(function () {
635 ngModel
.$setViewValue(newValue
);
641 // TODO watch select2-options
642 element
.select2(scope
.crmUiSelect
|| {});
644 element
.on('change', refreshModel
);
645 $timeout(ngModel
.$render
);
654 // Render a crmEntityRef widget
655 // usage: <input crm-entityref="{entity: 'Contact', select: {allowClear:true}}" ng-model="myobj.field" />
656 .directive('crmEntityref', function ($parse
, $timeout
) {
662 link: function (scope
, element
, attrs
, ngModel
) {
663 // In cases where UI initiates update, there may be an extra
664 // call to refreshUI, but it doesn't create a cycle.
666 ngModel
.$render = function () {
667 $timeout(function () {
668 // ex: msg_template_id adds new item then selects it; use $timeout to ensure that
669 // new item is added before selection is made
670 element
.select2('val', ngModel
.$viewValue
);
673 function refreshModel() {
674 var oldValue
= ngModel
.$viewValue
, newValue
= element
.select2('val');
675 if (oldValue
!= newValue
) {
676 scope
.$parent
.$apply(function () {
677 ngModel
.$setViewValue(newValue
);
683 // TODO can we infer "entity" from model?
684 element
.crmEntityRef(scope
.crmEntityref
|| {});
685 element
.on('change', refreshModel
);
686 $timeout(ngModel
.$render
);
694 // example <div crm-ui-tab crm-title="ts('My Title')">...content...</div>
695 // WISHLIST: use a full Angular component instead of an incomplete jQuery wrapper
696 .directive('crmUiTab', function($parse
) {
698 require
: '^crmUiTabSet',
704 template
: '<div ng-transclude></div>',
706 link: function (scope
, element
, attrs
, crmUiTabSetCtrl
) {
707 crmUiTabSetCtrl
.add(scope
);
712 // example: <div crm-ui-tab-set><div crm-ui-tab crm-title="Tab 1">...</div><div crm-ui-tab crm-title="Tab 2">...</div></div>
713 .directive('crmUiTabSet', function() {
719 templateUrl
: '~/crmUi/tabset.html',
721 controllerAs
: 'crmUiTabSetCtrl',
722 controller: function($scope
, $parse
) {
723 var tabs
= $scope
.tabs
= []; // array<$scope>
724 this.add = function(tab
) {
725 if (!tab
.id
) throw "Tab is missing 'id'";
729 link: function (scope
, element
, attrs
) {}
733 // Generic, field-independent form validator.
734 // example: <span ng-model="placeholder" crm-ui-validate="foo && bar || whiz" />
735 // example: <span ng-model="placeholder" crm-ui-validate="foo && bar || whiz" crm-ui-validate-name="myError" />
736 .directive('crmUiValidate', function() {
740 link: function(scope
, element
, attrs
, ngModel
) {
741 var validationKey
= attrs
.crmUiValidateName
? attrs
.crmUiValidateName
: 'crmUiValidate';
742 scope
.$watch(attrs
.crmUiValidate
, function(newValue
){
743 ngModel
.$setValidity(validationKey
, !!newValue
);
749 // like ng-show, but hides/displays elements using "visibility" which maintains positioning
750 // example <div crm-ui-visible="false">...content...</div>
751 .directive('crmUiVisible', function($parse
) {
757 link: function (scope
, element
, attrs
) {
758 var model
= $parse(attrs
.crmUiVisible
);
759 function updatecChildren() {
760 element
.css('visibility', model(scope
.$parent
) ? 'inherit' : 'hidden');
763 scope
.$parent
.$watch(attrs
.crmUiVisible
, updatecChildren
);
768 // example: <div crm-ui-wizard="myWizardCtrl"><div crm-ui-wizard-step crm-title="ts('Step 1')">...</div><div crm-ui-wizard-step crm-title="ts('Step 2')">...</div></div>
769 // Note: "myWizardCtrl" has various actions/properties like next() and $first().
770 // WISHLIST: Allow each step to determine if it is "complete" / "valid" / "selectable"
771 // WISHLIST: Allow each step to enable/disable (show/hide) itself
772 .directive('crmUiWizard', function() {
778 templateUrl
: '~/crmUi/wizard.html',
780 controllerAs
: 'crmUiWizardCtrl',
781 controller: function($scope
, $parse
) {
782 var steps
= $scope
.steps
= []; // array<$scope>
783 var crmUiWizardCtrl
= this;
785 var selectedIndex
= null;
787 var findIndex = function() {
789 angular
.forEach(steps
, function(step
, stepKey
) {
790 if (step
.selected
) found
= stepKey
;
795 /// @return int the index of the current step
796 this.$index = function() { return selectedIndex
; };
797 /// @return bool whether the currentstep is first
798 this.$first = function() { return this.$index() === 0; };
799 /// @return bool whether the current step is last
800 this.$last = function() { return this.$index() === steps
.length
-1; };
801 this.$maxVisit = function() { return maxVisited
; };
802 this.$validStep = function() {
803 return steps
[selectedIndex
] && steps
[selectedIndex
].isStepValid();
805 this.iconFor = function(index
) {
806 if (index
< this.$index()) return 'โ';
807 if (index
=== this.$index()) return 'ยป';
810 this.isSelectable = function(step
) {
811 if (step
.selected
) return false;
813 angular
.forEach(steps
, function(otherStep
, otherKey
) {
814 if (step
=== otherStep
&& otherKey
<= maxVisited
) result
= true;
819 /*** @param Object step the $scope of the step */
820 this.select = function(step
) {
821 angular
.forEach(steps
, function(otherStep
, otherKey
) {
822 otherStep
.selected
= (otherStep
=== step
);
823 if (otherStep
=== step
&& maxVisited
< otherKey
) maxVisited
= otherKey
;
825 selectedIndex
= findIndex();
827 /*** @param Object step the $scope of the step */
828 this.add = function(step
) {
829 if (steps
.length
=== 0) {
830 step
.selected
= true;
834 steps
.sort(function(a
,b
){
835 return a
.crmUiWizardStep
- b
.crmUiWizardStep
;
837 selectedIndex
= findIndex();
839 this.remove = function(step
) {
841 angular
.forEach(steps
, function(otherStep
, otherKey
) {
842 if (otherStep
=== step
) key
= otherKey
;
845 steps
.splice(key
, 1);
848 this.goto = function(index
) {
849 if (index
< 0) index
= 0;
850 if (index
>= steps
.length
) index
= steps
.length
-1;
851 this.select(steps
[index
]);
853 this.previous = function() { this.goto(this.$index()-1); };
854 this.next = function() { this.goto(this.$index()+1); };
855 if ($scope
.crmUiWizard
) {
856 $parse($scope
.crmUiWizard
).assign($scope
.$parent
, this);
859 link: function (scope
, element
, attrs
) {
860 scope
.ts
= CRM
.ts(null);
865 // Use this to add extra markup to wizard
866 .directive('crmUiWizardButtons', function() {
868 require
: '^crmUiWizard',
871 template
: '<span ng-transclude></span>',
873 link: function (scope
, element
, attrs
, crmUiWizardCtrl
) {
874 var realButtonsEl
= $(element
).closest('.crm-wizard').find('.crm-wizard-buttons');
875 $(element
).appendTo(realButtonsEl
);
880 // Example: <button crm-icon="check">Save</button>
881 .directive('crmIcon', function() {
885 link: function (scope
, element
, attrs
) {
886 $(element
).prepend('<span class="icon ui-icon-' + attrs
.crmIcon
+ '"></span> ');
887 if ($(element
).is('button')) {
888 $(element
).addClass('crm-button');
894 // example: <div crm-ui-wizard-step crm-title="ts('My Title')" ng-form="mySubForm">...content...</div>
895 // If there are any conditional steps, then be sure to set a weight explicitly on *all* steps to maintain ordering.
896 // example: <div crm-ui-wizard-step="100" crm-title="..." ng-if="...">...content...</div>
897 .directive('crmUiWizardStep', function() {
900 require
: ['^crmUiWizard', 'form'],
903 crmTitle
: '@', // expression, evaluates to a printable string
904 crmUiWizardStep
: '@' // int, a weight which determines the ordering of the steps
906 template
: '<div class="crm-wizard-step" ng-show="selected" ng-transclude/></div>',
908 link: function (scope
, element
, attrs
, ctrls
) {
909 var crmUiWizardCtrl
= ctrls
[0], form
= ctrls
[1];
910 if (scope
.crmUiWizardStep
) {
911 scope
.crmUiWizardStep
= parseInt(scope
.crmUiWizardStep
);
913 scope
.crmUiWizardStep
= nextWeight
++;
915 scope
.isStepValid = function() {
918 crmUiWizardCtrl
.add(scope
);
919 element
.on('$destroy', function(){
920 crmUiWizardCtrl
.remove(scope
);
926 // Example: <button crm-confirm="{message: ts('Are you sure you want to continue?')}" on-yes="frobnicate(123)">Frobincate</button>
927 // Example: <button crm-confirm="{type: 'disable', obj: myObject}" on-yes="myObject.is_active=0; myObject.save()">Disable</button>
928 // Example: <button crm-confirm="{templateUrl: '~/path/to/view.html', export: {foo: bar}}" on-yes="frobnicate(123)">Frobincate</button>
929 .directive('crmConfirm', function ($compile
, $rootScope
, $templateRequest
, $q
) {
930 // Helpers to calculate default options for CRM.confirm()
932 'disable': function (options
) {
934 message
: ts('Are you sure you want to disable this?'),
935 options
: {no
: ts('Cancel'), yes
: ts('Disable')},
937 title
: ts('Disable %1?', {
938 1: options
.obj
.title
|| options
.obj
.label
|| options
.obj
.name
|| ts('the record')
942 'revert': function (options
) {
944 message
: ts('Are you sure you want to revert this?'),
945 options
: {no
: ts('Cancel'), yes
: ts('Revert')},
947 title
: ts('Revert %1?', {
948 1: options
.obj
.title
|| options
.obj
.label
|| options
.obj
.name
|| ts('the record')
952 'delete': function (options
) {
954 message
: ts('Are you sure you want to delete this?'),
955 options
: {no
: ts('Cancel'), yes
: ts('Delete')},
957 title
: ts('Delete %1?', {
958 1: options
.obj
.title
|| options
.obj
.label
|| options
.obj
.name
|| ts('the record')
963 var confirmCount
= 0;
965 link: function (scope
, element
, attrs
) {
966 $(element
).click(function () {
967 var options
= scope
.$eval(attrs
.crmConfirm
);
968 if (attrs
.title
&& !options
.title
) {
969 options
.title
= attrs
.title
;
971 var defaults
= (options
.type
) ? defaultFuncs
[options
.type
](options
) : {};
973 var tpl
= null, stubId
= null;
974 if (!options
.message
) {
975 if (options
.templateUrl
) {
976 tpl
= $templateRequest(options
.templateUrl
);
978 else if (options
.template
) {
979 tpl
= options
.template
;
982 stubId
= 'crmUiConfirm_' + (++confirmCount
);
983 options
.message
= '<div id="' + stubId
+ '"></div>';
987 CRM
.confirm(_
.extend(defaults
, options
))
988 .on('crmConfirm:yes', function() { scope
.$apply(attrs
.onYes
); })
989 .on('crmConfirm:no', function() { scope
.$apply(attrs
.onNo
); });
992 $q
.when(tpl
, function(html
) {
993 var scope
= options
.scope
|| $rootScope
.$new();
994 if (options
.export) {
995 angular
.extend(scope
, options
.export);
997 var linker
= $compile(html
);
998 $('#' + stubId
).append($(linker(scope
)));
1005 .run(function($rootScope
, $location
) {
1006 /// Example: <button ng-click="goto('home')">Go home!</button>
1007 $rootScope
.goto = function(path
) {
1008 $location
.path(path
);
1010 // useful for debugging: $rootScope.log = console.log || function() {};
1014 })(angular
, CRM
.$, CRM
._
);