@docusaurus/theme-search-algolia 3.10.1-canary-6655 → 3.10.2

package/lib/client/index.d.ts

@@ -8,5 +8,4 @@ export { useAlgoliaThemeConfig } from './useAlgoliaThemeConfig';
 export { useAlgoliaContextualFacetFilters, useAlgoliaContextualFacetFiltersIfEnabled, } from './useAlgoliaContextualFacetFilters';
 export { useSearchResultUrlProcessor } from './useSearchResultUrlProcessor';
 export { useAlgoliaAskAi } from './useAlgoliaAskAi';
-export { useSearchQueryString, useSearchLinkCreator } from './searchPage';
 export { mergeFacetFilters } from './utils';

package/lib/client/index.js

@@ -8,5 +8,4 @@ export { useAlgoliaThemeConfig } from './useAlgoliaThemeConfig';
 export { useAlgoliaContextualFacetFilters, useAlgoliaContextualFacetFiltersIfEnabled, } from './useAlgoliaContextualFacetFilters';
 export { useSearchResultUrlProcessor } from './useSearchResultUrlProcessor';
 export { useAlgoliaAskAi } from './useAlgoliaAskAi';
-export { useSearchQueryString, useSearchLinkCreator } from './searchPage';
 export { mergeFacetFilters } from './utils';

package/lib/theme/SearchBar/index.js

@@ -11,13 +11,15 @@ import {useDocSearchKeyboardEvents} from '@docsearch/react/useDocSearchKeyboardE
 import Head from '@docusaurus/Head';
 import Link from '@docusaurus/Link';
 import {useHistory} from '@docusaurus/router';
-import {isRegexpStringMatch} from '@docusaurus/theme-common';
+import {
+  isRegexpStringMatch,
+  useSearchLinkCreator,
+} from '@docusaurus/theme-common';
 import {
   useAlgoliaContextualFacetFilters,
   useSearchResultUrlProcessor,
   useAlgoliaAskAi,
   mergeFacetFilters,
-  useSearchLinkCreator,
 } from '@docusaurus/theme-search-algolia/client';
 import Translate from '@docusaurus/Translate';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
