@docusaurus/theme-search-algolia 2.3.0 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/lib/theme/SearchBar/index.js +6 -4
  2. package/lib/theme/SearchPage/index.js +3 -5
  3. package/package.json +11 -11
  4. package/src/theme/SearchBar/index.tsx +6 -4
  5. package/src/theme/SearchPage/index.tsx +3 -5
package/lib/theme/SearchBar/index.js CHANGED
@@ -9,8 +9,10 @@ import {DocSearchButton, useDocSearchKeyboardEvents} from '@docsearch/react';
9
9
  import Head from '@docusaurus/Head';
10
10
  import Link from '@docusaurus/Link';
11
11
  import {useHistory} from '@docusaurus/router';
12
- import {isRegexpStringMatch} from '@docusaurus/theme-common';
13
- import {useSearchPage} from '@docusaurus/theme-common/internal';
12
+ import {
13
+ isRegexpStringMatch,
14
+ useSearchLinkCreator,
15
+ } from '@docusaurus/theme-common';
14
16
  import {
15
17
  useAlgoliaContextualFacetFilters,
16
18
  useSearchResultUrlProcessor,
@@ -24,9 +26,9 @@ function Hit({hit, children}) {
24
26
  return <Link to={hit.url}>{children}</Link>;
25
27
  }
26
28
  function ResultsFooter({state, onClose}) {
27
- const {generateSearchPageLink} = useSearchPage();
29
+ const createSearchLink = useSearchLinkCreator();
28
30
  return (
29
- <Link to={generateSearchPageLink(state.query)} onClick={onClose}>
31
+ <Link to={createSearchLink(state.query)} onClick={onClose}>
30
32
  <Translate
31
33
  id="theme.SearchBar.seeAll"
32
34
  values={{count: state.context.nbHits}}>
package/lib/theme/SearchPage/index.js CHANGED
@@ -17,11 +17,9 @@ import {
17
17
  HtmlClassNameProvider,
18
18
  useEvent,
19
19
  usePluralForm,
20
+ useSearchQueryString,
20
21
  } from '@docusaurus/theme-common';
21
- import {
22
- useSearchPage,
23
- useTitleFormatter,
24
- } from '@docusaurus/theme-common/internal';
22
+ import {useTitleFormatter} from '@docusaurus/theme-common/internal';
25
23
  import Translate, {translate} from '@docusaurus/Translate';
26
24
  import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
27
25
  import {
@@ -125,7 +123,7 @@ function SearchPageContent() {
125
123
  const processSearchResultUrl = useSearchResultUrlProcessor();
126
124
  const documentsFoundPlural = useDocumentsFoundPlural();
127
125
  const docsSearchVersionsHelpers = useDocsSearchVersionsHelpers();
128
- const {searchQuery, setSearchQuery} = useSearchPage();
126
+ const [searchQuery, setSearchQuery] = useSearchQueryString();
129
127
  const initialSearchResultState = {
130
128
  items: [],
131
129
  query: null,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@docusaurus/theme-search-algolia",
3
- "version": "2.3.0",
3
+ "version": "2.4.0",
4
4
  "description": "Algolia search component for Docusaurus.",
5
5
  "main": "lib/index.js",
6
6
  "sideEffects": [
@@ -34,24 +34,24 @@
34
34
  },
35
35
  "dependencies": {
36
36
  "@docsearch/react": "^3.1.1",
37
- "@docusaurus/core": "2.3.0",
38
- "@docusaurus/logger": "2.3.0",
39
- "@docusaurus/plugin-content-docs": "2.3.0",
40
- "@docusaurus/theme-common": "2.3.0",
41
- "@docusaurus/theme-translations": "2.3.0",
42
- "@docusaurus/utils": "2.3.0",
43
- "@docusaurus/utils-validation": "2.3.0",
37
+ "@docusaurus/core": "2.4.0",
38
+ "@docusaurus/logger": "2.4.0",
39
+ "@docusaurus/plugin-content-docs": "2.4.0",
40
+ "@docusaurus/theme-common": "2.4.0",
41
+ "@docusaurus/theme-translations": "2.4.0",
42
+ "@docusaurus/utils": "2.4.0",
43
+ "@docusaurus/utils-validation": "2.4.0",
44
44
  "algoliasearch": "^4.13.1",
45
45
  "algoliasearch-helper": "^3.10.0",
46
46
  "clsx": "^1.2.1",
47
- "eta": "^1.12.3",
47
+ "eta": "^2.0.0",
48
48
  "fs-extra": "^10.1.0",
49
49
  "lodash": "^4.17.21",
50
50
  "tslib": "^2.4.0",
51
51
  "utility-types": "^3.10.0"
52
52
  },
53
53
  "devDependencies": {
54
- "@docusaurus/module-type-aliases": "2.3.0"
54
+ "@docusaurus/module-type-aliases": "2.4.0"
55
55
  },
56
56
  "peerDependencies": {
57
57
  "react": "^16.8.4 || ^17.0.0",
@@ -60,5 +60,5 @@
60
60
  "engines": {
61
61
  "node": ">=16.14"
62
62
  },
63
- "gitHead": "ad477781bdca6a11fa9c6daef5048bdcec0ee37e"
63
+ "gitHead": "898b85ef134cc43bf3b1209aad0ca8cdcfb214c5"
64
64
  }
package/src/theme/SearchBar/index.tsx CHANGED
@@ -10,8 +10,10 @@ import {DocSearchButton, useDocSearchKeyboardEvents} from '@docsearch/react';
10
10
  import Head from '@docusaurus/Head';
11
11
  import Link from '@docusaurus/Link';
12
12
  import {useHistory} from '@docusaurus/router';
13
- import {isRegexpStringMatch} from '@docusaurus/theme-common';
14
- import {useSearchPage} from '@docusaurus/theme-common/internal';
13
+ import {
14
+ isRegexpStringMatch,
15
+ useSearchLinkCreator,
16
+ } from '@docusaurus/theme-common';
15
17
  import {
16
18
  useAlgoliaContextualFacetFilters,
17
19
  useSearchResultUrlProcessor,
@@ -59,10 +61,10 @@ type ResultsFooterProps = {
59
61
  };
60
62
 
61
63
  function ResultsFooter({state, onClose}: ResultsFooterProps) {
62
- const {generateSearchPageLink} = useSearchPage();
64
+ const createSearchLink = useSearchLinkCreator();
63
65
 
64
66
  return (
65
- <Link to={generateSearchPageLink(state.query)} onClick={onClose}>
67
+ <Link to={createSearchLink(state.query)} onClick={onClose}>
66
68
  <Translate
67
69
  id="theme.SearchBar.seeAll"
68
70
  values={{count: state.context.nbHits}}>
package/src/theme/SearchPage/index.tsx CHANGED
@@ -21,11 +21,9 @@ import {
21
21
  HtmlClassNameProvider,
22
22
  useEvent,
23
23
  usePluralForm,
24
+ useSearchQueryString,
24
25
  } from '@docusaurus/theme-common';
25
- import {
26
- useSearchPage,
27
- useTitleFormatter,
28
- } from '@docusaurus/theme-common/internal';
26
+ import {useTitleFormatter} from '@docusaurus/theme-common/internal';
29
27
  import Translate, {translate} from '@docusaurus/Translate';
30
28
  import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
31
29
  import {
@@ -167,7 +165,7 @@ function SearchPageContent(): JSX.Element {
167
165
  const documentsFoundPlural = useDocumentsFoundPlural();
168
166
 
169
167
  const docsSearchVersionsHelpers = useDocsSearchVersionsHelpers();
170
- const {searchQuery, setSearchQuery} = useSearchPage();
168
+ const [searchQuery, setSearchQuery] = useSearchQueryString();
171
169
  const initialSearchResultState: ResultDispatcherState = {
172
170
  items: [],
173
171
  query: null,