1 /// crmUi: Sundry UI helpers
2 (function (angular
, $, _
) {
6 documentTitle
= 'CiviCRM';
8 angular
.module('crmUi', [])
10 // example <div crm-ui-accordion crm-title="ts('My Title')" crm-collapsed="true">...content...</div>
11 // WISHLIST: crmCollapsed should support two-way/continuous binding
12 .directive('crmUiAccordion', function() {
17 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>',
19 link: function (scope
, element
, attrs
) {
21 'crm-accordion-wrapper': true,
22 collapsed
: scope
.crmUiAccordion
.collapsed
25 scope
.$watch('crmUiAccordion', function(crmUiAccordion
) {
26 if (crmUiAccordion
&& crmUiAccordion
.help
) {
27 scope
.help
= crmUiAccordion
.help
.clone({}, {
28 title
: crmUiAccordion
.title
37 // crmUiAlert({text: 'My text', title: 'My title', type: 'error'});
38 // crmUiAlert({template: '<a ng-click="ok()">Hello</a>', scope: $scope.$new()});
39 // var h = crmUiAlert({templateUrl: '~/crmFoo/alert.html', scope: $scope.$new()});
41 .service('crmUiAlert', function($compile
, $rootScope
, $templateRequest
, $q
) {
43 return function crmUiAlert(params
) {
44 var id
= 'crmUiAlert_' + (++count
);
46 if (params
.templateUrl
) {
47 tpl
= $templateRequest(params
.templateUrl
);
49 else if (params
.template
) {
50 tpl
= params
.template
;
53 params
.text
= '<div id="' + id
+ '"></div>'; // temporary stub
55 var result
= CRM
.alert(params
.text
, params
.title
, params
.type
, params
.options
);
57 $q
.when(tpl
, function(html
) {
58 var scope
= params
.scope
|| $rootScope
.$new();
59 var linker
= $compile(html
);
60 $('#' + id
).append($(linker(scope
)));
67 // Simple wrapper around $.crmDatepicker.
68 // example with no time input: <input crm-ui-datepicker="{time: false}" ng-model="myobj.datefield"/>
69 // example with custom date format: <input crm-ui-datepicker="{date: 'm/d/y'}" ng-model="myobj.datefield"/>
70 .directive('crmUiDatepicker', function () {
77 link: function (scope
, element
, attrs
, ngModel
) {
78 ngModel
.$render = function () {
79 element
.val(ngModel
.$viewValue
).change();
83 .crmDatepicker(scope
.crmUiDatepicker
)
84 .on('change', function() {
85 var requiredLength
= 19;
86 if (scope
.crmUiDatepicker
&& scope
.crmUiDatepicker
.time
=== false) {
89 if (scope
.crmUiDatepicker
&& scope
.crmUiDatepicker
.date
=== false) {
92 ngModel
.$setValidity('incompleteDateTime', !($(this).val().length
&& $(this).val().length
!== requiredLength
));
98 // Display debug information (if available)
99 // For richer DX, checkout Batarang/ng-inspector (Chrome/Safari), or AngScope/ng-inspect (Firefox).
100 // example: <div crm-ui-debug="myobject" />
101 .directive('crmUiDebug', function ($location
) {
107 template: function() {
108 var args
= $location
.search();
109 return (args
&& args
.angularDebug
) ? '<div crm-ui-accordion=\'{title: ts("Debug (%1)", {1: crmUiDebug}), collapsed: true}\'><pre>{{data|json}}</pre></div>' : '';
111 link: function(scope
, element
, attrs
) {
112 var args
= $location
.search();
113 if (args
&& args
.angularDebug
) {
114 scope
.ts
= CRM
.ts(null);
115 scope
.$parent
.$watch(attrs
.crmUiDebug
, function(data
) {
123 // Display a field/row in a field list
124 // example: <div crm-ui-field="{title: ts('My Field')}"> {{mydata}} </div>
125 // example: <div crm-ui-field="{name: 'subform.myfield', title: ts('My Field')}"> <input crm-ui-id="subform.myfield" name="myfield" /> </div>
126 // example: <div crm-ui-field="{name: 'subform.myfield', title: ts('My Field')}"> <input crm-ui-id="subform.myfield" name="myfield" required /> </div>
127 // example: <div crm-ui-field="{name: 'subform.myfield', title: ts('My Field'), help: hs('help_field_name')}"> {{mydata}} </div>
128 .directive('crmUiField', function() {
129 // Note: When writing new templates, the "label" position is particular. See/patch "var label" below.
131 default: '~/crmUi/field.html',
132 checkbox
: '~/crmUi/field-cb.html'
136 require
: '^crmUiIdScope',
139 // {title, name, help, helpFile}
142 templateUrl: function(tElement
, tAttrs
){
143 var layout
= tAttrs
.crmLayout
? tAttrs
.crmLayout
: 'default';
144 return templateUrls
[layout
];
147 link: function (scope
, element
, attrs
, crmUiIdCtrl
) {
148 $(element
).addClass('crm-section');
150 scope
.$watch('crmUiField', function(crmUiField
) {
151 if (crmUiField
&& crmUiField
.help
) {
152 scope
.help
= crmUiField
.help
.clone({}, {
153 title
: crmUiField
.title
161 // 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>
162 .directive('crmUiId', function () {
164 require
: '^crmUiIdScope',
167 pre: function (scope
, element
, attrs
, crmUiIdCtrl
) {
168 var id
= crmUiIdCtrl
.get(attrs
.crmUiId
);
169 element
.attr('id', id
);
175 // for example, see crmUiHelp
176 .service('crmUiHelp', function(){
177 // example: var h = new FieldHelp({id: 'foo'}); h.open();
178 function FieldHelp(options
) {
179 this.options
= options
;
181 angular
.extend(FieldHelp
.prototype, {
183 return this.options
[n
];
185 open
: function open() {
186 CRM
.help(this.options
.title
, {id
: this.options
.id
, file
: this.options
.file
});
188 clone
: function clone(options
, defaults
) {
189 return new FieldHelp(angular
.extend({}, defaults
, this.options
, options
));
193 // example: var hs = crmUiHelp({file: 'CRM/Foo/Bar'});
194 return function(defaults
){
195 // example: hs('myfield')
196 // example: hs({id: 'myfield', title: 'Foo Bar', file: 'Whiz/Bang'})
197 return function(options
) {
198 if (_
.isString(options
)) {
199 options
= {id
: options
};
201 return new FieldHelp(angular
.extend({}, defaults
, options
));
206 // Display a help icon
207 // Example: Use a default *.hlp file
208 // scope.hs = crmUiHelp({file: 'Path/To/Help/File'});
209 // HTML: <a crm-ui-help="hs({title:ts('My Field'), id:'my_field'})">
210 // Example: Use an explicit *.hlp file
211 // HTML: <a crm-ui-help="hs({title:ts('My Field'), id:'my_field', file:'CRM/Foo/Bar'})">
212 .directive('crmUiHelp', function() {
215 link: function(scope
, element
, attrs
) {
216 setTimeout(function() {
217 var crmUiHelp
= scope
.$eval(attrs
.crmUiHelp
);
218 var title
= crmUiHelp
&& crmUiHelp
.get('title') ? ts('%1 Help', {1: crmUiHelp
.get('title')}) : ts('Help');
219 element
.attr('title', title
);
223 .addClass('helpicon')
225 .on('click', function(e
) {
227 scope
.$eval(attrs
.crmUiHelp
).open();
233 // 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>
234 .directive('crmUiFor', function ($parse
, $timeout
) {
236 require
: '^crmUiIdScope',
238 template
: '<span ng-class="cssClasses"><span ng-transclude/><span crm-ui-visible="crmIsRequired" class="crm-marker" title="This field is required.">*</span></span>',
240 link: function (scope
, element
, attrs
, crmUiIdCtrl
) {
241 scope
.crmIsRequired
= false;
242 scope
.cssClasses
= {};
244 if (!attrs
.crmUiFor
) return;
246 var id
= crmUiIdCtrl
.get(attrs
.crmUiFor
);
247 element
.attr('for', id
);
250 var updateCss = function () {
251 scope
.cssClasses
['crm-error'] = !ngModel
.$valid
&& !ngModel
.$pristine
;
254 // Note: if target element is dynamically generated (eg via ngInclude), then it may not be available
255 // immediately for initialization. Use retries/retryDelay to initialize such elements.
256 var init = function (retries
, retryDelay
) {
257 var input
= $('#' + id
);
258 if (input
.length
=== 0) {
261 init(retries
-1, retryDelay
);
267 var tgtScope
= scope
;//.$parent;
268 if (attrs
.crmDepth
) {
269 for (var i
= attrs
.crmDepth
; i
> 0; i
--) {
270 tgtScope
= tgtScope
.$parent
;
274 if (input
.attr('ng-required')) {
275 scope
.crmIsRequired
= scope
.$parent
.$eval(input
.attr('ng-required'));
276 scope
.$parent
.$watch(input
.attr('ng-required'), function (isRequired
) {
277 scope
.crmIsRequired
= isRequired
;
281 scope
.crmIsRequired
= input
.prop('required');
284 ngModel
= $parse(attrs
.crmUiFor
)(tgtScope
);
286 ngModel
.$viewChangeListeners
.push(updateCss
);
297 // Define a scope in which a name like "subform.foo" maps to a unique ID.
298 // 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>
299 .directive('crmUiIdScope', function () {
303 controllerAs
: 'crmUiIdCtrl',
304 controller: function($scope
) {
306 this.get = function(name
) {
308 ids
[name
] = "crmUiId_" + (++uidCount
);
313 link: function (scope
, element
, attrs
) {}
317 // Display an HTML blurb inside an IFRAME.
318 // example: <iframe crm-ui-iframe="getHtmlContent()"></iframe>
319 // example: <iframe crm-ui-iframe crm-ui-iframe-src="getUrl()"></iframe>
320 .directive('crmUiIframe', function ($parse
) {
323 crmUiIframeSrc
: '@', // expression which evaluates to a URL
324 crmUiIframe
: '@' // expression which evaluates to HTML content
326 link: function (scope
, elm
, attrs
) {
327 var iframe
= $(elm
)[0];
328 iframe
.setAttribute('width', '100%');
329 iframe
.setAttribute('frameborder', '0');
331 var refresh = function () {
332 if (attrs
.crmUiIframeSrc
) {
333 iframe
.setAttribute('src', scope
.$parent
.$eval(attrs
.crmUiIframeSrc
));
336 var iframeHtml
= scope
.$parent
.$eval(attrs
.crmUiIframe
);
338 var doc
= iframe
.document
;
339 if (iframe
.contentDocument
) {
340 doc
= iframe
.contentDocument
;
342 else if (iframe
.contentWindow
) {
343 doc
= iframe
.contentWindow
.document
;
347 doc
.writeln(iframeHtml
);
352 // If the iframe is in a dialog, respond to resize events
353 $(elm
).parent().on('dialogresize dialogopen', function(e
, ui
) {
354 $(this).css({padding
: '0', margin
: '0', overflow
: 'hidden'});
355 iframe
.setAttribute('height', '' + $(this).innerHeight() + 'px');
358 scope
.$parent
.$watch(attrs
.crmUiIframe
, refresh
);
364 // <a ng-click="$broadcast('my-insert-target', 'some new text')>Insert</a>
365 // <textarea crm-ui-insert-rx='my-insert-target'></textarea>
366 .directive('crmUiInsertRx', function() {
368 link: function(scope
, element
, attrs
) {
369 scope
.$on(attrs
.crmUiInsertRx
, function(e
, tokenName
) {
370 CRM
.wysiwyg
.insert(element
, tokenName
);
371 $(element
).select2('close').select2('val', '');
372 CRM
.wysiwyg
.focus(element
);
378 // Define a rich text editor.
379 // example: <textarea crm-ui-id="myForm.body_html" crm-ui-richtext name="body_html" ng-model="mailing.body_html"></textarea>
380 .directive('crmUiRichtext', function ($timeout
) {
383 link: function (scope
, elm
, attr
, ngModel
) {
385 var editor
= CRM
.wysiwyg
.create(elm
);
391 $(elm
).on('blur', function() {
392 $timeout(function() {
393 scope
.$eval(attr
.ngBlur
);
398 ngModel
.$render = function(value
) {
399 editor
.done(function() {
400 CRM
.wysiwyg
.setVal(elm
, ngModel
.$viewValue
|| '');
407 // Display a lock icon (based on a boolean).
408 // example: <a crm-ui-lock binding="mymodel.boolfield"></a>
409 // example: <a crm-ui-lock
410 // binding="mymodel.boolfield"
411 // title-locked="ts('Boolfield is locked')"
412 // title-unlocked="ts('Boolfield is unlocked')"></a>
413 .directive('crmUiLock', function ($parse
, $rootScope
) {
414 var defaultVal = function (defaultValue
) {
415 var f = function (scope
) {
418 f
.assign = function (scope
, value
) {
424 // like $parse, but accepts a defaultValue in case expr is undefined
425 var parse = function (expr
, defaultValue
) {
426 return expr
? $parse(expr
) : defaultVal(defaultValue
);
431 link: function (scope
, element
, attrs
) {
432 var binding
= parse(attrs
.binding
, true);
433 var titleLocked
= parse(attrs
.titleLocked
, ts('Locked'));
434 var titleUnlocked
= parse(attrs
.titleUnlocked
, ts('Unlocked'));
436 $(element
).addClass('crm-i lock-button');
437 var refresh = function () {
438 var locked
= binding(scope
);
441 .removeClass('fa-unlock')
443 .prop('title', titleLocked(scope
))
448 .removeClass('fa-lock')
449 .addClass('fa-unlock')
450 .prop('title', titleUnlocked(scope
))
455 $(element
).click(function () {
456 binding
.assign(scope
, !binding(scope
));
458 $rootScope
.$digest();
461 scope
.$watch(attrs
.binding
, refresh
);
462 scope
.$watch(attrs
.titleLocked
, refresh
);
463 scope
.$watch(attrs
.titleUnlocked
, refresh
);
470 // CrmUiOrderCtrl is a controller class which manages sort orderings.
472 // JS: $scope.myOrder = new CrmUiOrderCtrl(['+field1', '-field2]);
473 // $scope.myOrder.toggle('field1');
474 // $scope.myOrder.setDir('field2', '');
475 // HTML: <tr ng-repeat="... | order:myOrder.get()">...</tr>
476 .service('CrmUiOrderCtrl', function(){
478 function CrmUiOrderCtrl(defaults
){
479 this.values
= defaults
;
481 angular
.extend(CrmUiOrderCtrl
.prototype, {
482 get: function get() {
485 getDir
: function getDir(name
) {
486 if (this.values
.indexOf(name
) >= 0 || this.values
.indexOf('+' + name
) >= 0) {
489 if (this.values
.indexOf('-' + name
) >= 0) {
494 // @return bool TRUE if something is removed
495 remove
: function remove(name
) {
496 var idx
= this.values
.indexOf(name
);
498 this.values
.splice(idx
, 1);
505 setDir
: function setDir(name
, dir
) {
506 return this.toggle(name
, dir
);
508 // Toggle sort order on a field.
509 // To set a specific order, pass optional parameter 'next' ('+', '-', or '').
510 toggle
: function toggle(name
, next
) {
511 if (!next
&& next
!== '') {
513 if (this.remove(name
) || this.remove('+' + name
)) {
516 if (this.remove('-' + name
)) {
522 this.values
.unshift('+' + name
);
524 else if (next
== '-') {
525 this.values
.unshift('-' + name
);
529 return CrmUiOrderCtrl
;
532 // Define a controller which manages sort order. You may interact with the controller
533 // directly ("myOrder.toggle('fieldname')") order using the helper, crm-ui-order-by.
535 // <span crm-ui-order="{var: 'myOrder', defaults: {'-myField'}}"></span>
536 // <th><a crm-ui-order-by="[myOrder,'myField']">My Field</a></th>
537 // <tr ng-repeat="... | order:myOrder.get()">...</tr>
538 // <button ng-click="myOrder.toggle('myField')">
539 .directive('crmUiOrder', function(CrmUiOrderCtrl
) {
541 link: function(scope
, element
, attrs
){
542 var options
= angular
.extend({var: 'crmUiOrderBy'}, scope
.$eval(attrs
.crmUiOrder
));
543 scope
[options
.var] = new CrmUiOrderCtrl(options
.defaults
);
548 // For usage, see crmUiOrder (above)
549 .directive('crmUiOrderBy', function() {
551 link: function(scope
, element
, attrs
) {
552 function updateClass(crmUiOrderCtrl
, name
) {
553 var dir
= crmUiOrderCtrl
.getDir(name
);
555 .toggleClass('sorting_asc', dir
=== '+')
556 .toggleClass('sorting_desc', dir
=== '-')
557 .toggleClass('sorting', dir
=== '');
560 element
.on('click', function(e
){
561 var tgt
= scope
.$eval(attrs
.crmUiOrderBy
);
562 tgt
[0].toggle(tgt
[1]);
563 updateClass(tgt
[0], tgt
[1]);
568 var tgt
= scope
.$eval(attrs
.crmUiOrderBy
);
569 updateClass(tgt
[0], tgt
[1]);
574 // Display a fancy SELECT (based on select2).
575 // usage: <select crm-ui-select="{placeholder:'Something',allowClear:true,...}" ng-model="myobj.field"><option...></select>
576 .directive('crmUiSelect', function ($parse
, $timeout
) {
582 link: function (scope
, element
, attrs
, ngModel
) {
583 // In cases where UI initiates update, there may be an extra
584 // call to refreshUI, but it doesn't create a cycle.
587 ngModel
.$render = function () {
588 $timeout(function () {
589 // ex: msg_template_id adds new item then selects it; use $timeout to ensure that
590 // new item is added before selection is made
591 element
.select2('val', ngModel
.$modelValue
);
595 function refreshModel() {
596 var oldValue
= ngModel
.$viewValue
, newValue
= element
.select2('val');
597 if (oldValue
!= newValue
) {
598 scope
.$parent
.$apply(function () {
599 ngModel
.$setViewValue(newValue
);
605 // TODO watch select2-options
606 element
.crmSelect2(scope
.crmUiSelect
|| {});
608 element
.on('change', refreshModel
);
609 $timeout(ngModel
.$render
);
618 // Render a crmEntityRef widget
619 // usage: <input crm-entityref="{entity: 'Contact', select: {allowClear:true}}" ng-model="myobj.field" />
620 .directive('crmEntityref', function ($parse
, $timeout
) {
626 link: function (scope
, element
, attrs
, ngModel
) {
627 // In cases where UI initiates update, there may be an extra
628 // call to refreshUI, but it doesn't create a cycle.
630 ngModel
.$render = function () {
631 $timeout(function () {
632 // ex: msg_template_id adds new item then selects it; use $timeout to ensure that
633 // new item is added before selection is made
634 element
.select2('val', ngModel
.$modelValue
);
637 function refreshModel() {
638 var oldValue
= ngModel
.$viewValue
, newValue
= element
.select2('val');
639 if (oldValue
!= newValue
) {
640 scope
.$parent
.$apply(function () {
641 ngModel
.$setViewValue(newValue
);
647 // TODO can we infer "entity" from model?
648 element
.crmEntityRef(scope
.crmEntityref
|| {});
649 element
.on('change', refreshModel
);
650 $timeout(ngModel
.$render
);
658 // example <div crm-ui-tab id="tab-1" crm-title="ts('My Title')" count="3">...content...</div>
659 // WISHLIST: use a full Angular component instead of an incomplete jQuery wrapper
660 .directive('crmUiTab', function($parse
) {
662 require
: '^crmUiTabSet',
670 template
: '<div ng-transclude></div>',
672 link: function (scope
, element
, attrs
, crmUiTabSetCtrl
) {
673 crmUiTabSetCtrl
.add(scope
);
678 // 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>
679 .directive('crmUiTabSet', function() {
685 templateUrl
: '~/crmUi/tabset.html',
687 controllerAs
: 'crmUiTabSetCtrl',
688 controller: function($scope
, $parse
) {
689 var tabs
= $scope
.tabs
= []; // array<$scope>
690 this.add = function(tab
) {
691 if (!tab
.id
) throw "Tab is missing 'id'";
695 link: function (scope
, element
, attrs
) {}
699 // Generic, field-independent form validator.
700 // example: <span ng-model="placeholder" crm-ui-validate="foo && bar || whiz" />
701 // example: <span ng-model="placeholder" crm-ui-validate="foo && bar || whiz" crm-ui-validate-name="myError" />
702 .directive('crmUiValidate', function() {
706 link: function(scope
, element
, attrs
, ngModel
) {
707 var validationKey
= attrs
.crmUiValidateName
? attrs
.crmUiValidateName
: 'crmUiValidate';
708 scope
.$watch(attrs
.crmUiValidate
, function(newValue
){
709 ngModel
.$setValidity(validationKey
, !!newValue
);
715 // like ng-show, but hides/displays elements using "visibility" which maintains positioning
716 // example <div crm-ui-visible="false">...content...</div>
717 .directive('crmUiVisible', function($parse
) {
723 link: function (scope
, element
, attrs
) {
724 var model
= $parse(attrs
.crmUiVisible
);
725 function updatecChildren() {
726 element
.css('visibility', model(scope
.$parent
) ? 'inherit' : 'hidden');
729 scope
.$parent
.$watch(attrs
.crmUiVisible
, updatecChildren
);
734 // 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>
735 // Note: "myWizardCtrl" has various actions/properties like next() and $first().
736 // WISHLIST: Allow each step to determine if it is "complete" / "valid" / "selectable"
737 // WISHLIST: Allow each step to enable/disable (show/hide) itself
738 .directive('crmUiWizard', function() {
744 templateUrl
: '~/crmUi/wizard.html',
746 controllerAs
: 'crmUiWizardCtrl',
747 controller: function($scope
, $parse
) {
748 var steps
= $scope
.steps
= []; // array<$scope>
749 var crmUiWizardCtrl
= this;
751 var selectedIndex
= null;
753 var findIndex = function() {
755 angular
.forEach(steps
, function(step
, stepKey
) {
756 if (step
.selected
) found
= stepKey
;
761 /// @return int the index of the current step
762 this.$index = function() { return selectedIndex
; };
763 /// @return bool whether the currentstep is first
764 this.$first = function() { return this.$index() === 0; };
765 /// @return bool whether the current step is last
766 this.$last = function() { return this.$index() === steps
.length
-1; };
767 this.$maxVisit = function() { return maxVisited
; };
768 this.$validStep = function() {
769 return steps
[selectedIndex
] && steps
[selectedIndex
].isStepValid();
771 this.iconFor = function(index
) {
772 if (index
< this.$index()) return '√';
773 if (index
=== this.$index()) return '»';
776 this.isSelectable = function(step
) {
777 if (step
.selected
) return false;
779 angular
.forEach(steps
, function(otherStep
, otherKey
) {
780 if (step
=== otherStep
&& otherKey
<= maxVisited
) result
= true;
785 /*** @param Object step the $scope of the step */
786 this.select = function(step
) {
787 angular
.forEach(steps
, function(otherStep
, otherKey
) {
788 otherStep
.selected
= (otherStep
=== step
);
789 if (otherStep
=== step
&& maxVisited
< otherKey
) maxVisited
= otherKey
;
791 selectedIndex
= findIndex();
793 /*** @param Object step the $scope of the step */
794 this.add = function(step
) {
795 if (steps
.length
=== 0) {
796 step
.selected
= true;
800 steps
.sort(function(a
,b
){
801 return a
.crmUiWizardStep
- b
.crmUiWizardStep
;
803 selectedIndex
= findIndex();
805 this.remove = function(step
) {
807 angular
.forEach(steps
, function(otherStep
, otherKey
) {
808 if (otherStep
=== step
) key
= otherKey
;
811 steps
.splice(key
, 1);
814 this.goto = function(index
) {
815 if (index
< 0) index
= 0;
816 if (index
>= steps
.length
) index
= steps
.length
-1;
817 this.select(steps
[index
]);
819 this.previous = function() { this.goto(this.$index()-1); };
820 this.next = function() { this.goto(this.$index()+1); };
821 if ($scope
.crmUiWizard
) {
822 $parse($scope
.crmUiWizard
).assign($scope
.$parent
, this);
825 link: function (scope
, element
, attrs
) {
826 scope
.ts
= CRM
.ts(null);
831 // Use this to add extra markup to wizard
832 .directive('crmUiWizardButtons', function() {
834 require
: '^crmUiWizard',
837 template
: '<span ng-transclude></span>',
839 link: function (scope
, element
, attrs
, crmUiWizardCtrl
) {
840 var realButtonsEl
= $(element
).closest('.crm-wizard').find('.crm-wizard-buttons');
841 $(element
).appendTo(realButtonsEl
);
846 // Example for Font Awesome: <button crm-icon="fa-check">Save</button>
847 // Example for jQuery UI (deprecated): <button crm-icon="check">Save</button>
848 .directive('crmIcon', function() {
851 link: function (scope
, element
, attrs
) {
852 if (element
.is('[crm-ui-tab]')) {
853 // handled in crmUiTab ctrl
856 if (attrs
.crmIcon
.substring(0,3) == 'fa-') {
857 $(element
).prepend('<i class="crm-i ' + attrs
.crmIcon
+ '"></i> ');
860 $(element
).prepend('<span class="icon ui-icon-' + attrs
.crmIcon
+ '"></span> ');
862 if ($(element
).is('button')) {
863 $(element
).addClass('crm-button');
869 // example: <div crm-ui-wizard-step crm-title="ts('My Title')" ng-form="mySubForm">...content...</div>
870 // If there are any conditional steps, then be sure to set a weight explicitly on *all* steps to maintain ordering.
871 // example: <div crm-ui-wizard-step="100" crm-title="..." ng-if="...">...content...</div>
872 .directive('crmUiWizardStep', function() {
875 require
: ['^crmUiWizard', 'form'],
878 crmTitle
: '@', // expression, evaluates to a printable string
879 crmUiWizardStep
: '@' // int, a weight which determines the ordering of the steps
881 template
: '<div class="crm-wizard-step" ng-show="selected" ng-transclude/></div>',
883 link: function (scope
, element
, attrs
, ctrls
) {
884 var crmUiWizardCtrl
= ctrls
[0], form
= ctrls
[1];
885 if (scope
.crmUiWizardStep
) {
886 scope
.crmUiWizardStep
= parseInt(scope
.crmUiWizardStep
);
888 scope
.crmUiWizardStep
= nextWeight
++;
890 scope
.isStepValid = function() {
893 crmUiWizardCtrl
.add(scope
);
894 element
.on('$destroy', function(){
895 crmUiWizardCtrl
.remove(scope
);
901 // Example: <button crm-confirm="{message: ts('Are you sure you want to continue?')}" on-yes="frobnicate(123)">Frobincate</button>
902 // Example: <button crm-confirm="{type: 'disable', obj: myObject}" on-yes="myObject.is_active=0; myObject.save()">Disable</button>
903 // Example: <button crm-confirm="{templateUrl: '~/path/to/view.html', export: {foo: bar}}" on-yes="frobnicate(123)">Frobincate</button>
904 .directive('crmConfirm', function ($compile
, $rootScope
, $templateRequest
, $q
) {
905 // Helpers to calculate default options for CRM.confirm()
907 'disable': function (options
) {
909 message
: ts('Are you sure you want to disable this?'),
910 options
: {no
: ts('Cancel'), yes
: ts('Disable')},
912 title
: ts('Disable %1?', {
913 1: options
.obj
.title
|| options
.obj
.label
|| options
.obj
.name
|| ts('the record')
917 'revert': function (options
) {
919 message
: ts('Are you sure you want to revert this?'),
920 options
: {no
: ts('Cancel'), yes
: ts('Revert')},
922 title
: ts('Revert %1?', {
923 1: options
.obj
.title
|| options
.obj
.label
|| options
.obj
.name
|| ts('the record')
927 'delete': function (options
) {
929 message
: ts('Are you sure you want to delete this?'),
930 options
: {no
: ts('Cancel'), yes
: ts('Delete')},
932 title
: ts('Delete %1?', {
933 1: options
.obj
.title
|| options
.obj
.label
|| options
.obj
.name
|| ts('the record')
938 var confirmCount
= 0;
940 link: function (scope
, element
, attrs
) {
941 $(element
).click(function () {
942 var options
= scope
.$eval(attrs
.crmConfirm
);
943 if (attrs
.title
&& !options
.title
) {
944 options
.title
= attrs
.title
;
946 var defaults
= (options
.type
) ? defaultFuncs
[options
.type
](options
) : {};
948 var tpl
= null, stubId
= null;
949 if (!options
.message
) {
950 if (options
.templateUrl
) {
951 tpl
= $templateRequest(options
.templateUrl
);
953 else if (options
.template
) {
954 tpl
= options
.template
;
957 stubId
= 'crmUiConfirm_' + (++confirmCount
);
958 options
.message
= '<div id="' + stubId
+ '"></div>';
962 CRM
.confirm(_
.extend(defaults
, options
))
963 .on('crmConfirm:yes', function() { scope
.$apply(attrs
.onYes
); })
964 .on('crmConfirm:no', function() { scope
.$apply(attrs
.onNo
); });
967 $q
.when(tpl
, function(html
) {
968 var scope
= options
.scope
|| $rootScope
.$new();
969 if (options
.export) {
970 angular
.extend(scope
, options
.export);
972 var linker
= $compile(html
);
973 $('#' + stubId
).append($(linker(scope
)));
981 // Sets document title & page title; attempts to override CMS title markup for the latter
982 // WARNING: Use only once per route!
983 // Example (same title for both): <h1 crm-page-title>{{ts('Hello')}}</h1>
984 // Example (separate document title): <h1 crm-document-title="ts('Hello')" crm-page-title><i class="crm-i fa-flag"></i>{{ts('Hello')}}</h1>
985 .directive('crmPageTitle', function($timeout
) {
988 crmDocumentTitle
: '='
990 link: function(scope
, $el
, attrs
) {
992 $timeout(function() {
993 var newPageTitle
= _
.trim($el
.html()),
994 newDocumentTitle
= scope
.crmDocumentTitle
|| $el
.text();
995 document
.title
= $('title').text().replace(documentTitle
, newDocumentTitle
);
996 // If the CMS has already added title markup to the page, use it
997 $('h1').not('.crm-container h1').each(function() {
998 if (_
.trim($(this).html()) === pageTitle
) {
999 $(this).html(newPageTitle
);
1003 pageTitle
= newPageTitle
;
1004 documentTitle
= newDocumentTitle
;
1008 scope
.$watch(function() {return scope
.crmDocumentTitle
+ $el
.html();}, update
);
1013 .run(function($rootScope
, $location
) {
1014 /// Example: <button ng-click="goto('home')">Go home!</button>
1015 $rootScope
.goto = function(path
) {
1016 $location
.path(path
);
1018 // useful for debugging: $rootScope.log = console.log || function() {};
1022 })(angular
, CRM
.$, CRM
._
);