feat: option to display tags in DiscussionsSearchSource

Author: imorland

extensions/tags/extend.php

@@ -100,6 +100,8 @@
         ->prepareDataForSerialization(LoadForumTagsRelationship::class),
 
     (new Extend\Settings())
+        ->default('flarum-tags.show_tags_in_discussion_search_results', false)
+        ->serializeToForum('showTagsInDiscussionSearchResults', 'flarum-tags.show_tags_in_discussion_search_results', 'boolVal')
         ->serializeToForum('minPrimaryTags', 'flarum-tags.min_primary_tags')
         ->serializeToForum('maxPrimaryTags', 'flarum-tags.max_primary_tags')
         ->serializeToForum('minSecondaryTags', 'flarum-tags.min_secondary_tags')

extensions/tags/js/src/admin/components/TagsPage.js

@@ -118,6 +118,14 @@ export default class TagsPage extends ExtensionPage {
                     <input className="FormControl" type="number" min={minSecondaryTags()} bidi={maxSecondaryTags} />
                   </div>
                 </div>
+                <div className="Form-group">
+                  {this.buildSettingComponent({
+                    setting: 'flarum-tags.show_tags_in_discussion_search_results',
+                    type: 'boolean',
+                    label: app.translator.trans('flarum-tags.admin.tag_settings.show_tags_in_discussion_search_results.label'),
+                    help: app.translator.trans('flarum-tags.admin.tag_settings.show_tags_in_discussion_search_results.help'),
+                  })}
+                </div>
                 <div className="Form-group">{this.submitButton()}</div>
               </div>
             </div>

extensions/tags/js/src/forum/addTagsToDiscussionSearch.tsx

@@ -0,0 +1,16 @@
+import app from 'flarum/forum/app';
+import { extend } from 'flarum/common/extend';
+import DiscussionsSearchItem from 'flarum/forum/components/DiscussionsSearchItem';
+import DiscussionsSearchSource from 'flarum/forum/components/DiscussionsSearchSource';
+import tagsLabel from '../common/helpers/tagsLabel';
+
+export default function addTagsToDiscussionSearch() {
+  extend(DiscussionsSearchSource.prototype, 'includes', function (includes) {
+    app.forum.attribute<boolean>('showTagsInDiscussionSearchResults') && includes.push('tags');
+  });
+
+  extend(DiscussionsSearchItem.prototype, 'viewItems', function (items) {
+    app.forum.attribute<boolean>('showTagsInDiscussionSearchResults') &&
+      items.add('tags', <div className="DiscussionSearchResult-tags">{tagsLabel(this.discussion.tags())}</div>, 100);
+  });
+}

extensions/tags/js/src/forum/index.ts

@@ -18,10 +18,12 @@ app.initializers.add('flarum-tags', function () {
   addTagLabels();
   addTagControl();
   addTagComposer();
+  addTagsToDiscussionSearch();
 });
 
 // Expose compat API
 import tagsCompat from './compat';
 import { compat } from '@flarum/core/forum';
+import addTagsToDiscussionSearch from './addTagsToDiscussionSearch';
 
 Object.assign(compat, tagsCompat);

extensions/tags/locale/en.yml

@@ -49,6 +49,9 @@ flarum-tags:
       required_primary_text: Enter the minimum and maximum number of primary tags that may be applied to a discussion.
       required_secondary_heading: Required Number of Secondary Tags
       required_secondary_text: Enter the minimum and maximum number of secondary tags that may be applied to a discussion.
+      show_tags_in_discussion_search_results:
+        label: Show Tags in Discussion Search Results
+        help: "When enabled, tags will be displayed in the search results for discussions."
       title: Tag Settings
 
     # These translations are used in the Tags page.