@easyops-cn/docusaurus-search-local 0.37.2 → 0.37.3

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.37.3](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.37.2...v0.37.3) (2023-11-12)
+
+
+### Bug Fixes
+
+* fix SSR warning, closes [#364](https://github.com/easyops-cn/docusaurus-search-local/issues/364) ([69378e6](https://github.com/easyops-cn/docusaurus-search-local/commit/69378e67944ca3abd15e179621b5ca53903eecce))
+
 ## [0.37.2](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.37.1...v0.37.2) (2023-11-09)
 
 

package/dist/client/client/theme/SearchBar/SearchBar.jsx

@@ -1,7 +1,7 @@
 import React, { useCallback, useEffect, useRef, useState, } from "react";
 import clsx from "clsx";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
-import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
+import useIsBrowser from "@docusaurus/useIsBrowser";
 import { useHistory, useLocation } from "@docusaurus/router";
 import { translate } from "@docusaurus/Translate";
 import { ReactContextError, useDocsPreferredVersion, } from "@docusaurus/theme-common";
@@ -28,6 +28,7 @@ async function fetchAutoCompleteJS() {
 }
 const SEARCH_PARAM_HIGHLIGHT = "_highlight";
 export default function SearchBar({ handleSearchBarToggle, }) {
+    const isBrowser = useIsBrowser();
     const { siteConfig: { baseUrl }, } = useDocusaurusContext();
     // It returns undefined for non-docs pages
     const activePlugin = useActivePlugin();
@@ -218,7 +219,7 @@ export default function SearchBar({ handleSearchBarToggle, }) {
         if (!Mark) {
             return;
         }
-        const keywords = ExecutionEnvironment.canUseDOM
+        const keywords = isBrowser
             ? new URLSearchParams(location.search).getAll(SEARCH_PARAM_HIGHLIGHT)
             : [];
         // A workaround to fix an issue of highlighting in code blocks.
@@ -239,7 +240,7 @@ export default function SearchBar({ handleSearchBarToggle, }) {
             setInputValue(keywords.join(" "));
             search.current?.autocomplete.setVal(keywords.join(" "));
         });
-    }, [location.search, location.pathname]);
+    }, [isBrowser, location.search, location.pathname]);
     const [focused, setFocused] = useState(false);
     const onInputFocus = useCallback(() => {
         focusAfterIndexLoaded.current = true;
@@ -261,7 +262,7 @@ export default function SearchBar({ handleSearchBarToggle, }) {
         }
     }, []);
     // Implement hint icons for the search shortcuts on mac and the rest operating systems.
-    const isMac = ExecutionEnvironment.canUseDOM
+    const isMac = isBrowser
         ? /mac/i.test(navigator.userAgentData?.platform ?? navigator.platform)
         : false;
     useEffect(() => {
@@ -310,7 +311,7 @@ export default function SearchBar({ handleSearchBarToggle, }) {
             searchBarShortcutHint &&
             (inputValue !== "" ? (<button className={styles.searchClearButton} onClick={onClearSearch}>
             ✕
-          </button>) : (ExecutionEnvironment.canUseDOM && (<div className={styles.searchHintContainer}>
+          </button>) : (isBrowser && (<div className={styles.searchHintContainer}>
               <kbd className={styles.searchHint}>{isMac ? "⌘" : "ctrl"}</kbd>
               <kbd className={styles.searchHint}>K</kbd>
             </div>)))}

package/dist/client/client/theme/hooks/useSearchQuery.js

@@ -5,16 +5,17 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { useHistory, useLocation } from "@docusaurus/router";
-import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
+import useIsBrowser from "@docusaurus/useIsBrowser";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 const SEARCH_PARAM_QUERY = "q";
 const SEARCH_PARAM_CONTEXT = "ctx";
 const SEARCH_PARAM_VERSION = "version";
 function useSearchQuery() {
+    const isBrowser = useIsBrowser();
     const history = useHistory();
     const location = useLocation();
     const { siteConfig: { baseUrl }, } = useDocusaurusContext();
-    const params = ExecutionEnvironment.canUseDOM ? new URLSearchParams(location.search) : null;
+    const params = isBrowser ? new URLSearchParams(location.search) : null;
     const searchValue = params?.get(SEARCH_PARAM_QUERY) || "";
     const searchContext = params?.get(SEARCH_PARAM_CONTEXT) || "";
     const searchVersion = params?.get(SEARCH_PARAM_VERSION) || "";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.37.2",
+  "version": "0.37.3",
   "description": "An offline/local search plugin for Docusaurus v3",
   "repository": "https://github.com/easyops-cn/docusaurus-search-local",
   "homepage": "https://github.com/easyops-cn/docusaurus-search-local",