fix(docs): Algolia + Search page (#1349)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
2e6622ec5d
commit
e8cd03640d
5 files changed
+582
No files matched your search
@@ -21,6 +21,7 @@
|
|||||||
"@docusaurus/preset-classic": "2.0.0-beta.17",
|
"@docusaurus/preset-classic": "2.0.0-beta.17",
|
||||||
"@docusaurus/remark-plugin-npm2yarn": "^2.0.0-beta.18",
|
"@docusaurus/remark-plugin-npm2yarn": "^2.0.0-beta.18",
|
||||||
"@svgr/webpack": "6.2.1",
|
"@svgr/webpack": "6.2.1",
|
||||||
|
"algoliasearch-helper": "^3.8.2",
|
||||||
"clsx": "^1.1.1",
|
"clsx": "^1.1.1",
|
||||||
"docusaurus2-dotenv": "^1.4.0",
|
"docusaurus2-dotenv": "^1.4.0",
|
||||||
"file-loader": "^6.2.0",
|
"file-loader": "^6.2.0",
|
||||||
|
|||||||
+8
@@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* 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.
|
||||||
|
*/
|
||||||
|
/// <reference types="react" />
|
||||||
|
export default function SearchPage(): JSX.Element;
|
||||||
@@ -0,0 +1,447 @@
|
|||||||
|
/**
|
||||||
|
* 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.
|
||||||
|
*/
|
||||||
|
/* eslint-disable jsx-a11y/no-autofocus */
|
||||||
|
import React, {useEffect, useReducer, useRef, useState} from 'react';
|
||||||
|
import Translate, {translate} from '@docusaurus/Translate';
|
||||||
|
import {
|
||||||
|
isRegexpStringMatch,
|
||||||
|
useDynamicCallback,
|
||||||
|
usePluralForm,
|
||||||
|
useSearchPage,
|
||||||
|
useTitleFormatter,
|
||||||
|
} from '@docusaurus/theme-common';
|
||||||
|
|
||||||
|
import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
|
||||||
|
import Head from '@docusaurus/Head';
|
||||||
|
import Layout from '@theme/Layout';
|
||||||
|
import Link from '@docusaurus/Link';
|
||||||
|
import algoliaSearch from 'algoliasearch/lite';
|
||||||
|
import algoliaSearchHelper from 'algoliasearch-helper';
|
||||||
|
import clsx from 'clsx';
|
||||||
|
import styles from './styles.module.css';
|
||||||
|
import {useAllDocsData} from '@docusaurus/plugin-content-docs/client';
|
||||||
|
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
||||||
|
|
||||||
|
// Very simple pluralization: probably good enough for now
|
||||||
|
function useDocumentsFoundPlural() {
|
||||||
|
const {selectMessage} = usePluralForm();
|
||||||
|
return (count) =>
|
||||||
|
selectMessage(
|
||||||
|
count,
|
||||||
|
translate(
|
||||||
|
{
|
||||||
|
id: 'theme.SearchPage.documentsFound.plurals',
|
||||||
|
description:
|
||||||
|
'Pluralized label for "{count} documents found". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',
|
||||||
|
message: 'One document found|{count} documents found',
|
||||||
|
},
|
||||||
|
{count},
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
function useDocsSearchVersionsHelpers() {
|
||||||
|
const allDocsData = useAllDocsData();
|
||||||
|
// State of the version select menus / algolia facet filters
|
||||||
|
// docsPluginId -> versionName map
|
||||||
|
const [searchVersions, setSearchVersions] = useState(() =>
|
||||||
|
Object.entries(allDocsData).reduce(
|
||||||
|
(acc, [pluginId, pluginData]) => ({
|
||||||
|
...acc,
|
||||||
|
[pluginId]: pluginData.versions[0].name,
|
||||||
|
}),
|
||||||
|
{},
|
||||||
|
),
|
||||||
|
);
|
||||||
|
// Set the value of a single select menu
|
||||||
|
const setSearchVersion = (pluginId, searchVersion) =>
|
||||||
|
setSearchVersions((s) => ({...s, [pluginId]: searchVersion}));
|
||||||
|
const versioningEnabled = Object.values(allDocsData).some(
|
||||||
|
(docsData) => docsData.versions.length > 1,
|
||||||
|
);
|
||||||
|
return {
|
||||||
|
allDocsData,
|
||||||
|
versioningEnabled,
|
||||||
|
searchVersions,
|
||||||
|
setSearchVersion,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
// We want to display one select per versioned docs plugin instance
|
||||||
|
function SearchVersionSelectList({docsSearchVersionsHelpers}) {
|
||||||
|
const versionedPluginEntries = Object.entries(
|
||||||
|
docsSearchVersionsHelpers.allDocsData,
|
||||||
|
)
|
||||||
|
// Do not show a version select for unversioned docs plugin instances
|
||||||
|
.filter(([, docsData]) => docsData.versions.length > 1);
|
||||||
|
return (
|
||||||
|
<div
|
||||||
|
className={clsx(
|
||||||
|
'col',
|
||||||
|
'col--3',
|
||||||
|
'padding-left--none',
|
||||||
|
styles.searchVersionColumn,
|
||||||
|
)}>
|
||||||
|
{versionedPluginEntries.map(([pluginId, docsData]) => {
|
||||||
|
const labelPrefix =
|
||||||
|
versionedPluginEntries.length > 1 ? `${pluginId}: ` : '';
|
||||||
|
return (
|
||||||
|
<select
|
||||||
|
key={pluginId}
|
||||||
|
onChange={(e) =>
|
||||||
|
docsSearchVersionsHelpers.setSearchVersion(
|
||||||
|
pluginId,
|
||||||
|
e.target.value,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
defaultValue={docsSearchVersionsHelpers.searchVersions[pluginId]}
|
||||||
|
className={styles.searchVersionInput}>
|
||||||
|
{docsData.versions.map((version, i) => (
|
||||||
|
<option
|
||||||
|
key={i}
|
||||||
|
label={`${labelPrefix}${version.label}`}
|
||||||
|
value={version.name}
|
||||||
|
/>
|
||||||
|
))}
|
||||||
|
</select>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
export default function SearchPage() {
|
||||||
|
const {
|
||||||
|
siteConfig: {themeConfig},
|
||||||
|
i18n: {currentLocale},
|
||||||
|
} = useDocusaurusContext();
|
||||||
|
const {
|
||||||
|
algolia: {appId, apiKey, indexName, externalUrlRegex},
|
||||||
|
} = themeConfig;
|
||||||
|
const documentsFoundPlural = useDocumentsFoundPlural();
|
||||||
|
const docsSearchVersionsHelpers = useDocsSearchVersionsHelpers();
|
||||||
|
const {searchQuery, setSearchQuery} = useSearchPage();
|
||||||
|
const initialSearchResultState = {
|
||||||
|
items: [],
|
||||||
|
query: null,
|
||||||
|
totalResults: null,
|
||||||
|
totalPages: null,
|
||||||
|
lastPage: null,
|
||||||
|
hasMore: null,
|
||||||
|
loading: null,
|
||||||
|
};
|
||||||
|
const [searchResultState, searchResultStateDispatcher] = useReducer(
|
||||||
|
(prevState, data) => {
|
||||||
|
switch (data.type) {
|
||||||
|
case 'reset': {
|
||||||
|
return initialSearchResultState;
|
||||||
|
}
|
||||||
|
case 'loading': {
|
||||||
|
return {...prevState, loading: true};
|
||||||
|
}
|
||||||
|
case 'update': {
|
||||||
|
if (searchQuery !== data.value.query) {
|
||||||
|
return prevState;
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
...data.value,
|
||||||
|
items:
|
||||||
|
data.value.lastPage === 0
|
||||||
|
? data.value.items
|
||||||
|
: prevState.items.concat(data.value.items),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
case 'advance': {
|
||||||
|
const hasMore = prevState.totalPages > prevState.lastPage + 1;
|
||||||
|
return {
|
||||||
|
...prevState,
|
||||||
|
lastPage: hasMore ? prevState.lastPage + 1 : prevState.lastPage,
|
||||||
|
hasMore,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return prevState;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
initialSearchResultState,
|
||||||
|
);
|
||||||
|
const algoliaClient = algoliaSearch(appId, apiKey);
|
||||||
|
const algoliaHelper = algoliaSearchHelper(algoliaClient, indexName, {
|
||||||
|
hitsPerPage: 15,
|
||||||
|
advancedSyntax: true,
|
||||||
|
disjunctiveFacets: ['language', 'docusaurus_tag'],
|
||||||
|
});
|
||||||
|
algoliaHelper.on(
|
||||||
|
'result',
|
||||||
|
({results: {query, hits, page, nbHits, nbPages}}) => {
|
||||||
|
if (query === '' || !(hits instanceof Array)) {
|
||||||
|
searchResultStateDispatcher({type: 'reset'});
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const sanitizeValue = (value) =>
|
||||||
|
value.replace(
|
||||||
|
/algolia-docsearch-suggestion--highlight/g,
|
||||||
|
'search-result-match',
|
||||||
|
);
|
||||||
|
const items = hits.map(
|
||||||
|
({
|
||||||
|
url,
|
||||||
|
_highlightResult: {hierarchy},
|
||||||
|
_snippetResult: snippet = {},
|
||||||
|
}) => {
|
||||||
|
const parsedURL = new URL(url);
|
||||||
|
const titles = Object.keys(hierarchy).map((key) =>
|
||||||
|
sanitizeValue(hierarchy[key].value),
|
||||||
|
);
|
||||||
|
return {
|
||||||
|
title: titles.pop(),
|
||||||
|
url: isRegexpStringMatch(externalUrlRegex, parsedURL.href)
|
||||||
|
? parsedURL.href
|
||||||
|
: parsedURL.pathname + parsedURL.hash,
|
||||||
|
summary: snippet.content
|
||||||
|
? `${sanitizeValue(snippet.content.value)}...`
|
||||||
|
: '',
|
||||||
|
breadcrumbs: titles,
|
||||||
|
};
|
||||||
|
},
|
||||||
|
);
|
||||||
|
searchResultStateDispatcher({
|
||||||
|
type: 'update',
|
||||||
|
value: {
|
||||||
|
items,
|
||||||
|
query,
|
||||||
|
totalResults: nbHits,
|
||||||
|
totalPages: nbPages,
|
||||||
|
lastPage: page,
|
||||||
|
hasMore: nbPages > page + 1,
|
||||||
|
loading: false,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
},
|
||||||
|
);
|
||||||
|
const [loaderRef, setLoaderRef] = useState(null);
|
||||||
|
const prevY = useRef(0);
|
||||||
|
const observer = useRef(
|
||||||
|
ExecutionEnvironment.canUseDOM &&
|
||||||
|
new IntersectionObserver(
|
||||||
|
(entries) => {
|
||||||
|
const {
|
||||||
|
isIntersecting,
|
||||||
|
boundingClientRect: {y: currentY},
|
||||||
|
} = entries[0];
|
||||||
|
if (isIntersecting && prevY.current > currentY) {
|
||||||
|
searchResultStateDispatcher({type: 'advance'});
|
||||||
|
}
|
||||||
|
prevY.current = currentY;
|
||||||
|
},
|
||||||
|
{threshold: 1},
|
||||||
|
),
|
||||||
|
);
|
||||||
|
const getTitle = () =>
|
||||||
|
searchQuery
|
||||||
|
? translate(
|
||||||
|
{
|
||||||
|
id: 'theme.SearchPage.existingResultsTitle',
|
||||||
|
message: 'Search results for "{query}"',
|
||||||
|
description: 'The search page title for non-empty query',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
query: searchQuery,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
: translate({
|
||||||
|
id: 'theme.SearchPage.emptyResultsTitle',
|
||||||
|
message: 'Search the documentation',
|
||||||
|
description: 'The search page title for empty query',
|
||||||
|
});
|
||||||
|
const makeSearch = useDynamicCallback((page = 0) => {
|
||||||
|
algoliaHelper.setQuery(searchQuery).setPage(page).search();
|
||||||
|
});
|
||||||
|
useEffect(() => {
|
||||||
|
if (!loaderRef) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
const currentObserver = observer.current;
|
||||||
|
if (currentObserver) {
|
||||||
|
currentObserver.observe(loaderRef);
|
||||||
|
return () => currentObserver.unobserve(loaderRef);
|
||||||
|
}
|
||||||
|
return () => true;
|
||||||
|
}, [loaderRef]);
|
||||||
|
useEffect(() => {
|
||||||
|
searchResultStateDispatcher({type: 'reset'});
|
||||||
|
if (searchQuery) {
|
||||||
|
searchResultStateDispatcher({type: 'loading'});
|
||||||
|
setTimeout(() => {
|
||||||
|
makeSearch();
|
||||||
|
}, 300);
|
||||||
|
}
|
||||||
|
}, [searchQuery, docsSearchVersionsHelpers.searchVersions, makeSearch]);
|
||||||
|
useEffect(() => {
|
||||||
|
if (!searchResultState.lastPage || searchResultState.lastPage === 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
makeSearch(searchResultState.lastPage);
|
||||||
|
}, [makeSearch, searchResultState.lastPage]);
|
||||||
|
return (
|
||||||
|
<Layout wrapperClassName="search-page-wrapper">
|
||||||
|
<Head>
|
||||||
|
<title>{useTitleFormatter(getTitle())}</title>
|
||||||
|
{/*
|
||||||
|
We should not index search pages
|
||||||
|
See https://github.com/facebook/docusaurus/pull/3233
|
||||||
|
*/}
|
||||||
|
<meta property="robots" content="noindex, follow" />
|
||||||
|
</Head>
|
||||||
|
|
||||||
|
<div className="container margin-vert--lg">
|
||||||
|
<h1>{getTitle()}</h1>
|
||||||
|
|
||||||
|
<form className="row" onSubmit={(e) => e.preventDefault()}>
|
||||||
|
<div
|
||||||
|
className={clsx('col', styles.searchQueryColumn, {
|
||||||
|
'col--9': docsSearchVersionsHelpers.versioningEnabled,
|
||||||
|
'col--12': !docsSearchVersionsHelpers.versioningEnabled,
|
||||||
|
})}>
|
||||||
|
<input
|
||||||
|
type="search"
|
||||||
|
name="q"
|
||||||
|
className={styles.searchQueryInput}
|
||||||
|
placeholder={translate({
|
||||||
|
id: 'theme.SearchPage.inputPlaceholder',
|
||||||
|
message: 'Type your search here',
|
||||||
|
description: 'The placeholder for search page input',
|
||||||
|
})}
|
||||||
|
aria-label={translate({
|
||||||
|
id: 'theme.SearchPage.inputLabel',
|
||||||
|
message: 'Search',
|
||||||
|
description: 'The ARIA label for search page input',
|
||||||
|
})}
|
||||||
|
onChange={(e) => setSearchQuery(e.target.value)}
|
||||||
|
value={searchQuery}
|
||||||
|
autoComplete="off"
|
||||||
|
autoFocus
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{docsSearchVersionsHelpers.versioningEnabled && (
|
||||||
|
<SearchVersionSelectList
|
||||||
|
docsSearchVersionsHelpers={docsSearchVersionsHelpers}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
</form>
|
||||||
|
|
||||||
|
<div className="row">
|
||||||
|
<div className={clsx('col', 'col--8', styles.searchResultsColumn)}>
|
||||||
|
{!!searchResultState.totalResults &&
|
||||||
|
documentsFoundPlural(searchResultState.totalResults)}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div
|
||||||
|
className={clsx(
|
||||||
|
'col',
|
||||||
|
'col--4',
|
||||||
|
'text--right',
|
||||||
|
styles.searchLogoColumn,
|
||||||
|
)}>
|
||||||
|
<a
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
href="https://www.algolia.com/"
|
||||||
|
aria-label={translate({
|
||||||
|
id: 'theme.SearchPage.algoliaLabel',
|
||||||
|
message: 'Search by Algolia',
|
||||||
|
description: 'The ARIA label for Algolia mention',
|
||||||
|
})}>
|
||||||
|
<svg viewBox="0 0 168 24" className={styles.algoliaLogo}>
|
||||||
|
<g fill="none">
|
||||||
|
<path
|
||||||
|
className={styles.algoliaLogoPathFill}
|
||||||
|
d="M120.925 18.804c-4.386.02-4.386-3.54-4.386-4.106l-.007-13.336 2.675-.424v13.254c0 .322 0 2.358 1.718 2.364v2.248zm-10.846-2.18c.821 0 1.43-.047 1.855-.129v-2.719a6.334 6.334 0 0 0-1.574-.199 5.7 5.7 0 0 0-.897.069 2.699 2.699 0 0 0-.814.24c-.24.116-.439.28-.582.491-.15.212-.219.335-.219.656 0 .628.219.991.616 1.23s.938.362 1.615.362zm-.233-9.7c.883 0 1.629.109 2.231.328.602.218 1.088.525 1.444.915.363.396.609.922.76 1.483.157.56.232 1.175.232 1.85v6.874a32.5 32.5 0 0 1-1.868.314c-.834.123-1.772.185-2.813.185-.69 0-1.327-.069-1.895-.198a4.001 4.001 0 0 1-1.471-.636 3.085 3.085 0 0 1-.951-1.134c-.226-.465-.343-1.12-.343-1.803 0-.656.13-1.073.384-1.525a3.24 3.24 0 0 1 1.047-1.106c.445-.287.95-.492 1.532-.615a8.8 8.8 0 0 1 1.82-.185 8.404 8.404 0 0 1 1.972.24v-.438c0-.307-.035-.6-.11-.874a1.88 1.88 0 0 0-.384-.73 1.784 1.784 0 0 0-.724-.493 3.164 3.164 0 0 0-1.143-.205c-.616 0-1.177.075-1.69.164a7.735 7.735 0 0 0-1.26.307l-.321-2.192c.335-.117.834-.233 1.478-.349a10.98 10.98 0 0 1 2.073-.178zm52.842 9.626c.822 0 1.43-.048 1.854-.13V13.7a6.347 6.347 0 0 0-1.574-.199c-.294 0-.595.021-.896.069a2.7 2.7 0 0 0-.814.24 1.46 1.46 0 0 0-.582.491c-.15.212-.218.335-.218.656 0 .628.218.991.615 1.23.404.245.938.362 1.615.362zm-.226-9.694c.883 0 1.629.108 2.231.327.602.219 1.088.526 1.444.915.355.39.609.923.759 1.483a6.8 6.8 0 0 1 .233 1.852v6.873c-.41.088-1.034.19-1.868.314-.834.123-1.772.184-2.813.184-.69 0-1.327-.068-1.895-.198a4.001 4.001 0 0 1-1.471-.635 3.085 3.085 0 0 1-.951-1.134c-.226-.465-.343-1.12-.343-1.804 0-.656.13-1.073.384-1.524.26-.45.608-.82 1.047-1.107.445-.286.95-.491 1.532-.614a8.803 8.803 0 0 1 2.751-.13c.329.034.671.096 1.04.185v-.437a3.3 3.3 0 0 0-.109-.875 1.873 1.873 0 0 0-.384-.731 1.784 1.784 0 0 0-.724-.492 3.165 3.165 0 0 0-1.143-.205c-.616 0-1.177.075-1.69.164a7.75 7.75 0 0 0-1.26.307l-.321-2.193c.335-.116.834-.232 1.478-.348a11.633 11.633 0 0 1 2.073-.177zm-8.034-1.271a1.626 1.626 0 0 1-1.628-1.62c0-.895.725-1.62 1.628-1.62.904 0 1.63.725 1.63 1.62 0 .895-.733 1.62-1.63 1.62zm1.348 13.22h-2.689V7.27l2.69-.423v11.956zm-4.714 0c-4.386.02-4.386-3.54-4.386-4.107l-.008-13.336 2.676-.424v13.254c0 .322 0 2.358 1.718 2.364v2.248zm-8.698-5.903c0-1.156-.253-2.119-.746-2.788-.493-.677-1.183-1.01-2.067-1.01-.882 0-1.574.333-2.065 1.01-.493.676-.733 1.632-.733 2.788 0 1.168.246 1.953.74 2.63.492.683 1.183 1.018 2.066 1.018.882 0 1.574-.342 2.067-1.019.492-.683.738-1.46.738-2.63zm2.737-.007c0 .902-.13 1.584-.397 2.33a5.52 5.52 0 0 1-1.128 1.906 4.986 4.986 0 0 1-1.752 1.223c-.685.286-1.739.45-2.265.45-.528-.006-1.574-.157-2.252-.45a5.096 5.096 0 0 1-1.744-1.223c-.487-.527-.863-1.162-1.137-1.906a6.345 6.345 0 0 1-.41-2.33c0-.902.123-1.77.397-2.508a5.554 5.554 0 0 1 1.15-1.892 5.133 5.133 0 0 1 1.75-1.216c.679-.287 1.425-.423 2.232-.423.808 0 1.553.142 2.237.423a4.88 4.88 0 0 1 1.753 1.216 5.644 5.644 0 0 1 1.135 1.892c.287.738.431 1.606.431 2.508zm-20.138 0c0 1.12.246 2.363.738 2.882.493.52 1.13.78 1.91.78.424 0 .828-.062 1.204-.178.377-.116.677-.253.917-.417V9.33a10.476 10.476 0 0 0-1.766-.226c-.971-.028-1.71.37-2.23 1.004-.513.636-.773 1.75-.773 2.788zm7.438 5.274c0 1.824-.466 3.156-1.404 4.004-.936.846-2.367 1.27-4.296 1.27-.705 0-2.17-.137-3.34-.396l.431-2.118c.98.205 2.272.26 2.95.26 1.074 0 1.84-.219 2.299-.656.459-.437.684-1.086.684-1.948v-.437a8.07 8.07 0 0 1-1.047.397c-.43.13-.93.198-1.492.198-.739 0-1.41-.116-2.018-.349a4.206 4.206 0 0 1-1.567-1.025c-.431-.45-.774-1.017-1.013-1.694-.24-.677-.363-1.885-.363-2.773 0-.834.13-1.88.384-2.577.26-.696.629-1.298 1.129-1.796.493-.498 1.095-.881 1.8-1.162a6.605 6.605 0 0 1 2.428-.457c.87 0 1.67.109 2.45.24.78.129 1.444.265 1.985.415V18.17zM6.972 6.677v1.627c-.712-.446-1.52-.67-2.425-.67-.585 0-1.045.13-1.38.391a1.24 1.24 0 0 0-.502 1.03c0 .425.164.765.494 1.02.33.256.835.532 1.516.83.447.192.795.356 1.045.495.25.138.537.332.862.582.324.25.563.548.718.894.154.345.23.741.23 1.188 0 .947-.334 1.691-1.004 2.234-.67.542-1.537.814-2.601.814-1.18 0-2.16-.229-2.936-.686v-1.708c.84.628 1.814.942 2.92.942.585 0 1.048-.136 1.388-.407.34-.271.51-.646.51-1.125 0-.287-.1-.55-.302-.79-.203-.24-.42-.42-.655-.542-.234-.123-.585-.29-1.053-.503a61.27 61.27 0 0 1-.582-.271 13.67 13.67 0 0 1-.55-.287 4.275 4.275 0 0 1-.567-.351 6.92 6.92 0 0 1-.455-.4c-.18-.17-.31-.34-.39-.51-.08-.17-.155-.37-.224-.598a2.553 2.553 0 0 1-.104-.742c0-.915.333-1.638.998-2.17.664-.532 1.523-.798 2.576-.798.968 0 1.793.17 2.473.51zm7.468 5.696v-.287c-.022-.607-.187-1.088-.495-1.444-.309-.357-.75-.535-1.324-.535-.532 0-.99.194-1.373.583-.382.388-.622.949-.717 1.683h3.909zm1.005 2.792v1.404c-.596.34-1.383.51-2.362.51-1.255 0-2.255-.377-3-1.132-.744-.755-1.116-1.744-1.116-2.968 0-1.297.34-2.316 1.021-3.055.68-.74 1.548-1.11 2.6-1.11 1.033 0 1.852.323 2.458.966.606.644.91 1.572.91 2.784 0 .33-.033.676-.096 1.038h-5.314c.107.702.405 1.239.894 1.611.49.372 1.106.558 1.85.558.862 0 1.58-.202 2.155-.606zm6.605-1.77h-1.212c-.596 0-1.045.116-1.349.35-.303.234-.454.532-.454.894 0 .372.11Line truncated
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
fill="#5468FF"
|
||||||
|
d="M78.988.938h16.594a2.968 2.968 0 0 1 2.966 2.966V20.5a2.967 2.967 0 0 1-2.966 2.964H78.988a2.967 2.967 0 0 1-2.966-2.964V3.897A2.961 2.961 0 0 1 78.988.938z"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
fill="white"
|
||||||
|
d="M89.632 5.967v-.772a.978.978 0 0 0-.978-.977h-2.28a.978.978 0 0 0-.978.977v.793c0 .088.082.15.171.13a7.127 7.127 0 0 1 1.984-.28c.65 0 1.295.088 1.917.259.082.02.164-.04.164-.13m-6.248 1.01l-.39-.389a.977.977 0 0 0-1.382 0l-.465.465a.973.973 0 0 0 0 1.38l.383.383c.062.061.15.047.205-.014.226-.307.472-.601.746-.874.281-.28.568-.526.883-.751.068-.042.075-.137.02-.2m4.16 2.453v3.341c0 .096.104.165.192.117l2.97-1.537c.068-.034.089-.117.055-.184a3.695 3.695 0 0 0-3.08-1.866c-.068 0-.136.054-.136.13m0 8.048a4.489 4.489 0 0 1-4.49-4.482 4.488 4.488 0 0 1 4.49-4.482 4.488 4.488 0 0 1 4.489 4.482 4.484 4.484 0 0 1-4.49 4.482m0-10.85a6.363 6.363 0 1 0 0 12.729 6.37 6.37 0 0 0 6.372-6.368 6.358 6.358 0 0 0-6.371-6.36"
|
||||||
|
/>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{searchResultState.items.length > 0 ? (
|
||||||
|
<main>
|
||||||
|
{searchResultState.items.map(
|
||||||
|
({title, url, summary, breadcrumbs}, i) => (
|
||||||
|
<article key={i} className={styles.searchResultItem}>
|
||||||
|
<h2 className={styles.searchResultItemHeading}>
|
||||||
|
<Link to={url} dangerouslySetInnerHTML={{__html: title}} />
|
||||||
|
</h2>
|
||||||
|
|
||||||
|
{breadcrumbs.length > 0 && (
|
||||||
|
<nav aria-label="breadcrumbs">
|
||||||
|
<ul
|
||||||
|
className={clsx(
|
||||||
|
'breadcrumbs',
|
||||||
|
styles.searchResultItemPath,
|
||||||
|
)}>
|
||||||
|
{breadcrumbs.map((html, index) => (
|
||||||
|
<li
|
||||||
|
key={index}
|
||||||
|
className="breadcrumbs__item"
|
||||||
|
// Developer provided the HTML, so assume it's safe.
|
||||||
|
// eslint-disable-next-line react/no-danger
|
||||||
|
dangerouslySetInnerHTML={{__html: html}}
|
||||||
|
/>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{summary && (
|
||||||
|
<p
|
||||||
|
className={styles.searchResultItemSummary}
|
||||||
|
// Developer provided the HTML, so assume it's safe.
|
||||||
|
// eslint-disable-next-line react/no-danger
|
||||||
|
dangerouslySetInnerHTML={{__html: summary}}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
</article>
|
||||||
|
),
|
||||||
|
)}
|
||||||
|
</main>
|
||||||
|
) : (
|
||||||
|
[
|
||||||
|
searchQuery && !searchResultState.loading && (
|
||||||
|
<p key="no-results">
|
||||||
|
<Translate
|
||||||
|
id="theme.SearchPage.noResultsText"
|
||||||
|
description="The paragraph for empty search result">
|
||||||
|
No results were found
|
||||||
|
</Translate>
|
||||||
|
</p>
|
||||||
|
),
|
||||||
|
!!searchResultState.loading && (
|
||||||
|
<div key="spinner" className={styles.loadingSpinner} />
|
||||||
|
),
|
||||||
|
]
|
||||||
|
)}
|
||||||
|
|
||||||
|
{searchResultState.hasMore && (
|
||||||
|
<div className={styles.loader} ref={setLoaderRef}>
|
||||||
|
<Translate
|
||||||
|
id="theme.SearchPage.fetchingNewResults"
|
||||||
|
description="The paragraph for fetching new search results">
|
||||||
|
Fetching new results...
|
||||||
|
</Translate>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</Layout>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,119 @@
|
|||||||
|
/**
|
||||||
|
* 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
.searchQueryInput,
|
||||||
|
.searchVersionInput {
|
||||||
|
border-radius: var(--ifm-global-radius);
|
||||||
|
border: 2px solid var(--ifm-toc-border-color);
|
||||||
|
font: var(--ifm-font-size-base) var(--ifm-font-family-base);
|
||||||
|
padding: 0.8rem;
|
||||||
|
width: 100%;
|
||||||
|
background: var(--docsearch-searchbox-focus-background);
|
||||||
|
color: var(--docsearch-text-color);
|
||||||
|
margin-bottom: 0.5rem;
|
||||||
|
transition: border var(--ifm-transition-fast) ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchQueryInput:focus,
|
||||||
|
.searchVersionInput:focus {
|
||||||
|
border-color: var(--docsearch-primary-color);
|
||||||
|
outline: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchQueryInput::placeholder {
|
||||||
|
color: var(--docsearch-muted-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchResultsColumn {
|
||||||
|
font-size: 0.9rem;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.algoliaLogo {
|
||||||
|
max-width: 150px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.algoliaLogoPathFill {
|
||||||
|
fill: var(--ifm-font-color-base);
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchResultItem {
|
||||||
|
padding: 1rem 0;
|
||||||
|
border-bottom: 1px solid var(--ifm-toc-border-color);
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchResultItemHeading {
|
||||||
|
font-weight: 400;
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchResultItemPath {
|
||||||
|
font-size: 0.8rem;
|
||||||
|
color: var(--ifm-color-content-secondary);
|
||||||
|
--ifm-breadcrumb-separator-size-multiplier: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchResultItemSummary {
|
||||||
|
margin: 0.5rem 0 0;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media only screen and (max-width: 996px) {
|
||||||
|
.searchQueryColumn {
|
||||||
|
max-width: 60% !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchVersionColumn {
|
||||||
|
max-width: 40% !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchResultsColumn {
|
||||||
|
max-width: 60% !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchLogoColumn {
|
||||||
|
max-width: 40% !important;
|
||||||
|
padding-left: 0 !important;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media screen and (max-width: 576px) {
|
||||||
|
.searchQueryColumn {
|
||||||
|
max-width: 100% !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.searchVersionColumn {
|
||||||
|
max-width: 100% !important;
|
||||||
|
padding-left: var(--ifm-spacing-horizontal) !important;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.loadingSpinner {
|
||||||
|
width: 3rem;
|
||||||
|
height: 3rem;
|
||||||
|
border: 0.4em solid #eee;
|
||||||
|
border-top-color: var(--ifm-color-primary);
|
||||||
|
border-radius: 50%;
|
||||||
|
animation: loading-spin 1s linear infinite;
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes loading-spin {
|
||||||
|
100% {
|
||||||
|
transform: rotate(360deg);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.loader {
|
||||||
|
margin-top: 2rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
:global(.search-result-match) {
|
||||||
|
color: var(--docsearch-hit-color);
|
||||||
|
background: rgb(255 215 142 / 25%);
|
||||||
|
padding: 0.09em 0;
|
||||||
|
}
|
||||||
@@ -2412,6 +2412,13 @@ algoliasearch-helper@^3.7.0:
|
|||||||
dependencies:
|
dependencies:
|
||||||
"@algolia/events" "^4.0.1"
|
"@algolia/events" "^4.0.1"
|
||||||
|
|
||||||
|
algoliasearch-helper@^3.8.2:
|
||||||
|
version "3.8.2"
|
||||||
|
resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.8.2.tgz#35726dc6d211f49dbab0bf6d37b4658165539523"
|
||||||
|
integrity sha512-AXxiF0zT9oYwl8ZBgU/eRXvfYhz7cBA5YrLPlw9inZHdaYF0QEya/f1Zp1mPYMXc1v6VkHwBq4pk6/vayBLICg==
|
||||||
|
dependencies:
|
||||||
|
"@algolia/events" "^4.0.1"
|
||||||
|
|
||||||
algoliasearch@^4.0.0:
|
algoliasearch@^4.0.0:
|
||||||
version "4.12.1"
|
version "4.12.1"
|
||||||
resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-4.12.1.tgz#574a2c5424c4b6681c026928fb810be2d2ec3924"
|
resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-4.12.1.tgz#574a2c5424c4b6681c026928fb810be2d2ec3924"
|
||||||
|
|||||||
Reference in new issue
Block a user