Add option to config that removes the See All Results link in the sea…

…rch results.
easyops-cn · Jan 23, 2025 · e6cd33c · e6cd33c
1 parent f64b972
commit e6cd33c
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 1 deletion.
diff --git a/docusaurus-search-local/src/client/theme/SearchBar/SearchBar.tsx b/docusaurus-search-local/src/client/theme/SearchBar/SearchBar.tsx
@@ -30,6 +30,7 @@ import {
   searchContextByPaths,
   hideSearchBarWithNoSearchContext,
   useAllContextsWithNoSearchContext,
+  removeSeeAllResults,
 } from "../../utils/proxiedGenerated";
 import LoadingRing from "../LoadingRing/LoadingRing";
 import { normalizeContextByPath } from "../../utils/normalizeContextByPath";
@@ -280,7 +281,9 @@ export default function SearchBar({
               const a = searchFooterLinkElement({ query, isEmpty });
               const div = document.createElement("div");
               div.className = styles.hitFooter;
-              div.appendChild(a);
+              if(removeSeeAllResults === false){
+                div.appendChild(a);
+              }
               return div;
             },
           },

diff --git a/docusaurus-search-local/src/declarations.ts b/docusaurus-search-local/src/declarations.ts
@@ -13,6 +13,7 @@ declare module "*/generated.js" {
   export const explicitSearchResultPath: boolean;
   export const searchBarShortcut: boolean;
   export const searchBarShortcutHint: boolean;
+  export const removeSeeAllResults: boolean;
   export const searchBarPosition: "left" | "right";
   export const docsPluginIdForPreferredVersion: string;
   export const indexDocs: boolean;

diff --git a/docusaurus-search-local/src/index.ts b/docusaurus-search-local/src/index.ts
@@ -199,4 +199,11 @@ export interface PluginOptions {
    * @default false
    */
   forceIgnoreNoIndex?: boolean;
+
+  /**
+   * Whether to remove the see all results button.
+   * 
+   * @default false
+   */
+  removeSeeAllResults?: boolean;
 }
diff --git a/docusaurus-search-local/src/server/utils/generate.ts b/docusaurus-search-local/src/server/utils/generate.ts
@@ -20,6 +20,7 @@ export function generate(config: ProcessedPluginOptions, dir: string): string {
     searchContextByPaths,
     hideSearchBarWithNoSearchContext,
     useAllContextsWithNoSearchContext,
+    removeSeeAllResults,
   } = config;
   const indexHash = getIndexHash(config);
   const contents: string[] = [];
@@ -28,6 +29,13 @@ export function generate(config: ProcessedPluginOptions, dir: string): string {
       removeDefaultStemmer
     )};`
   );
+
+  contents.push(
+    `export const removeSeeAllResults = ${JSON.stringify(
+      removeSeeAllResults
+    )};`
+  );
+
   if (highlightSearchTermsOnTargetPage) {
     contents.push(
       `export { default as Mark } from ${JSON.stringify(

diff --git a/docusaurus-search-local/src/server/utils/validateOptions.ts b/docusaurus-search-local/src/server/utils/validateOptions.ts
@@ -32,6 +32,7 @@ const schema = Joi.object<PluginOptions>({
   removeDefaultStopWordFilter: Joi.boolean().default(false),
   removeDefaultStemmer: Joi.boolean().default(false),
   highlightSearchTermsOnTargetPage: Joi.boolean().default(false),
+  removeSeeAllResults:Joi.boolean().default(false),
   searchResultLimits: Joi.number().default(8),
   searchResultContextMaxLength: Joi.number().default(50),
   explicitSearchResultPath: Joi.boolean().default(false),