3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-03 16:59:06 +02:00
Code Issues Projects Releases Packages Wiki Activity

refactor: move exported type definitions to declaration file (#6300)

Browse source 
* refactor: move exported type definitions to declaration file

* fix

* fix
This commit is contained in:
Joshua Chen 2022-01-09 22:02:31 +08:00 • committed by GitHub
parent 9c0e659a44
commit cf265c051e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
53 changed files with 482 additions and 452 deletions
Download patch file Download diff file Expand all files Collapse all files

3
packages/docusaurus-theme-search-algolia/package.json
View file

@ -36,7 +36,8 @@
"clsx": "^1.1.1",
"eta": "^1.12.3",
"lodash": "^4.17.20",
"tslib": "^2.3.1"
"tslib": "^2.3.1",
"utility-types": "^3.10.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "2.0.0-beta.14",

27
packages/docusaurus-theme-search-algolia/src/theme-search-algolia.d.ts vendored
View file

@ -5,6 +5,22 @@
* LICENSE file in the root directory of this source tree.
*/
declare module '@docusaurus/theme-search-algolia' {
import type {DeepPartial} from 'utility-types';
export type ThemeConfig = {
algolia: {
contextualSearch: boolean;
externalUrlRegex?: string;
appId: string;
apiKey: string;
indexName: string;
searchParameters: Record<string, unknown>;
};
};
export type UserThemeConfig = DeepPartial<ThemeConfig>;
}
declare module '@docusaurus/theme-search-algolia/client' {
export function useAlgoliaContextualFacetFilters(): [string, string[]];
}
@ -14,17 +30,6 @@ declare module '@theme/SearchPage' {
export default SearchPage;
}
declare module '@theme/SearchMetadata' {
export type SearchMetadataProps = {
readonly locale?: string;
readonly version?: string;
readonly tag?: string;
};
const SearchMetadata: (props: SearchMetadataProps) => JSX.Element;
export default SearchMetadata;
}
declare module '@theme/SearchBar' {
const SearchBar: () => JSX.Element;
export default SearchBar;

8
packages/docusaurus-theme-search-algolia/src/theme/SearchMetadata/index.tsx
View file

@ -8,14 +8,10 @@
import React from 'react';
import Head from '@docusaurus/Head';
import type {SearchMetadataProps} from '@theme/SearchMetadata';
import type {Props} from '@theme/SearchMetadata';
// Override default/agnostic SearchMetas to use Algolia-specific metadata
function SearchMetadata({
locale,
version,
tag,
}: SearchMetadataProps): JSX.Element {
function SearchMetadata({locale, version, tag}: Props): JSX.Element {
// Seems safe to consider here the locale is the language,
// as the existing docsearch:language filter is afaik a regular string-based filter
const language = locale;