@docusaurus/theme-common 3.10.2 → 4.0.0-canary-6809

package/src/utils/scrollUtils.tsx

@@ -124,7 +124,6 @@ export function useScrollPosition(
     window.addEventListener('scroll', handleScroll, opts);
 
     return () => window.removeEventListener('scroll', handleScroll, opts);
-    // eslint-disable-next-line react-compiler/react-compiler
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [dynamicEffect, scrollEventsEnabledRef, ...deps]);
 }

package/src/utils/{tagsUtils.ts → tagsUtils.tsx}

@@ -5,7 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {translate} from '@docusaurus/Translate';
+import type {ReactNode} from 'react';
+import Translate, {translate} from '@docusaurus/Translate';
 import type {TagsListItem} from '@docusaurus/utils';
 
 export const translateTagsPageTitle = (): string =>
@@ -15,6 +16,16 @@ export const translateTagsPageTitle = (): string =>
     description: 'The title of the tag list page',
   });
 
+export function TagsPageLinkLabel(): ReactNode {
+  return (
+    <Translate
+      id="theme.tags.tagsPageLink"
+      description="The label of the link targeting the tag list page">
+      View all tags
+    </Translate>
+  );
+}
+
 export type TagLetterEntry = {letter: string; tags: TagsListItem[]};
 
 function getTagLetter(tag: string): string {

package/lib/hooks/useSearchPage.d.ts

@@ -1,15 +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;
-//# sourceMappingURL=useSearchPage.d.ts.map

package/lib/hooks/useSearchPage.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useSearchPage.d.ts","sourceRoot":"","sources":["../../src/hooks/useSearchPage.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AASH;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC,CAE3E;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,CAAC,WAAW,EAAE,MAAM,KAAK,MAAM,CAiBtE"}

package/lib/hooks/useSearchPage.js

@@ -1,28 +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 '../utils/historyUtils';
-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, themeConfig }, } = useDocusaurusContext();
-    const { algolia: { searchPagePath }, } = themeConfig;
-    return useCallback((searchValue) => 
-    // Refer to https://github.com/facebook/docusaurus/pull/2838
-    // Note: if searchPagePath is falsy, useSearchPage() will not be called
-    `${baseUrl}${searchPagePath}?${SEARCH_PARAM_QUERY}=${encodeURIComponent(searchValue)}`, [baseUrl, searchPagePath]);
-}
-//# sourceMappingURL=useSearchPage.js.map

package/lib/hooks/useSearchPage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useSearchPage.js","sourceRoot":"","sources":["../../src/hooks/useSearchPage.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,WAAW,EAAC,MAAM,OAAO,CAAC;AAClC,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAC;AAGrD,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAE/B;;GAEG;AACH,MAAM,UAAU,oBAAoB;IAClC,OAAO,cAAc,CAAC,kBAAkB,CAAC,CAAC;AAC5C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB;IAClC,MAAM,EACJ,UAAU,EAAE,EAAC,OAAO,EAAE,WAAW,EAAC,GACnC,GAAG,oBAAoB,EAAE,CAAC;IAC3B,MAAM,EACJ,OAAO,EAAE,EAAC,cAAc,EAAC,GAC1B,GAAG,WAAiC,CAAC;IAEtC,OAAO,WAAW,CAChB,CAAC,WAAmB,EAAE,EAAE;IACtB,4DAA4D;IAC5D,uEAAuE;IACvE,GAAG,OAAO,GACR,cACF,IAAI,kBAAkB,IAAI,kBAAkB,CAAC,WAAW,CAAC,EAAE,EAC7D,CAAC,OAAO,EAAE,cAAc,CAAC,CAC1B,CAAC;AACJ,CAAC"}

package/src/hooks/useSearchPage.ts

@@ -1,42 +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 '../utils/historyUtils';
-import type {ThemeConfig as AlgoliaThemeConfig} from '@docusaurus/theme-search-algolia';
-
-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, themeConfig},
-  } = useDocusaurusContext();
-  const {
-    algolia: {searchPagePath},
-  } = themeConfig as AlgoliaThemeConfig;
-
-  return useCallback(
-    (searchValue: string) =>
-      // Refer to https://github.com/facebook/docusaurus/pull/2838
-      // Note: if searchPagePath is falsy, useSearchPage() will not be called
-      `${baseUrl}${
-        searchPagePath as string
-      }?${SEARCH_PARAM_QUERY}=${encodeURIComponent(searchValue)}`,
-    [baseUrl, searchPagePath],
-  );
-}