@@ -82,8 +84,8 @@ function useTransformItems(props) {
 function useResultsFooterComponent({closeModal}) {
   return useMemo(
     () =>
-      // eslint-disable-next-line react/display-name
-      ({state}) => <ResultsFooter state={state} onClose={closeModal} />,
+      ({state}) =>
+        <ResultsFooter state={state} onClose={closeModal} />,
     [closeModal],
   );
 }
@@ -191,8 +193,6 @@ function DocSearch({externalUrlRegex, ...props}) {
 
       {isOpen &&
         DocSearchModal &&
-        // TODO fix this
-        // eslint-disable-next-line react-hooks/refs
         searchContainer.current &&
         createPortal(
           <DocSearchModal
@@ -212,8 +212,6 @@ function DocSearch({externalUrlRegex, ...props}) {
             searchParameters={searchParameters}
             {...extraAskAiProps}
           />,
-          // TODO fix this
-          // eslint-disable-next-line react-hooks/refs
           searchContainer.current,
         )}
     </>

package/lib/theme/SearchPage/index.js

@@ -18,13 +18,13 @@ import {
   PageMetadata,
   useEvent,
   usePluralForm,
+  useSearchQueryString,
 } from '@docusaurus/theme-common';
 import Translate, {translate} from '@docusaurus/Translate';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import {
   useAlgoliaThemeConfig,
   useSearchResultUrlProcessor,
-  useSearchQueryString,
 } from '@docusaurus/theme-search-algolia/client';
 import Layout from '@theme/Layout';
 import Heading from '@theme/Heading';
@@ -309,7 +309,7 @@ function SearchPageContent() {
     ExecutionEnvironment.canUseIntersectionObserver &&
       new IntersectionObserver(
         // TODO need to fix this React Compiler lint error
-        // eslint-disable-next-line react-hooks/refs
+        // eslint-disable-next-line react-compiler/react-compiler
         (entries) => {
           const {
             isIntersecting,
@@ -461,6 +461,7 @@ function SearchPageContent() {
                             key={index}
                             className="breadcrumbs__item"
                             // Developer provided the HTML, so assume it's safe.
+                            // eslint-disable-next-line react/no-danger
                             dangerouslySetInnerHTML={{__html: html}}
                           />
                         ))}
@@ -472,6 +473,7 @@ function SearchPageContent() {
                     <p
                       className={styles.searchResultItemSummary}
                       // Developer provided the HTML, so assume it's safe.
+                      // eslint-disable-next-line react/no-danger
                       dangerouslySetInnerHTML={{__html: summary}}
                     />
                   )}

package/lib/theme/SearchPage/styles.module.css

@@ -70,7 +70,7 @@
   font-style: italic;
 }
 
-@media only screen and (width <= 996px) {
+@media only screen and (max-width: 996px) {
   .searchQueryColumn {
     max-width: 60% !important;
   }
@@ -89,7 +89,7 @@
   }
 }
 
-@media screen and (width <= 576px) {
+@media screen and (max-width: 576px) {
   .searchQueryColumn {
     max-width: 100% !important;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-search-algolia",
-  "version": "3.10.1-canary-6655",
+  "version": "3.10.2",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": [
@@ -27,39 +27,39 @@
   },
   "license": "MIT",
   "scripts": {
-    "build": "tsc --build && node ../../admin/scripts/copyUntypedFiles.js && oxfmt \"lib/theme/**/*.js\"",
+    "build": "tsc --build && node ../../admin/scripts/copyUntypedFiles.js && prettier --config ../../.prettierrc --write \"lib/theme/**/*.js\"",
     "watch": "run-p -c copy:watch build:watch",
     "build:watch": "tsc --build --watch",
     "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
   },
   "dependencies": {
-    "@algolia/autocomplete-core": "^1.19.8",
-    "@docsearch/react": "^4.6.3",
-    "@docusaurus/core": "3.10.1-canary-6655",
-    "@docusaurus/logger": "3.10.1-canary-6655",
-    "@docusaurus/plugin-content-docs": "3.10.1-canary-6655",
-    "@docusaurus/theme-common": "3.10.1-canary-6655",
-    "@docusaurus/theme-translations": "3.10.1-canary-6655",
-    "@docusaurus/utils": "3.10.1-canary-6655",
-    "@docusaurus/utils-validation": "3.10.1-canary-6655",
-    "algoliasearch": "^5.51.0",
-    "algoliasearch-helper": "^3.28.2",
+    "@algolia/autocomplete-core": "^1.19.2",
+    "@docsearch/react": "^3.9.0 || ^4.3.2",
+    "@docusaurus/core": "3.10.2",
+    "@docusaurus/logger": "3.10.2",
+    "@docusaurus/plugin-content-docs": "3.10.2",
+    "@docusaurus/theme-common": "3.10.2",
+    "@docusaurus/theme-translations": "3.10.2",
+    "@docusaurus/utils": "3.10.2",
+    "@docusaurus/utils-validation": "3.10.2",
+    "algoliasearch": "^5.37.0",
+    "algoliasearch-helper": "^3.26.0",
     "clsx": "^2.0.0",
     "eta": "^2.2.0",
-    "fs-extra": "^11.2.0",
+    "fs-extra": "^11.1.1",
     "lodash": "^4.17.21",
     "tslib": "^2.6.0",
     "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.10.1-canary-6655"
+    "@docusaurus/module-type-aliases": "3.10.2"
   },
   "peerDependencies": {
-    "react": "^19.2.5",
-    "react-dom": "^19.2.5"
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
   },
   "engines": {
-    "node": ">=24.14"
+    "node": ">=20.0"
   },
-  "gitHead": "6e93a3055178dd0af922ba627f787229dcdf948b"
+  "gitHead": "f37f9035584917a97a260b91fc2842cba4f8b94f"
 }

package/src/client/index.ts

@@ -12,5 +12,4 @@ export {
 } from './useAlgoliaContextualFacetFilters';
 export {useSearchResultUrlProcessor} from './useSearchResultUrlProcessor';
 export {useAlgoliaAskAi} from './useAlgoliaAskAi';
-export {useSearchQueryString, useSearchLinkCreator} from './searchPage';
 export {mergeFacetFilters} from './utils';

package/src/theme/SearchBar/index.tsx

@@ -18,13 +18,15 @@ import {useDocSearchKeyboardEvents} from '@docsearch/react/useDocSearchKeyboardE
 import Head from '@docusaurus/Head';
 import Link from '@docusaurus/Link';
 import {useHistory} from '@docusaurus/router';
-import {isRegexpStringMatch} from '@docusaurus/theme-common';
+import {
+  isRegexpStringMatch,
+  useSearchLinkCreator,
+} from '@docusaurus/theme-common';
 import {
   useAlgoliaContextualFacetFilters,
   useSearchResultUrlProcessor,
   useAlgoliaAskAi,
   mergeFacetFilters,
-  useSearchLinkCreator,
 } from '@docusaurus/theme-search-algolia/client';
 import Translate from '@docusaurus/Translate';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
@@ -138,8 +140,8 @@ function useResultsFooterComponent({
 }): DocSearchProps['resultsFooterComponent'] {
   return useMemo(
     () =>
-      // eslint-disable-next-line react/display-name
-      ({state}) => <ResultsFooter state={state} onClose={closeModal} />,
+      ({state}) =>
+        <ResultsFooter state={state} onClose={closeModal} />,
     [closeModal],
   );
 }
@@ -285,8 +287,6 @@ function DocSearch({externalUrlRegex, ...props}: DocSearchV4Props) {
 
       {isOpen &&
         DocSearchModal &&
-        // TODO fix this
-        // eslint-disable-next-line react-hooks/refs
         searchContainer.current &&
         createPortal(
           <DocSearchModal
@@ -306,9 +306,6 @@ function DocSearch({externalUrlRegex, ...props}: DocSearchV4Props) {
             searchParameters={searchParameters}
             {...extraAskAiProps}
           />,
-
-          // TODO fix this
-          // eslint-disable-next-line react-hooks/refs
           searchContainer.current,
         )}
     </>

package/src/theme/SearchPage/index.tsx

@@ -28,13 +28,13 @@ import {
   PageMetadata,
   useEvent,
   usePluralForm,
+  useSearchQueryString,
 } from '@docusaurus/theme-common';
 import Translate, {translate} from '@docusaurus/Translate';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import {
   useAlgoliaThemeConfig,
   useSearchResultUrlProcessor,
-  useSearchQueryString,
 } from '@docusaurus/theme-search-algolia/client';
 import Layout from '@theme/Layout';
 import Heading from '@theme/Heading';
@@ -372,7 +372,7 @@ function SearchPageContent(): ReactNode {
     ExecutionEnvironment.canUseIntersectionObserver &&
       new IntersectionObserver(
         // TODO need to fix this React Compiler lint error
-        // eslint-disable-next-line react-hooks/refs
+        // eslint-disable-next-line react-compiler/react-compiler
         (entries) => {
           const {
             isIntersecting,
@@ -536,6 +536,7 @@ function SearchPageContent(): ReactNode {
                             key={index}
                             className="breadcrumbs__item"
                             // Developer provided the HTML, so assume it's safe.
+                            // eslint-disable-next-line react/no-danger
                             dangerouslySetInnerHTML={{__html: html}}
                           />
                         ))}
@@ -547,6 +548,7 @@ function SearchPageContent(): ReactNode {
                     <p
                       className={styles.searchResultItemSummary}
                       // Developer provided the HTML, so assume it's safe.
+                      // eslint-disable-next-line react/no-danger
                       dangerouslySetInnerHTML={{__html: summary}}
                     />
                   )}

package/src/theme/SearchPage/styles.module.css

@@ -70,7 +70,7 @@
   font-style: italic;
 }
 
-@media only screen and (width <= 996px) {
+@media only screen and (max-width: 996px) {
   .searchQueryColumn {
     max-width: 60% !important;
   }
@@ -89,7 +89,7 @@
   }
 }
 
-@media screen and (width <= 576px) {
+@media screen and (max-width: 576px) {
   .searchQueryColumn {
     max-width: 100% !important;
   }

package/lib/client/searchPage.d.ts

@@ -1,14 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-/**
- * Permits to read/write the current search query string
- */
-export declare function useSearchQueryString(): [string, (newValue: string) => void];
-/**
- * Permits to create links to the search page with the appropriate query string
- */
-export declare function useSearchLinkCreator(): (searchValue: string) => string;

package/lib/client/searchPage.js

@@ -1,29 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import { useCallback } from 'react';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import { useQueryString } from '@docusaurus/theme-common';
-import { useAlgoliaThemeConfig } from './useAlgoliaThemeConfig';
-const SEARCH_PARAM_QUERY = 'q';
-/**
- * Permits to read/write the current search query string
- */
-export function useSearchQueryString() {
-    return useQueryString(SEARCH_PARAM_QUERY);
-}
-/**
- * Permits to create links to the search page with the appropriate query string
- */
-export function useSearchLinkCreator() {
-    const { siteConfig: { baseUrl }, } = useDocusaurusContext();
-    const { algolia: { searchPagePath }, } = useAlgoliaThemeConfig();
-    return useCallback(function createSearchLink(searchValue) {
-        // Refer to https://github.com/facebook/docusaurus/pull/2838
-        // Note: if searchPagePath is falsy, useSearchPage() will not be called
-        return `${baseUrl}${searchPagePath}?${SEARCH_PARAM_QUERY}=${encodeURIComponent(searchValue)}`;
-    }, [baseUrl, searchPagePath]);
-}

package/src/client/searchPage.ts

@@ -1,43 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import {useCallback} from 'react';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import {useQueryString} from '@docusaurus/theme-common';
-import {useAlgoliaThemeConfig} from './useAlgoliaThemeConfig';
-
-const SEARCH_PARAM_QUERY = 'q';
-
-/**
- * Permits to read/write the current search query string
- */
-export function useSearchQueryString(): [string, (newValue: string) => void] {
-  return useQueryString(SEARCH_PARAM_QUERY);
-}
-
-/**
- * Permits to create links to the search page with the appropriate query string
- */
-export function useSearchLinkCreator(): (searchValue: string) => string {
-  const {
-    siteConfig: {baseUrl},
-  } = useDocusaurusContext();
-  const {
-    algolia: {searchPagePath},
-  } = useAlgoliaThemeConfig();
-
-  return useCallback(
-    function createSearchLink(searchValue: string) {
-      // Refer to https://github.com/facebook/docusaurus/pull/2838
-      // Note: if searchPagePath is falsy, useSearchPage() will not be called
-      return `${baseUrl}${
-        searchPagePath as string
-      }?${SEARCH_PARAM_QUERY}=${encodeURIComponent(searchValue)}`;
-    },
-    [baseUrl, searchPagePath],
-  );
-}