fix(theme-common): restore useContextualSearchFilters public API for retrocompatibility (#10397)

This commit is contained in:
Sébastien Lorber 2024-08-13 13:30:45 +02:00 committed by GitHub
parent 685730ed32
commit 221ced7242
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -5,6 +5,9 @@
* LICENSE file in the root directory of this source tree.
*/
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import {DEFAULT_SEARCH_TAG} from './utils/searchUtils';
// TODO Docusaurus v4: remove these workarounds as a breaking change
// and remove docs plugin peerDeps in theme-common/package.json
// This is public API surface that we need to keep for v3
@ -27,6 +30,14 @@ export function useDocsPreferredVersion(...args: unknown[]): unknown {
...args,
);
}
export function useContextualSearchFilters() {
const {i18n} = useDocusaurusContext();
const docsTags =
// eslint-disable-next-line @typescript-eslint/no-var-requires
require('@docusaurus/plugin-content-docs/client').useDocsContextualSearchTags();
const tags = [DEFAULT_SEARCH_TAG, ...docsTags];
return {locale: i18n.currentLocale, tags};
}
/*
* APIs to document