Skip to content

fix: prevent Cmd+K from opening duplicate search dialogs #158

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
rsbh merged 1 commit into from
Jul 9, 2026
Merged

fix: prevent Cmd+K from opening duplicate search dialogs #158

Show file tree
Hide file tree
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
158 changes: 95 additions & 63 deletions packages/chronicle/src/components/ui/search.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,16 @@ import { keepPreviousData, useQuery } from '@tanstack/react-query';
import GithubSlugger from 'github-slugger';
import { debounce } from 'lodash-es';
import MiniSearch from 'minisearch';
import { useCallback, useEffect, useMemo, useState, type ChangeEvent } from 'react';
import {
createContext,
useCallback,
useContext,
useEffect,
useMemo,
useState,
type ChangeEvent,
type ReactNode
} from 'react';
import { useNavigate } from 'react-router';
import { MethodBadge } from '@/components/api/method-badge';
import { usePageContext } from '@/lib/page-context';
Expand Down Expand Up @@ -162,8 +171,43 @@ function buildSearchUrl(query: string, tag?: string): string {
return qs ? `/api/search?${qs}` : '/api/search';
}

export function Search({ classNames }: SearchProps) {
interface SearchContextValue {
open: boolean;
setOpen: React.Dispatch<React.SetStateAction<boolean>>;
}

const SearchContext = createContext<SearchContextValue | null>(null);

export function SearchProvider({ children }: { children: ReactNode }) {
const [open, setOpen] = useState(false);
const value = useMemo(() => ({ open, setOpen }), [open]);
return <SearchContext.Provider value={value}>{children}</SearchContext.Provider>;
}

function useSearch(): SearchContextValue {
const ctx = useContext(SearchContext);
if (!ctx) throw new Error('Search components must be used within <SearchProvider>');
return ctx;
}

export function Search({ classNames }: SearchProps) {
const { setOpen } = useSearch();

return (
<IconButton
size={3}
aria-label='Search'
title='Search (Ctrl/⌘K)'
onClick={() => setOpen(true)}
className={classNames?.trigger}
>
<MagnifyingGlassIcon width={16} height={16} />
</IconButton>
);
}

export function SearchDialog() {
const { open, setOpen } = useSearch();
const [search, setSearch] = useState('');
const [debouncedSearch, setDebouncedSearch] = useState('');
const navigate = useNavigate();
Expand Down Expand Up @@ -228,67 +272,55 @@ export function Search({ classNames }: SearchProps) {
const displayResults = deduplicateByUrl(data);

return (
<>
<IconButton
size={3}
aria-label='Search'
title='Search (Ctrl/⌘K)'
onClick={() => setOpen(true)}
className={classNames?.trigger}
>
<MagnifyingGlassIcon width={16} height={16} />
</IconButton>

<Command.Dialog open={open} onOpenChange={setOpen}>
<Command.DialogContent className={styles.dialogContent}>
<Command items={displayResults}>
<Command.Input
placeholder='Search'
leadingIcon={<MagnifyingGlassIcon width={16} height={16} />}
value={search}
onChange={onSearchChange}
className={styles.input}
/>

<Command.Content className={styles.list}>
{isLoading && displayResults.length === 0 && <Command.Empty>Loading...</Command.Empty>}
{!isLoading &&
search.length > 0 &&
displayResults.length === 0 && (
<Command.Empty>No results found.</Command.Empty>
)}
{search.length === 0 &&
displayResults.length > 0 && (
<Command.Group>
<Command.Label>Suggestions</Command.Label>
{displayResults.slice(0, 8).map((result) => (
<Command.Item
key={result.id}
value={result.id}
onClick={() => onSelect(result.url)}
className={styles.item}
>
<SearchResultItem result={result} query="" />
</Command.Item>
))}
</Command.Group>
)}
{search.length > 0 &&
displayResults.map((result) => (
<Command.Item
key={result.id}
value={result.id}
onClick={() => onSelect(result.url)}
className={styles.item}
>
<SearchResultItem result={result} query={search} />
</Command.Item>
))}
</Command.Content>
</Command>
</Command.DialogContent>
</Command.Dialog>
</>
<Command.Dialog open={open} onOpenChange={setOpen}>
<Command.DialogContent className={styles.dialogContent}>
<Command items={displayResults}>
<Command.Input
placeholder='Search'
leadingIcon={<MagnifyingGlassIcon width={16} height={16} />}
value={search}
onChange={onSearchChange}
className={styles.input}
/>

<Command.Content className={styles.list}>
{isLoading && displayResults.length === 0 && <Command.Empty>Loading...</Command.Empty>}
{!isLoading &&
search.length > 0 &&
displayResults.length === 0 && (
<Command.Empty>No results found.</Command.Empty>
)}
{search.length === 0 &&
displayResults.length > 0 && (
<Command.Group>
<Command.Label>Suggestions</Command.Label>
{displayResults.slice(0, 8).map((result) => (
<Command.Item
key={result.id}
value={result.id}
onClick={() => onSelect(result.url)}
className={styles.item}
>
<SearchResultItem result={result} query="" />
</Command.Item>
))}
</Command.Group>
)}
{search.length > 0 &&
displayResults.map((result) => (
<Command.Item
key={result.id}
value={result.id}
onClick={() => onSelect(result.url)}
className={styles.item}
>
<SearchResultItem result={result} query={search} />
</Command.Item>
))}
</Command.Content>
</Command>
</Command.DialogContent>
</Command.Dialog>
);
}

Expand Down
28 changes: 16 additions & 12 deletions packages/chronicle/src/server/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { ThemeProvider, Skeleton, Flex } from '@raystack/apsara';
import { lazy, Suspense } from 'react';
import { Navigate, useLocation } from 'react-router';
import { AnalyticsProvider } from '@/components/analytics/AnalyticsProvider';
import { SearchDialog, SearchProvider } from '@/components/ui/search';
import { usePageContext } from '@/lib/page-context';
import { resolveRoute, RouteType } from '@/lib/route-resolver';
import type { ChronicleConfig } from '@/types';
Expand Down Expand Up @@ -38,18 +39,21 @@ export function App() {
forcedTheme={themeConfig.forcedTheme}
>
<AnalyticsProvider config={config.analytics ?? { enabled: false }} appName={config.site.title}>
<RootHead config={config} />
<Suspense fallback={<PageFallback />}>
{isApi ? (
<ApiLayout>
<ApiPage slug={apiSlug} />
</ApiLayout>
) : (
<DocsLayout hideSidebar={isLanding}>
{isLanding ? <LandingPage /> : <DocsPage slug={docsSlug} />}
</DocsLayout>
)}
</Suspense>
<SearchProvider>
<RootHead config={config} />
{config.search?.enabled && <SearchDialog />}
<Suspense fallback={<PageFallback />}>
{isApi ? (
<ApiLayout>
<ApiPage slug={apiSlug} />
</ApiLayout>
) : (
<DocsLayout hideSidebar={isLanding}>
{isLanding ? <LandingPage /> : <DocsPage slug={docsSlug} />}
</DocsLayout>
)}
</Suspense>
</SearchProvider>
</AnalyticsProvider>
</ThemeProvider>
);
Expand Down
4 changes: 0 additions & 4 deletions packages/chronicle/src/themes/paper/Layout.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,3 @@
.contentFull {
margin-left: 0;
}

.hiddenTrigger {
display: none;
}
2 changes: 0 additions & 2 deletions packages/chronicle/src/themes/paper/Layout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import { useLocation, useNavigate } from 'react-router';
import { getLandingEntries } from '@/lib/config';
import { getActiveContentDir } from '@/lib/navigation';
import { usePageContext } from '@/lib/page-context';
import { Search } from '@/components/ui/search';
import type { ThemeLayoutProps } from '@/types';
import { ChapterNav } from './ChapterNav';
import styles from './Layout.module.css';
Expand Down Expand Up @@ -83,7 +82,6 @@ function LayoutInner({
</aside>
) : null}
<div className={cx(styles.content, classNames?.content, { [styles.contentFull]: !showSidebar })}>
{config.search?.enabled && <Search classNames={{ trigger: styles.hiddenTrigger }} />}
{children}
</div>
</Flex>
Expand Down
Loading