Skip to content

fix: make documentation search usable #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
smiggleworth merged 1 commit into from
Jul 25, 2026
Merged

fix: make documentation search usable #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 40 additions & 12 deletions src/pages/docs/search.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,54 @@ export function DocsSearch() {
const [query, setQuery] = state('');
const [loading, setLoading] = state(false);
const [results, setResults] = state<readonly DocsSearchRecord[]>([]);
const [error, setError] = state(false);
let searchGeneration = 0;

Comment on lines 12 to +15
const focusInput = (element: HTMLElement | null) => {
window.setTimeout(
() =>
element
?.querySelector<HTMLInputElement>('[data-docs-search-input]')
?.focus(),
0
);
};

const openSearch = (element?: HTMLElement | null) => {
setOpen(true);
focusInput(element ?? null);
};

const runSearch = async (value: string) => {
const generation = ++searchGeneration;
setQuery(value);
setError(false);
if (!value.trim()) {
setResults([]);
setLoading(false);
return;
}
setLoading(true);
const { searchDocs } = await import('./search-index');
setResults(searchDocs(value));
setLoading(false);
try {
const { searchDocs } = await import('./search-index');
if (generation !== searchGeneration) return;
setResults(searchDocs(value));
} catch {
if (generation !== searchGeneration) return;
setResults([]);
setError(true);
} finally {
if (generation === searchGeneration) setLoading(false);
}
};

const close = () => {
searchGeneration += 1;
setOpen(false);
setQuery('');
setResults([]);
setLoading(false);
setError(false);
};
return (
<div
Expand All @@ -44,14 +75,7 @@ export function DocsSearch() {
))
) {
event.preventDefault();
setOpen(true);
window.setTimeout(
() =>
element
.querySelector<HTMLInputElement>('[data-docs-search-input]')
?.focus(),
0
);
openSearch(element);
}
if (event.key === 'Escape' && open()) close();
});
Expand All @@ -60,7 +84,9 @@ export function DocsSearch() {
<button
class="docs-search__trigger"
type="button"
onClick={() => setOpen(true)}
onClick={(event: Event) =>
openSearch((event.currentTarget as HTMLElement).parentElement)
}
aria-haspopup="dialog"
>
<SearchIcon size={16} aria-hidden="true" />
Expand Down Expand Up @@ -106,6 +132,8 @@ export function DocsSearch() {
Search page titles, component aliases, package imports, CLI
commands, and every published API symbol.
</p>
) : error() ? (
<p>Search is temporarily unavailable. Please try again.</p>
) : results().length ? (
<ul>
{results().map((result) => (
Expand Down