@easyops-cn/docusaurus-search-local 0.33.5 → 0.34.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.34.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.33.6...v0.34.0) (2023-02-16)
+
+
+### Features
+
+* improve search context feature [#319](https://github.com/easyops-cn/docusaurus-search-local/issues/319) ([a9578cc](https://github.com/easyops-cn/docusaurus-search-local/commit/a9578cc34856031d5b9a16ed6edd29b6dcb922c3))
+
+## [0.33.6](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.33.5...v0.33.6) (2022-11-28)
+
+
+### Bug Fixes
+
+* use key instead of code for keyboard events ([5e919f4](https://github.com/easyops-cn/docusaurus-search-local/commit/5e919f4e23b2b97380ca6fc8622254bcf3ff4fa0)), closes [#298](https://github.com/easyops-cn/docusaurus-search-local/issues/298)
+
 ## [0.33.5](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.33.4...v0.33.5) (2022-10-24)
 
 

package/README.md

@@ -1,2 +1 @@
 See https://github.com/easyops-cn/docusaurus-search-local#readme
-

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

@@ -144,10 +144,15 @@ export default function SearchBar({ handleSearchBarToggle, }) {
                         }
                         const url = `${baseUrl}search?${params.toString()}`;
                         a.href = url;
-                        a.textContent = translate({
-                            id: "theme.SearchBar.seeAll",
-                            message: "See all results",
-                        });
+                        a.textContent = searchContext
+                            ? translate({
+                                id: "theme.SearchBar.searchInContext",
+                                message: "See all results in {context}",
+                            }, { context: searchContext })
+                            : translate({
+                                id: "theme.SearchBar.seeAll",
+                                message: "See all results",
+                            });
                         a.addEventListener("click", (e) => {
                             if (!e.ctrlKey && !e.metaKey) {
                                 e.preventDefault();
@@ -247,7 +252,8 @@ export default function SearchBar({ handleSearchBarToggle, }) {
         }
         // Add shortcuts command/ctrl + K
         const handleShortcut = (event) => {
-            if ((isMac ? event.metaKey : event.ctrlKey) && event.code === "KeyK") {
+            if ((isMac ? event.metaKey : event.ctrlKey) &&
+                (event.key === "k" || event.key === "K")) {
                 event.preventDefault();
                 searchBarRef.current?.focus();
                 onInputFocus();
@@ -286,9 +292,9 @@ export default function SearchBar({ handleSearchBarToggle, }) {
             searchBarShortcutHint &&
             (inputValue !== "" ? (<button className={styles.searchClearButton} onClick={onClearSearch}>
             ✕
-          </button>) : (<div className={styles.searchHintContainer}>
-            <kbd className={styles.searchHint}>{isMac ? "⌘" : "ctrl"}</kbd>
-            <kbd className={styles.searchHint}>K</kbd>
-          </div>))}
+          </button>) : (ExecutionEnvironment.canUseDOM && (<div className={styles.searchHintContainer}>
+              <kbd className={styles.searchHint}>{isMac ? "⌘" : "ctrl"}</kbd>
+              <kbd className={styles.searchHint}>K</kbd>
+            </div>)))}
     </div>);
 }

package/dist/client/client/theme/SearchPage/SearchPage.jsx

@@ -5,6 +5,7 @@ import Head from "@docusaurus/Head";
 import Link from "@docusaurus/Link";
 import { translate } from "@docusaurus/Translate";
 import { usePluralForm } from "@docusaurus/theme-common";
+import clsx from "clsx";
 import useSearchQuery from "../hooks/useSearchQuery";
 import { fetchIndexes } from "../SearchBar/fetchIndexes";
 import { SearchSourceFactory } from "../../utils/SearchSourceFactory";
@@ -13,7 +14,7 @@ import { highlightStemmed } from "../../utils/highlightStemmed";
 import { getStemmedPositions } from "../../utils/getStemmedPositions";
 import LoadingRing from "../LoadingRing/LoadingRing";
 import { concatDocumentPath } from "../../utils/concatDocumentPath";
-import { Mark } from "../../utils/proxiedGenerated";
+import { Mark, searchContextByPaths, useAllContextsWithNoSearchContext, } from "../../utils/proxiedGenerated";
 import styles from "./SearchPage.module.css";
 export default function SearchPage() {
     return (<Layout>
@@ -23,7 +24,7 @@ export default function SearchPage() {
 function SearchPageContent() {
     const { siteConfig: { baseUrl }, } = useDocusaurusContext();
     const { selectMessage } = usePluralForm();
-    const { searchValue, searchContext, searchVersion, updateSearchPath } = useSearchQuery();
+    const { searchValue, searchContext, searchVersion, updateSearchPath, updateSearchContext, } = useSearchQuery();
     const [searchQuery, setSearchQuery] = useState(searchValue);
     const [searchSource, setSearchSource] = useState();
     const [searchResults, setSearchResults] = useState();
@@ -84,7 +85,29 @@ function SearchPageContent() {
       <div className="container margin-vert--lg">
         <h1>{pageTitle}</h1>
 
-        <input type="search" name="q" className={styles.searchQueryInput} aria-label="Search" onChange={handleSearchInputChange} value={searchQuery} autoComplete="off" autoFocus/>
+        <div className="row">
+          <div className={clsx("col", styles.searchQueryColumn, {
+            "col--9": Array.isArray(searchContextByPaths),
+            "col--12": !Array.isArray(searchContextByPaths),
+        })}>
+            <input type="search" name="q" className={styles.searchQueryInput} aria-label="Search" onChange={handleSearchInputChange} value={searchQuery} autoComplete="off" autoFocus/>
+          </div>
+          {Array.isArray(searchContextByPaths) ? (<div className={clsx("col", "col--3", "padding-left--none", styles.searchVersionColumn)}>
+              <select name="search-context" className={styles.searchVersionInput} id="context-selector" value={searchContext} onChange={(e) => updateSearchContext(e.target.value)}>
+                <option value="">
+                  {useAllContextsWithNoSearchContext
+                ? translate({
+                    id: "theme.SearchPage.searchContext.everywhere",
+                    message: "everywhere",
+                })
+                : ""}
+                </option>
+                {searchContextByPaths.map((context) => (<option key={context} value={context}>
+                    {context}
+                  </option>))}
+              </select>
+            </div>) : null}
+        </div>
 
         {!searchSource && searchQuery && (<div>
             <LoadingRing />

package/dist/client/client/theme/SearchPage/SearchPage.module.css

@@ -1,3 +1,4 @@
+.searchVersionInput,
 .searchQueryInput {
   border-radius: var(--ifm-global-radius);
   border: var(--ifm-global-border-width) solid

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

@@ -38,6 +38,13 @@ function useSearchQuery() {
                 search: searchParams.toString(),
             });
         },
+        updateSearchContext: (searchContext) => {
+            const searchParams = new URLSearchParams(location.search);
+            searchParams.set(SEARCH_PARAM_CONTEXT, searchContext);
+            history.replace({
+                search: searchParams.toString(),
+            });
+        },
         generateSearchPageLink: (searchValue) => {
             const searchParams = getSearchParams(searchValue);
             // Refer to https://github.com/facebook/docusaurus/pull/2838

package/dist/locales/vi.json

@@ -1,9 +1,9 @@
 {
-  "theme.SearchBar.label": "Tìm",
-  "theme.SearchBar.seeAll": "Xem tất cả",
-  "theme.SearchBar.noResultsText": "Không tìm thấy",
-  "theme.SearchPage.existingResultsTitle": "“{query}” kết quả",
-  "theme.SearchPage.emptyResultsTitle": "Không tiêu đề",
-  "theme.SearchPage.documentsFound.plurals": "Có {count} kết quả",
+  "theme.SearchBar.label": "Tìm kiếm...",
+  "theme.SearchBar.seeAll": "Xem tất cả kết quả được tìm thấy",
+  "theme.SearchBar.noResultsText": "Không tìm thấy kết quả nào",
+  "theme.SearchPage.existingResultsTitle": "Tìm kiếm theo tiêu đề: “{query}”",
+  "theme.SearchPage.emptyResultsTitle": "Tìm kiếm theo tiêu đề",
+  "theme.SearchPage.documentsFound.plurals": "Có {count} kết quả được tìm thấy",
   "theme.SearchPage.noResultsText": "Không tìm thấy kết quả nào"
 }

package/dist/server/server/utils/generate.js

@@ -6,7 +6,7 @@ const fs_1 = tslib_1.__importDefault(require("fs"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const getIndexHash_1 = require("./getIndexHash");
 function generate(config, dir) {
-    const { language, removeDefaultStopWordFilter, removeDefaultStemmer, highlightSearchTermsOnTargetPage, searchResultLimits, searchResultContextMaxLength, explicitSearchResultPath, searchBarShortcut, searchBarShortcutHint, searchBarPosition, docsPluginIdForPreferredVersion, indexDocs, searchContextByPaths, hideSearchBarWithNoSearchContext, } = config;
+    const { language, removeDefaultStopWordFilter, removeDefaultStemmer, highlightSearchTermsOnTargetPage, searchResultLimits, searchResultContextMaxLength, explicitSearchResultPath, searchBarShortcut, searchBarShortcutHint, searchBarPosition, docsPluginIdForPreferredVersion, indexDocs, searchContextByPaths, hideSearchBarWithNoSearchContext, useAllContextsWithNoSearchContext, } = config;
     const indexHash = (0, getIndexHash_1.getIndexHash)(config);
     const contents = [
         `import lunr from ${JSON.stringify(require.resolve("lunr"))};`,
@@ -60,6 +60,7 @@ function generate(config, dir) {
         ? searchContextByPaths
         : null)};`);
     contents.push(`export const hideSearchBarWithNoSearchContext = ${JSON.stringify(!!hideSearchBarWithNoSearchContext)};`);
+    contents.push(`export const useAllContextsWithNoSearchContext = ${JSON.stringify(!!useAllContextsWithNoSearchContext)};`);
     fs_1.default.writeFileSync(path_1.default.join(dir, "generated.js"), contents.join("\n"));
     return searchIndexFilename;
 }

package/dist/server/server/utils/postBuildFactory.js

@@ -21,7 +21,7 @@ function postBuildFactory(config, searchIndexFilename) {
                 const allDocuments = yield (0, scanDocuments_1.scanDocuments)(versionData.paths);
                 (0, debug_1.debugInfo)("building index");
                 const docsByDirMap = new Map();
-                const { searchContextByPaths, hideSearchBarWithNoSearchContext } = config;
+                const { searchContextByPaths, hideSearchBarWithNoSearchContext, useAllContextsWithNoSearchContext, } = config;
                 if (searchContextByPaths) {
                     const { baseUrl } = buildData;
                     const rootAllDocs = [];
@@ -46,7 +46,9 @@ function postBuildFactory(config, searchIndexFilename) {
                                         dirAllDocs[docIndex] = dirDocs = [];
                                     }
                                     dirDocs.push(doc);
-                                    continue;
+                                    if (!useAllContextsWithNoSearchContext) {
+                                        continue;
+                                    }
                                 }
                             }
                             rootAllDocs[docIndex].push(doc);

package/dist/server/server/utils/validateOptions.js

@@ -30,6 +30,7 @@ const schema = utils_validation_1.Joi.object({
     zhUserDictPath: utils_validation_1.Joi.string(),
     searchContextByPaths: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()),
     hideSearchBarWithNoSearchContext: utils_validation_1.Joi.boolean().default(false),
+    useAllContextsWithNoSearchContext: utils_validation_1.Joi.boolean().default(false),
 });
 function validateOptions({ options, validate, }) {
     return validate(schema, options || {});

package/dist/types/index.d.ts

@@ -149,4 +149,13 @@ export interface PluginOptions {
      * @default false
      */
     hideSearchBarWithNoSearchContext?: boolean;
+    /**
+     * Whether to show results from all the contexts if no context is provided.
+     *
+     * This option should not be used with `hideSearchBarWithNoSearchContext` set to `true` as this would show results
+     * when there is no search context.
+     *
+     * @default false
+     */
+    useAllContextsWithNoSearchContext?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.33.5",
+  "version": "0.34.0",
   "description": "An offline/local search plugin for Docusaurus v2",
   "repository": "https://github.com/easyops-cn/docusaurus-search-local",
   "homepage": "https://github.com/easyops-cn/docusaurus-search-local",
@@ -54,7 +54,7 @@
     "@types/jest": "^28.0.0",
     "@types/klaw-sync": "^6.0.0",
     "@types/lunr": "^2.3.3",
-    "@types/node": "^17.0.34",
+    "@types/node": "^18.0.0",
     "@types/react": "^18.0.0",
     "@types/react-helmet": "^6.1.0",
     "@types/react-router-dom": "^5.1.6",