nodebb-plugin-topic-search-button 1.1.0

package/library.js

@@ -0,0 +1,52 @@
+'use strict';
+
+const routeHelpers = nodebb.require('./src/routes/helpers');
+const settings = nodebb.require('./src/meta/settings');
+
+const plugin = {};
+
+plugin.id = 'topic-search-button';
+plugin.defaults = {
+	enabled: false,
+};
+plugin.enabled = false;
+
+function normalizeEnabled(stored) {
+	if (typeof stored === 'boolean') {
+		return stored;
+	}
+	return stored === 'true' || stored === 'on' || stored === '1';
+}
+
+plugin.init = async function (params) {
+	const { router } = params;
+	routeHelpers.setupAdminPageRoute(router, '/admin/plugins/topic-search-button', [], async (req, res) => {
+		res.render('admin/plugins/topic-search-button', {});
+	});
+	await settings.setOnEmpty(plugin.id, plugin.defaults);
+	const stored = await settings.getOne(plugin.id, 'enabled');
+	plugin.enabled = normalizeEnabled(stored);
+};
+
+plugin.exposeConfig = async function (config) {
+	config.topicSearchButtonEnabled = plugin.enabled;
+	return config;
+};
+
+plugin.onSettingsSave = async function (data) {
+	if (data && data.plugin === plugin.id && data.settings) {
+		plugin.enabled = normalizeEnabled(data.settings.enabled);
+	}
+	return data;
+};
+
+plugin.addAdminNavigation = async function (header) {
+	header.plugins.push({
+		route: '/plugins/topic-search-button',
+		icon: 'fa-search',
+		name: 'Topic Search Button',
+	});
+	return header;
+};
+
+module.exports = plugin;

package/package.json

@@ -0,0 +1,22 @@
+{
+	"name": "nodebb-plugin-topic-search-button",
+	"version": "1.1.0",
+	"description": "Adds a 'Search in topic' button to the topic toolbar that pre-fills the search box with the in:topic-<tid> prefix.",
+	"main": "library.js",
+	"license": "MIT",
+	"scripts": {},
+	"keywords": [
+		"nodebb",
+		"plugin",
+		"search",
+		"topic"
+	],
+	"author": {
+        "name": "JasonCH",
+        "email": "jasonwch@msn.com"
+    },
+	"nbbpm": {
+		"compatibility": "^4.14.0"
+	},
+	"dependencies": {}
+}

package/plugin.json

@@ -0,0 +1,25 @@
+{
+	"id": "nodebb-plugin-topic-search-button",
+	"name": "Topic Search Button",
+	"description": "Adds a 'Search in topic' button to the topic toolbar that pre-fills the search box with the in:topic-<tid> prefix.",
+	"library": "library.js",
+	"hooks": [
+		{ "hook": "static:app.load", "method": "init" },
+		{ "hook": "filter:admin.header.build", "method": "addAdminNavigation" },
+		{ "hook": "filter:config.get", "method": "exposeConfig" },
+		{ "hook": "filter:settings.set", "method": "onSettingsSave" }
+	],
+	"staticDirs": {
+		"static": "./static"
+	},
+	"templates": "./static/templates",
+	"modules": {
+		"../admin/plugins/topic-search-button.js": "./static/lib/admin.js"
+	},
+	"scripts": [
+		"static/lib/client.js"
+	],
+	"languages": "static/languages",
+	"defaultLang": "en-GB",
+	"settingsRoute": "/admin/plugins/topic-search-button"
+}

package/static/languages/en-GB/topic-search-button.json

@@ -0,0 +1,6 @@
+{
+	"search-in-topic": "Search in topic",
+	"admin.title": "Topic Search Button",
+	"admin.enable": "Show \"Search in topic\" button",
+	"admin.enable-help": "Adds a button to the topic toolbar that opens the search dropdown pre-filled with the in:topic prefix, scoped to the current topic. Visible to any visitor with the search content privilege."
+}

package/static/lib/admin.js

@@ -0,0 +1,32 @@
+'use strict';
+
+/*
+	This file is located in the "modules" block of plugin.json.
+	It is only loaded when the user navigates to /admin/plugins/topic-search-button.
+*/
+define('admin/plugins/topic-search-button', [
+	'settings',
+	'alerts',
+], (settings, alerts) => {
+	const ACP = {};
+
+	ACP.init = function () {
+		settings.load('topic-search-button', $('.topic-search-button-settings'), () => {
+		});
+		$('#save').on('click', saveSettings);
+	};
+
+	function saveSettings() {
+		settings.save('topic-search-button', $('.topic-search-button-settings'), () => {
+			alerts.alert({
+				type: 'success',
+				alert_id: 'topic-search-button-saved',
+				title: 'Settings Saved',
+				message: 'Your settings have been saved successfully.',
+				timeout: 5000,
+			});
+		});
+	}
+
+	return ACP;
+});

package/static/lib/client.js

