From: Coleman Watts <coleman@civicrm.org>
Date: Sat, 14 Mar 2015 00:23:47 +0000 (-0400)
Subject: CRM-15706 - Add Angular help directive
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=a517b78a171597cfa1dc7c8064b59704df8935e6;p=civicrm-core.git

CRM-15706 - Add Angular help directive
---

diff --git a/js/angular-crm-ui.js b/js/angular-crm-ui.js
index 0876e149a3..70f7519fe1 100644
--- a/js/angular-crm-ui.js
+++ b/js/angular-crm-ui.js
@@ -126,7 +126,8 @@
         restrict: 'EA',
         scope: {
           crmUiField: '@',
-          crmTitle: '@'
+          crmTitle: '@',
+          crmHelp: '@'
         },
         templateUrl: function(tElement, tAttrs){
           var layout = tAttrs.crmLayout ? tAttrs.crmLayout : 'default';
@@ -137,6 +138,7 @@
           $(element).addClass('crm-section');
           scope.crmUiField = attrs.crmUiField;
           scope.crmTitle = attrs.crmTitle;
+          scope.crmHelp = attrs.crmHelp;
         }
       };
     })
@@ -155,6 +157,27 @@
       };
     })
 
+    // standalone: <a crm-ui-help="field_name">
+    // within crmUiField: <div crm-ui-field crm-title="My Field" crm-help="field_name">
+    .directive('crmUiHelp', function() {
+      return {
+        restrict: 'EA',
+        scope: {
+          crmUiHelp: '='
+        },
+        link: function (scope, element, attrs) {
+          element
+            .addClass('helpicon')
+            .attr('title', ts('%1 Help', {1: scope.crmUiHelp.title}))
+            .attr('href', '#')
+            .on('click', function(e) {
+              e.preventDefault();
+              CRM.help(scope.crmUiHelp.title, {id: scope.crmUiHelp.id, file: scope.$parent.$parent.$parent.helpFile});
+            });
+        }
+      };
+    })
+
     // 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>
     .directive('crmUiFor', function ($parse, $timeout) {
       return {
diff --git a/js/angular-crmMailing/directives.js b/js/angular-crmMailing/directives.js
index 307df6369e..7db48d4c0e 100644
--- a/js/angular-crmMailing/directives.js
+++ b/js/angular-crmMailing/directives.js
@@ -28,6 +28,7 @@
           });
           scope.crmMailingConst = CRM.crmMailing;
           scope.ts = CRM.ts(null);
+          scope.helpFile = 'CRM/Mailing/Form/Upload';
           scope[directiveName] = attr[directiveName] ? scope.$parent.$eval(attr[directiveName]) : {};
           $q.when(crmMetadata.getFields('Mailing'), function(fields) {
             scope.mailingFields = fields;
diff --git a/partials/crmMailing/mailing.html b/partials/crmMailing/mailing.html
index 3ade3ee9f4..815bdf7b9c 100644
--- a/partials/crmMailing/mailing.html
+++ b/partials/crmMailing/mailing.html
@@ -21,7 +21,7 @@ It could perhaps be thinned by 30-60% by making more directives.
         <a crm-icon="disk" ng-click="saveTemplate(mailing)" class="crm-hover-button" title="{{ts('Save As')}}"></a>
       </div>
     </div>
-    <div crm-ui-field="subform.fromAddress" crm-title="ts('From')">
+    <div crm-ui-field="subform.fromAddress" crm-title="ts('From')" crm-help="id-from_email">
       <div ng-controller="EmailAddrCtrl" crm-mailing-from-address="fromPlaceholder" crm-mailing="mailing">
         <select
           crm-ui-id="subform.fromAddress"
diff --git a/partials/crmUi/field.html b/partials/crmUi/field.html
index e29c931b87..8aaa50a824 100644
--- a/partials/crmUi/field.html
+++ b/partials/crmUi/field.html
@@ -1,3 +1,6 @@
-<div class="label"><label crm-ui-for="{{crmUiField}}" crm-depth="1">{{$parent.$parent.$eval(crmTitle)}}</label></div>
+<div class="label">
+  <label crm-ui-for="{{crmUiField}}" crm-depth="1">{{$parent.$parent.$eval(crmTitle)}}</label>
+  <a crm-ui-help="{title: $parent.$parent.$eval(crmTitle), id: crmHelp}" ng-if="crmHelp"></a>
+</div>
 <div class="content" ng-transclude></div>
 <div class="clear"></div>