From 0794da3d70ab4ab5123256e8b4792bc08c0f096c Mon Sep 17 00:00:00 2001
From: Coleman Watts <coleman@civicrm.org>
Date: Sat, 5 Nov 2022 16:37:54 -0400
Subject: [PATCH] SearchKit - Add descriptions to search display types

---
 .../ang/crmSearchAdmin/crmSearchAdminDisplay.component.js   | 1 +
 ext/search_kit/ang/crmSearchAdmin/tabs.html                 | 4 ++--
 ext/search_kit/managed/SearchDisplayType.mgd.php            | 6 +++++-
 3 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/ext/search_kit/ang/crmSearchAdmin/crmSearchAdminDisplay.component.js b/ext/search_kit/ang/crmSearchAdmin/crmSearchAdminDisplay.component.js
index 44192f1cd5..c951df2079 100644
--- a/ext/search_kit/ang/crmSearchAdmin/crmSearchAdminDisplay.component.js
+++ b/ext/search_kit/ang/crmSearchAdmin/crmSearchAdminDisplay.component.js
@@ -16,6 +16,7 @@
       _.each(CRM.crmSearchAdmin.displayTypes, function(type) {
         html +=
           '<div ng-switch-when="' + type.id + '">\n' +
+          '  <div class="help-block"><i class="crm-i ' + type.icon + '"></i> ' + _.escape(type.description) + '</div>' +
           '  <search-admin-display-' + type.id + ' api-entity="$ctrl.savedSearch.api_entity" api-params="$ctrl.savedSearch.api_params" display="$ctrl.display"></search-admin-display-' + type.id + '>\n' +
           '  <hr>\n' +
           '  <button type="button" class="btn btn-{{ !$ctrl.stale ? \'success\' : $ctrl.preview ? \'warning\' : \'primary\' }}" ng-click="$ctrl.previewDisplay()" ng-disabled="!$ctrl.stale">\n' +
diff --git a/ext/search_kit/ang/crmSearchAdmin/tabs.html b/ext/search_kit/ang/crmSearchAdmin/tabs.html
index b738e7d99d..cb8827c6a4 100644
--- a/ext/search_kit/ang/crmSearchAdmin/tabs.html
+++ b/ext/search_kit/ang/crmSearchAdmin/tabs.html
@@ -33,7 +33,7 @@
     <i class="crm-i fa-plus"></i> {{:: ts('Add...') }} <span class="caret"></span>
   </button>
   <ul class="dropdown-menu">
-    <li ng-if="!$ctrl.savedSearch.groups.length">
+    <li ng-if="!$ctrl.savedSearch.groups.length" title="{{:: ts('Smart group of contacts based on search results') }}">
       <a href ng-click="$ctrl.addGroup()">
         <i class="crm-i fa-users"></i>
         {{:: ts('Smart Group') }}
@@ -41,7 +41,7 @@
     </li>
     <li class="dropdown-header">{{:: ts('Display') }}</li>
     <li ng-repeat="type in ::$ctrl.displayTypes">
-      <a href ng-click="$ctrl.addDisplay(type.id)">
+      <a href ng-click="$ctrl.addDisplay(type.id)" title="{{:: type.description }}">
         <i class="crm-i {{:: type.icon }}"></i>
         {{:: type.label }}
       </a>
diff --git a/ext/search_kit/managed/SearchDisplayType.mgd.php b/ext/search_kit/managed/SearchDisplayType.mgd.php
index 87bf76e64b..55e4e32504 100644
--- a/ext/search_kit/managed/SearchDisplayType.mgd.php
+++ b/ext/search_kit/managed/SearchDisplayType.mgd.php
@@ -12,7 +12,7 @@ return [
       'version' => 4,
       'values' => [
         'name' => 'search_display_type',
-        'title' => 'Search Display Type',
+        'title' => E::ts('Search Display Type'),
         'is_reserved' => TRUE,
         'is_active' => TRUE,
         'option_value_fields' => [
@@ -37,6 +37,7 @@ return [
         'value' => 'table',
         'name' => 'crm-search-display-table',
         'label' => E::ts('Table'),
+        'description' => E::ts('A table displays results in rows and columns, with an optional pager and selectable actions. The styling of rows and columns is highly configurable.'),
         'icon' => 'fa-table',
         'is_reserved' => TRUE,
         'is_active' => TRUE,
@@ -57,6 +58,7 @@ return [
         'value' => 'list',
         'name' => 'crm-search-display-list',
         'label' => E::ts('List'),
+        'description' => E::ts('Lists are highly flexible and display results on one or more lines. Each field can be styled differently or given a custom css class.'),
         'icon' => 'fa-list',
         'is_reserved' => TRUE,
         'is_active' => TRUE,
@@ -77,6 +79,7 @@ return [
         'value' => 'grid',
         'name' => 'crm-search-display-grid',
         'label' => E::ts('Grid'),
+        'description' => E::ts('Grid displays are useful for image gallery thumbnails and other content to show side-by side.'),
         'icon' => 'fa-th',
         'is_reserved' => TRUE,
         'is_active' => TRUE,
@@ -97,6 +100,7 @@ return [
         'value' => 'autocomplete',
         'name' => 'crm-search-display-autocomplete',
         'label' => E::ts('Autocomplete'),
+        'description' => E::ts('Autocompletes are form fields that give results from this search as the user types. Creating a display is optional and allows customization of how each result appears in the dropdown.'),
         'icon' => 'fa-keyboard-o',
         'is_reserved' => TRUE,
         'is_active' => TRUE,
-- 
2.25.1