How to change the keyboard shortcuts in Algolia Search component?

[idontknowjs]

Swizzling the algolia search component @docusaurus/theme-search-algolia doesn't seem to show the Keyboard shortcuts used

[idontknowjs]

It seems like a part of the @docsearch/react package. Is there any way to edit this?

Motivation behind this

The Ctrl + K key is a common key for enabling narrator view for accessibility tools., so whenever Ctrl + K keys are selected to enter focus into the search bar. The screen reader goes off.

[idontknowjs]

Yes, it's wrapped inside the <Layout></Layout> only. But still gives the same error. This is the Home component:

import useAlgoliaContextualFacetFilters from '@theme/hooks/useAlgoliaContextualFacetFilters';
import { DocSearch } from "@docsearch/react";

function Home() {
  const facetFilters = useAlgoliaContextualFacetFilters();
  return (
    <Layout description="Zowe">
      <header className={clsx("hero", styles.heroBanner)}>
          <div className="searchDiv">
              <DocSearch
              apiKey="59ff39ed48d0820010c7e09fc4b677bf"
              indexName="zowe"
              facetFilters={facetFilters}
              />
          </div>
      </header>
    </Layout>
  );
}

[slorber]

This is exactlly what you should NOT do :)

Youy are using the hook in the component that render the Layout. You should use the hook in a subcomponent. Don't render HTML content directly inside Layout: create a separate component instead., like "SearchHeader"

[idontknowjs]

Tried creating a new SearchHeader sub-component & used the hook in the sub-component. Now the error has resolved, but the results generated from the search gives multiple versions only. Not sure, if I'm doing something wrong here. 😅

SearchHeader.js

import React from 'react'
import { DocSearch } from "@docsearch/react";
import useAlgoliaContextualFacetFilters from '@theme/hooks/useAlgoliaContextualFacetFilters';

function SearchHeader() {
  const facetFilters = useAlgoliaContextualFacetFilters();
  return (
    <DocSearch
      apiKey="59ff39ed48d0820010c7e09fc4b677bf"
      indexName="zowe"
      facetFilters={facetFilters}
    />
  )
}

export default SearchHeader

index.js

import React from 'react'
import Layout from "@theme/Layout";
import SearchHeader from "./SearchHeader";

function Home() {
  return (
    <Layout>
      <SearchHeader />
    </Layout>
  )
}

export default Home;

[slorber]

the results generated from the search gives multiple versions only

I don't understand what you mean here?

Can you log the facetFilters and paste its value here?

This array contains the search filters.

Are the filters incorrect, or are you applying the filters badly to the DocSearch component?
I didn't read the doc of your DocSearch comp and we don't even use it in Docusaurus.
Make sure to pass it the facet filters the correct way, it might as well be searchParameters={{facetFilters}}, I don't know.

[idontknowjs]

@slorber strangely earlier with facetFilters={facetFilters} the search gave result of docs from multiple versions which is not expected.

But with searchParameters={{facetFilters}}. Whenever I'm running locally. The search seem to work successfully & return results from current version. But fails only while building stating the same error message.

Can you please take a look at the changes in this commit. This is probably failing in build.

facetFilters log

Yes it does return an array only.

Array(2)
0: "language:en"
1: Array(2)
0: "docusaurus_tag:default"
1: "docusaurus_tag:docs-default-current"
length: 2
__proto__: Array(0)
length: 2
__proto__: Array(0)

[slorber]

It's not clear to me how it is failing. Is there an error message? Le ven. 9 juil. 2021 à 19:55, Arijit Kundu ***@***.***> a écrit :

…

@slorber <https://github.com/slorber> strangely earlier with facetFilters={facetFilters} the search gave result of docs from multiple versions which is not expected. But with searchParameters={{facetFilters}}. Whenever I'm running locally. The search seem to work successfully & return results from current version. But fails only while building stating the same error message. Can you please take a look at the changes in this commit <idontknowjs/docs-site@5378a87>. This is probably failing in build. facetFilters log Yes it does return an array only. Array(2) 0: "language:en" 1: Array(2) 0: "docusaurus_tag:default" 1: "docusaurus_tag:docs-default-current" length: 2 __proto__: Array(0) length: 2 __proto__: Array(0) — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4952 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAFW6PQX5YC7UW7P7LVPDCLTW4ZZPANCNFSM46QKYXEQ> .

[idontknowjs]

This netlify build might help which failed.

[slorber]

You can't put components into pages/components like that, because Docusaurus will try to create a page for each standalone component. We have added a _ prefix so that JS files in pages don't lead to a page creating Le ven. 9 juil. 2021 à 21:50, Arijit Kundu ***@***.***> a écrit :

…

This netlify build <https://app.netlify.com/sites/zowe-docs-master/deploys/60e886f4eaef600007d505b9> might help which failed. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#4952 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAFW6PRYWSUTZXAV4WYQYYTTW5HHZANCNFSM46QKYXEQ> .

[idontknowjs]

Thank you so much! The build passed & the search seem to work as well!

[slorber]

You can clearly see that Docusaurus is trying to render the comp as a page here: "/components/SearchHeader/SearchHeader" because of following error: Le sam. 10 juil. 2021 à 08:56, Sébastien Lorber ***@***.***> a écrit :

…

You can't put components into pages/components like that, because Docusaurus will try to create a page for each standalone component. We have added a _ prefix so that JS files in pages don't lead to a page creating Le ven. 9 juil. 2021 à 21:50, Arijit Kundu ***@***.***> a écrit : > This netlify build > <https://app.netlify.com/sites/zowe-docs-master/deploys/60e886f4eaef600007d505b9> > might help which failed. > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <#4952 (reply in thread)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AAFW6PRYWSUTZXAV4WYQYYTTW5HHZANCNFSM46QKYXEQ> > . >