Skip to content
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

feature: pressing ctrl+k/cmd+k will change focus to search bar #326

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feature: pressing ctrl+k/cmd+k will change focus to search bar #326

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
20 changes: 20 additions & 0 deletions components/search.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,25 @@ import { toast } from "@/components/ui/use-toast"
interface DocsSearchProps extends React.HTMLAttributes<HTMLFormElement> {}

export function DocsSearch({ className, ...props }: DocsSearchProps) {
const inputRef = React.useRef<HTMLInputElement>(null)
// if user presses ctrl+k, focus the search input on windows and cmd+k on mac
React.useEffect(() => {
const handleKeyDown = (event: KeyboardEvent) => {
if (
(event.ctrlKey || event.metaKey) &&
event.key === "k" &&
document.activeElement !== inputRef.current
) {
event.preventDefault()
inputRef.current?.focus()
}
}
document.addEventListener("keydown", handleKeyDown)
return () => {
document.removeEventListener("keydown", handleKeyDown)
}
}, [])

function onSubmit(event: React.SyntheticEvent) {
event.preventDefault()

Expand All @@ -28,6 +47,7 @@ export function DocsSearch({ className, ...props }: DocsSearchProps) {
type="search"
placeholder="Search documentation..."
className="h-8 w-full sm:w-64 sm:pr-12"
ref={inputRef}
/>
<kbd className="pointer-events-none absolute right-1.5 top-1.5 hidden h-5 select-none items-center gap-1 rounded border bg-background px-1.5 font-mono text-[10px] font-medium text-muted-foreground opacity-100 sm:flex">
<span className="text-xs">⌘</span>K
Expand Down