@@ -0,0 +1,114 @@
+'use strict';
+
+(function () {
+	require(['hooks'], function (hooks) {
+		var previousTid = null;
+
+		hooks.on('action:topic.loaded', function () {
+			if (!config.topicSearchButtonEnabled || !config.searchEnabled || !app.user.privileges['search:content']) {
+				return;
+			}
+			injectButton();
+		});
+
+		hooks.on('action:ajaxify.end', function () {
+			var currentTid = ajaxify.data && ajaxify.data.template && ajaxify.data.template.topic ?
+				String(ajaxify.data.tid) : null;
+
+			if (previousTid && previousTid !== currentTid) {
+				cleanSearchInputs();
+			}
+			previousTid = currentTid;
+		});
+
+		function cleanSearchInputs() {
+			$('[component="search/fields"] input[name="query"]').each(function () {
+				var $input = $(this);
+				var val = $input.val();
+				if (val && val.indexOf('in:topic-') === 0) {
+					$input.val('');
+				}
+			});
+			$('[component="search/fields"] .quick-search-container').addClass('hidden');
+		}
+	});
+
+	function injectButton() {
+		require(['translator', 'utils'], function (translator, utils) {
+			translator.translate('[[topic-search-button:search-in-topic]]', function (label) {
+				var escapedLabel = utils.escapeHTML(label);
+				var buttonHtml =
+					'<button component="topic/search-in-topic" title="' + escapedLabel + '" ' +
+					'class="btn btn-ghost btn-sm ff-secondary d-flex gap-2 align-items-center text-truncate">' +
+					'<i class="fa fa-fw fa-magnifying-glass-plus text-primary"></i>' +
+					'<span class="d-none d-md-inline fw-semibold text-truncate text-nowrap">' + escapedLabel + '</span>' +
+					'</button>';
+
+				var $button = $(buttonHtml);
+				var injected = false;
+
+				// 1. Vertical sidebar panel (.topic-sidebar-tools, Harmony topicSidebarTools layout).
+				//    Insert as the first item below the Reply button-container.
+				$('.topic-sidebar-tools [component="topic/reply/container"]').each(function () {
+					var $reply = $(this);
+					if ($reply.nextAll('[component="topic/search-in-topic"]').length === 0) {
+						$reply.after($button.clone(true));
+						injected = true;
+					}
+				});
+
+				// 2. Horizontal mobile/top toolbar (.topic-main-buttons, Harmony/Persona/Peace).
+				//    Insert as first item in the left cluster.
+				$('.topic-main-buttons .d-flex.me-auto').each(function () {
+					var $cluster = $(this);
+					if ($cluster.children('[component="topic/search-in-topic"]').length === 0) {
+						$cluster.prepend($button.clone(true));
+						injected = true;
+					}
+				});
+
+				// 3. Fallback for Persona/Peace and other themes with topic/reply/container
+				//    but without .d-flex.me-auto or .topic-sidebar-tools.
+				if (!injected) {
+					$('[component="topic/reply/container"]').each(function () {
+						var $reply = $(this);
+						if ($reply.nextAll('[component="topic/search-in-topic"]').length === 0) {
+							$reply.after($button.clone(true));
+						}
+					});
+				}
+			});
+		});
+	}
+
+	$(document).on('click', '[component="topic/search-in-topic"]', function () {
+		require(['search'], function (search) {
+			var form = null;
+			var $sidebar = $('[component="sidebar/right"]');
+			if ($sidebar.length && $sidebar.is(':visible')) {
+				form = $sidebar.find('[component="search/form"]');
+			}
+			if (!form || !form.length) {
+				var $bottombar = $('[component="bottombar"]:visible');
+				if ($bottombar.length) {
+					form = $bottombar.find('[component="search/form"]').first();
+				}
+			}
+			if (!form || !form.length) {
+				form = $('[component="search/form"]').first();
+			}
+			if (!form || !form.length) {
+				return;
+			}
+			var $input = form.find('[component="search/fields"] input[name="query"]');
+			var prefix = 'in:topic-' + ajaxify.data.tid + ' ';
+			if ($input.val().indexOf(prefix) !== 0) {
+				$input.val(prefix);
+			}
+			search.showAndFocusInput(form);
+			if (!$input.is(':focus')) {
+				$input.trigger('focus');
+			}
+		});
+	});
+}());

package/static/templates/admin/plugins/topic-search-button.tpl

@@ -0,0 +1,17 @@
+<div class="card">
+	<div class="card-header">
+		<h2 class="card-title">{{tx("topic-search-button:admin.title")}}</h2>
+	</div>
+	<div class="card-body">
+		<form class="topic-search-button-settings">
+			<div class="mb-3">
+				<div class="form-check form-switch">
+					<input class="form-check-input" type="checkbox" role="switch" id="enabled" name="enabled" />
+					<label class="form-check-label" for="enabled">{{tx("topic-search-button:admin.enable")}}</label>
+				</div>
+				<p class="form-text text-xs">{{tx("topic-search-button:admin.enable-help")}}</p>
+			</div>
+			<button type="button" id="save" class="btn btn-primary btn-sm">{{tx("global:save")}}</button>
+		</form>
+	</div>
+</div>