@docusaurus/theme-search-algolia 2.0.0-beta.18 → 2.0.0-beta.19

package/lib/client/useAlgoliaContextualFacetFilters.js

@@ -8,7 +8,7 @@ import {useContextualSearchFilters} from '@docusaurus/theme-common';
 // Translate search-engine agnostic search filters to Algolia search filters
 export function useAlgoliaContextualFacetFilters() {
   const {locale, tags} = useContextualSearchFilters();
-  // seems safe to convert locale->language, see AlgoliaSearchMetadata comment
+  // Seems safe to convert locale->language, see AlgoliaSearchMetadata comment
   const languageFilter = `language:${locale}`;
   const tagsFilter = tags.map((tag) => `docusaurus_tag:${tag}`);
   return [languageFilter, tagsFilter];

package/lib/theme/SearchBar/index.js

@@ -15,7 +15,6 @@ import {isRegexpStringMatch, useSearchPage} from '@docusaurus/theme-common';
 import {DocSearchButton, useDocSearchKeyboardEvents} from '@docsearch/react';
 import {useAlgoliaContextualFacetFilters} from '@docusaurus/theme-search-algolia/client';
 import Translate, {translate} from '@docusaurus/Translate';
-import styles from './styles.module.css';
 let DocSearchModal = null;
 function Hit({hit, children}) {
   return <Link to={hit.url}>{children}</Link>;
@@ -45,7 +44,7 @@ function DocSearch({contextualSearch, externalUrlRegex, ...props}) {
       mergeFacetFilters(contextualSearchFacetFilters, configFacetFilters)
     : // ... or use config facetFilters
       configFacetFilters;
-  // we let user override default searchParameters if he wants to
+  // We let user override default searchParameters if she wants to
   const searchParameters = {
     ...props.searchParameters,
     facetFilters,
@@ -159,19 +158,17 @@ function DocSearch({contextualSearch, externalUrlRegex, ...props}) {
         />
       </Head>
 
-      <div className={styles.searchBox}>
-        <DocSearchButton
-          onTouchStart={importDocSearchModalIfNeeded}
-          onFocus={importDocSearchModalIfNeeded}
-          onMouseOver={importDocSearchModalIfNeeded}
-          onClick={onOpen}
-          ref={searchButtonRef}
-          translations={{
-            buttonText: translatedSearchLabel,
-            buttonAriaLabel: translatedSearchLabel,
-          }}
-        />
-      </div>
+      <DocSearchButton
+        onTouchStart={importDocSearchModalIfNeeded}
+        onFocus={importDocSearchModalIfNeeded}
+        onMouseOver={importDocSearchModalIfNeeded}
+        onClick={onOpen}
+        ref={searchButtonRef}
+        translations={{
+          buttonText: translatedSearchLabel,
+          buttonAriaLabel: translatedSearchLabel,
+        }}
+      />
 
       {isOpen &&
         DocSearchModal &&

package/lib/validateThemeConfig.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, '__esModule', {value: true});
 exports.validateThemeConfig = exports.Schema = exports.DEFAULT_CONFIG = void 0;
 const utils_validation_1 = require('@docusaurus/utils-validation');
 exports.DEFAULT_CONFIG = {
-  // enabled by default, as it makes sense in most cases
+  // Enabled by default, as it makes sense in most cases
   // see also https://github.com/facebook/docusaurus/issues/5880
   contextualSearch: true,
   searchParameters: {},

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@docusaurus/theme-search-algolia",
-  "version": "2.0.0-beta.18",
+  "version": "2.0.0-beta.19",
   "description": "Algolia search component for Docusaurus.",
   "main": "lib/index.js",
+  "sideEffects": [
+    "*.css"
+  ],
   "exports": {
     "./client": "./lib/client/index.js",
     ".": "./lib/index.js"
@@ -26,24 +29,24 @@
   },
   "dependencies": {
     "@docsearch/react": "^3.0.0",
-    "@docusaurus/core": "2.0.0-beta.18",
-    "@docusaurus/logger": "2.0.0-beta.18",
-    "@docusaurus/plugin-content-docs": "2.0.0-beta.18",
-    "@docusaurus/theme-common": "2.0.0-beta.18",
-    "@docusaurus/theme-translations": "2.0.0-beta.18",
-    "@docusaurus/utils": "2.0.0-beta.18",
-    "@docusaurus/utils-validation": "2.0.0-beta.18",
+    "@docusaurus/core": "2.0.0-beta.19",
+    "@docusaurus/logger": "2.0.0-beta.19",
+    "@docusaurus/plugin-content-docs": "2.0.0-beta.19",
+    "@docusaurus/theme-common": "2.0.0-beta.19",
+    "@docusaurus/theme-translations": "2.0.0-beta.19",
+    "@docusaurus/utils": "2.0.0-beta.19",
+    "@docusaurus/utils-validation": "2.0.0-beta.19",
     "algoliasearch": "^4.13.0",
-    "algoliasearch-helper": "^3.7.4",
+    "algoliasearch-helper": "^3.8.2",
     "clsx": "^1.1.1",
     "eta": "^1.12.3",
-    "fs-extra": "^10.0.1",
+    "fs-extra": "^10.1.0",
     "lodash": "^4.17.21",
-    "tslib": "^2.3.1",
+    "tslib": "^2.4.0",
     "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.18"
+    "@docusaurus/module-type-aliases": "2.0.0-beta.19"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -52,5 +55,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "1a945d06993d53376e61bed2c942799fe07dc336"
+  "gitHead": "a71e60a49cce93c1006ef10c41ac03187f057102"
 }

package/src/client/useAlgoliaContextualFacetFilters.ts

@@ -11,7 +11,7 @@ import {useContextualSearchFilters} from '@docusaurus/theme-common';
 export function useAlgoliaContextualFacetFilters(): [string, string[]] {
   const {locale, tags} = useContextualSearchFilters();
 
-  // seems safe to convert locale->language, see AlgoliaSearchMetadata comment
+  // Seems safe to convert locale->language, see AlgoliaSearchMetadata comment
   const languageFilter = `language:${locale}`;
 
   const tagsFilter = tags.map((tag) => `docusaurus_tag:${tag}`);

package/src/theme/SearchBar/index.tsx

@@ -14,9 +14,9 @@ import Link from '@docusaurus/Link';
 import Head from '@docusaurus/Head';
 import {isRegexpStringMatch, useSearchPage} from '@docusaurus/theme-common';
 import {DocSearchButton, useDocSearchKeyboardEvents} from '@docsearch/react';
+import type {SearchClient} from 'algoliasearch/lite';
 import {useAlgoliaContextualFacetFilters} from '@docusaurus/theme-search-algolia/client';
 import Translate, {translate} from '@docusaurus/Translate';
-import styles from './styles.module.css';
 
 import type {
   DocSearchModal as DocSearchModalType,
@@ -99,7 +99,7 @@ function DocSearch({
     : // ... or use config facetFilters
       configFacetFilters;
 
-  // we let user override default searchParameters if he wants to
+  // We let user override default searchParameters if she wants to
   const searchParameters: DocSearchProps['searchParameters'] = {
     ...props.searchParameters,
     facetFilters,
@@ -145,7 +145,7 @@ function DocSearch({
   }, [setIsOpen]);
 
   const onInput = useCallback(
-    (event) => {
+    (event: KeyboardEvent) => {
       importDocSearchModalIfNeeded().then(() => {
         setIsOpen(true);
         setInitialQuery(event.key);
@@ -194,7 +194,7 @@ function DocSearch({
     );
 
   const transformSearchClient = useCallback(
-    (searchClient) => {
+    (searchClient: SearchClient) => {
       searchClient.addAlgoliaAgent(
         'docusaurus',
         siteMetadata.docusaurusVersion,
@@ -232,19 +232,17 @@ function DocSearch({
         />
       </Head>
 
-      <div className={styles.searchBox}>
-        <DocSearchButton
-          onTouchStart={importDocSearchModalIfNeeded}
-          onFocus={importDocSearchModalIfNeeded}
-          onMouseOver={importDocSearchModalIfNeeded}
-          onClick={onOpen}
-          ref={searchButtonRef}
-          translations={{
-            buttonText: translatedSearchLabel,
-            buttonAriaLabel: translatedSearchLabel,
-          }}
-        />
-      </div>
+      <DocSearchButton
+        onTouchStart={importDocSearchModalIfNeeded}
+        onFocus={importDocSearchModalIfNeeded}
+        onMouseOver={importDocSearchModalIfNeeded}
+        onClick={onOpen}
+        ref={searchButtonRef}
+        translations={{
+          buttonText: translatedSearchLabel,
+          buttonAriaLabel: translatedSearchLabel,
+        }}
+      />
 
       {isOpen &&
         DocSearchModal &&

package/src/validateThemeConfig.ts

@@ -12,7 +12,7 @@ import type {
 } from '@docusaurus/types';
 
 export const DEFAULT_CONFIG = {
-  // enabled by default, as it makes sense in most cases
+  // Enabled by default, as it makes sense in most cases
   // see also https://github.com/facebook/docusaurus/issues/5880
   contextualSearch: true,
 

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

@@ -1,20 +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.
- */
-
-@media (max-width: 996px) {
-  .searchBox {
-    position: absolute;
-    right: var(--ifm-navbar-padding-horizontal);
-  }
-}
-
-@media (min-width: 997px) {
-  .searchBox {
-    padding: var(--ifm-navbar-item-padding-vertical)
-      var(--ifm-navbar-item-padding-horizontal);
-  }
-}

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

@@ -1,20 +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.
- */
-
-@media (max-width: 996px) {
-  .searchBox {
-    position: absolute;
-    right: var(--ifm-navbar-padding-horizontal);
-  }
-}
-
-@media (min-width: 997px) {
-  .searchBox {
-    padding: var(--ifm-navbar-item-padding-vertical)
-      var(--ifm-navbar-item-padding-horizontal);
-  }
-}