Document HydeSearch overloading

hydephp · Dec 8, 2024 · a3ac13a · a3ac13a
1 parent 0878552
commit a3ac13a
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/packages/framework/resources/js/HydeSearch.js b/packages/framework/resources/js/HydeSearch.js
@@ -1,3 +1,14 @@
+/**
+ * This file provides support for the Alpine.js search component.
+ *
+ * It's automatically loaded by the hyde-search.blade.php component.
+ *
+ * It can be replaced by a custom implementation, at the developer's own risk,
+ * by providing a new compatible implementation in ./resources/js/HydeSearch.js.
+ *
+ * @param {string} searchIndexUrl
+ * @returns {Object}
+ */
 function initHydeSearch(searchIndexUrl) {
     return {
         searchIndex: [],