-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add command palette and global keyboard shortcuts #19
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.
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
Merged
Changes from 3 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
796b329
feat: add command palette and global keyboard shortcuts
Medformatik 71b9b0b
fix: GitHub workflow issues
Medformatik e2a59e1
fix: address Copilot review feedback on command palette
Medformatik 3d93825
fix: address Copilot re-review feedback
Medformatik 0d14934
fix: address Copilot re-review feedback (round 3)
Medformatik c703b4f
fix: address Copilot re-review feedback (round 4)
Medformatik a70aa5e
fix: address Copilot re-review feedback (round 5)
Medformatik 9dd8cc2
fix: address local review feedback on command palette
Medformatik 2331c40
fix: address review round 6 on command palette
Medformatik 4896194
fix: address review round 7 on command palette
Medformatik a89ccf0
fix: address review round 8 on command palette
Medformatik File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ on: | |
|
|
||
| permissions: | ||
| pull-requests: read | ||
| statuses: write | ||
|
|
||
| jobs: | ||
| validate: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
211 changes: 211 additions & 0 deletions
211
apps/web/src/components/command-palette/CommandPalette.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,211 @@ | ||
| "use client"; | ||
|
|
||
| import Dialog from "@mui/material/Dialog"; | ||
| import { useTheme } from "@mui/material/styles"; | ||
| import Typography from "@mui/material/Typography"; | ||
| import useMediaQuery from "@mui/material/useMediaQuery"; | ||
| import { | ||
| type Command, | ||
| getPlatform, | ||
| SCORE_CUTOFF, | ||
| scoreCommand, | ||
| useCommandPaletteStore, | ||
| useSearchStore, | ||
| } from "@openmapx/core"; | ||
| import { useTranslations } from "next-intl"; | ||
| import { useCallback, useEffect, useMemo, useRef, useState } from "react"; | ||
| import { CommandPaletteFooter } from "./CommandPaletteFooter"; | ||
| import { CommandPaletteInput } from "./CommandPaletteInput"; | ||
| import { CommandPaletteList, getDefaultCommandPaletteRows } from "./CommandPaletteList"; | ||
| import { COMMAND_PALETTE_LISTBOX_ID, SEARCH_INPUT_ID } from "./constants"; | ||
| import { useCommandSources } from "./useCommandSources"; | ||
|
|
||
| interface Props { | ||
| /** Called when the user runs the "Show keyboard shortcuts" command. */ | ||
| onOpenShortcuts: () => void; | ||
| } | ||
|
|
||
| const SEARCH_FALLBACK_ID = "search.fallback"; | ||
|
|
||
| export function CommandPalette({ onOpenShortcuts }: Props) { | ||
| const theme = useTheme(); | ||
| const isXs = useMediaQuery(theme.breakpoints.down("sm")); | ||
| const t = useTranslations("commandPalette"); | ||
|
|
||
| const isOpen = useCommandPaletteStore((s) => s.isOpen); | ||
| const close = useCommandPaletteStore((s) => s.close); | ||
| const query = useCommandPaletteStore((s) => s.query); | ||
| const setQuery = useCommandPaletteStore((s) => s.setQuery); | ||
|
|
||
| const setSearchQuery = useSearchStore((s) => s.setQuery); | ||
|
|
||
| const inputRef = useRef<HTMLInputElement | null>(null); | ||
| const [highlight, setHighlight] = useState(0); | ||
|
|
||
| const handleQueryChange = useCallback( | ||
| (nextQuery: string) => { | ||
| setQuery(nextQuery); | ||
| setHighlight(0); | ||
| }, | ||
| [setQuery], | ||
| ); | ||
|
|
||
| // Hand-off to SearchBar — runs the user's query through the regular search flow. | ||
| const handleSearchOnMap = useCallback(() => { | ||
| const q = query.trim(); | ||
| close(); | ||
| if (!q) return; | ||
| requestAnimationFrame(() => { | ||
| setSearchQuery(q); | ||
| const el = document.getElementById(SEARCH_INPUT_ID) as HTMLInputElement | null; | ||
| el?.focus(); | ||
| }); | ||
| }, [close, query, setSearchQuery]); | ||
|
|
||
| const commands = useCommandSources({ openShortcutsDialog: onOpenShortcuts }); | ||
|
|
||
|
Medformatik marked this conversation as resolved.
Outdated
|
||
| // Ranked filtered list when query is present, otherwise the raw command list. | ||
| // When filtering, the synthetic "Search '<q>' on map" row is always appended so | ||
| // it can be navigated by ↑↓ alongside real matches. | ||
| const ranked = useMemo<Command[] | null>(() => { | ||
| const q = query.trim(); | ||
| if (!q) return null; | ||
| const matches = commands | ||
| .map((c) => ({ c, s: scoreCommand(q, c) })) | ||
| .filter((x) => x.s >= SCORE_CUTOFF) | ||
| .sort((a, b) => b.s - a.s) | ||
| .map((x) => x.c); | ||
| const fallback: Command = { | ||
| id: SEARCH_FALLBACK_ID, | ||
| group: "search", | ||
| label: t("searchOnMap", { query: q }), | ||
| iconKey: "search", | ||
| run: handleSearchOnMap, | ||
| }; | ||
| return [...matches, fallback]; | ||
| }, [commands, query, t, handleSearchOnMap]); | ||
|
|
||
| const visible = useMemo( | ||
| () => ranked ?? getDefaultCommandPaletteRows(commands), | ||
| [ranked, commands], | ||
| ); | ||
| const noRealMatches = ranked !== null && ranked.length === 1; // only the fallback | ||
|
|
||
| // Reset state on open/close | ||
| useEffect(() => { | ||
| if (isOpen) { | ||
| setHighlight(0); | ||
| // Auto-select existing text on re-open | ||
| requestAnimationFrame(() => inputRef.current?.select()); | ||
| } | ||
| }, [isOpen]); | ||
|
|
||
| // Keep the highlighted row scrolled into view as the user arrow-keys past the | ||
| // visible area. | ||
| useEffect(() => { | ||
| const cmd = visible[highlight]; | ||
| if (!cmd) return; | ||
| const el = document.getElementById(`command-row-${cmd.id}`); | ||
| el?.scrollIntoView({ block: "nearest" }); | ||
| }, [highlight, visible]); | ||
|
|
||
| const runCommand = useCallback( | ||
| (cmd: Command, event?: { metaKey?: boolean; ctrlKey?: boolean }) => { | ||
| // Platform-aware "keep open" modifier so Ctrl+Enter doesn't trigger | ||
| // it on macOS (where the user expects ⌘+Enter only). | ||
| const isMac = getPlatform() === "mac"; | ||
| const keepOpen = isMac ? !!event?.metaKey : !!event?.ctrlKey; | ||
| try { | ||
| const result = cmd.run(); | ||
| if (!keepOpen && result !== false) close(); | ||
| } catch (e) { | ||
|
Medformatik marked this conversation as resolved.
|
||
| console.error(`[command-palette] '${cmd.id}' failed:`, e); | ||
| return; | ||
| } | ||
| }, | ||
| [close], | ||
| ); | ||
|
|
||
| const handleKeyDown = useCallback( | ||
| (e: React.KeyboardEvent<HTMLInputElement>) => { | ||
| if (e.key === "ArrowDown") { | ||
| e.preventDefault(); | ||
| setHighlight((h) => (visible.length === 0 ? 0 : (h + 1) % visible.length)); | ||
| return; | ||
| } | ||
| if (e.key === "ArrowUp") { | ||
| e.preventDefault(); | ||
| setHighlight((h) => (visible.length === 0 ? 0 : (h - 1 + visible.length) % visible.length)); | ||
| return; | ||
| } | ||
| if (e.key === "Enter") { | ||
| e.preventDefault(); | ||
| const cmd = visible[highlight]; | ||
| if (cmd) { | ||
| runCommand(cmd, { metaKey: e.metaKey, ctrlKey: e.ctrlKey }); | ||
| } | ||
| return; | ||
| } | ||
| // Escape is handled by the global keybindings listener. | ||
| }, | ||
| [visible, highlight, runCommand], | ||
| ); | ||
|
|
||
| const selected = visible[highlight] ?? null; | ||
| const selectedDomId = selected ? `command-row-${selected.id}` : null; | ||
|
|
||
| return ( | ||
| <Dialog | ||
| open={isOpen} | ||
| onClose={close} | ||
| fullScreen={isXs} | ||
| maxWidth="sm" | ||
| fullWidth | ||
| slotProps={{ | ||
| paper: { | ||
| sx: { | ||
| position: (isXs ? undefined : "absolute") as "absolute" | undefined, | ||
| top: isXs ? undefined : 80, | ||
| m: isXs ? 0 : 2, | ||
| borderRadius: isXs ? 0 : 2, | ||
| maxHeight: isXs ? "100dvh" : "70dvh", | ||
| display: "flex", | ||
| flexDirection: "column", | ||
| overflow: "hidden", | ||
| }, | ||
| }, | ||
| backdrop: { | ||
| sx: { backgroundColor: "rgba(0,0,0,0.32)" }, | ||
| }, | ||
| }} | ||
| > | ||
| <CommandPaletteInput | ||
| ref={inputRef} | ||
| query={query} | ||
| onQueryChange={handleQueryChange} | ||
| onClose={close} | ||
| onKeyDown={handleKeyDown} | ||
| activeDescendantId={selectedDomId} | ||
| /> | ||
| <div style={{ overflowY: "auto", flex: 1 }}> | ||
| {noRealMatches && ( | ||
| <Typography sx={{ px: 2, py: 1.5, color: "text.secondary", fontSize: 14 }}> | ||
| {t("noResults")} | ||
| </Typography> | ||
| )} | ||
| <CommandPaletteList | ||
| commands={commands} | ||
| rankedOverride={ranked} | ||
| query={query} | ||
| selectedId={selected?.id ?? null} | ||
| listboxId={COMMAND_PALETTE_LISTBOX_ID} | ||
| onRun={(cmd, e) => { | ||
| const evt = e as unknown as { metaKey?: boolean; ctrlKey?: boolean }; | ||
| runCommand(cmd, evt); | ||
| }} | ||
| /> | ||
| </div> | ||
| <CommandPaletteFooter /> | ||
| </Dialog> | ||
| ); | ||
| } | ||
63 changes: 63 additions & 0 deletions
63
apps/web/src/components/command-palette/CommandPaletteFooter.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| "use client"; | ||
|
|
||
| import Box from "@mui/material/Box"; | ||
| import { useTheme } from "@mui/material/styles"; | ||
| import Typography from "@mui/material/Typography"; | ||
| import useMediaQuery from "@mui/material/useMediaQuery"; | ||
| import { getPlatform } from "@openmapx/core"; | ||
| import { useTranslations } from "next-intl"; | ||
|
|
||
| const KBD_SX = { | ||
| fontFamily: "monospace", | ||
| fontSize: 11, | ||
| px: 0.5, | ||
| py: 0.1, | ||
| border: 1, | ||
| borderColor: "divider", | ||
| borderRadius: 0.5, | ||
| color: "text.secondary", | ||
| } as const; | ||
|
|
||
| export function CommandPaletteFooter() { | ||
| const t = useTranslations("commandPalette"); | ||
| const theme = useTheme(); | ||
| const isXs = useMediaQuery(theme.breakpoints.down("sm")); | ||
| if (isXs) return null; | ||
|
|
||
| const modKey = getPlatform() === "mac" ? "⌘" : "Ctrl"; | ||
|
|
||
| return ( | ||
| <Box | ||
| sx={{ | ||
| display: "flex", | ||
| alignItems: "center", | ||
| gap: 2, | ||
| px: 2, | ||
| py: 0.75, | ||
| borderTop: 1, | ||
| borderColor: "divider", | ||
| bgcolor: "background.default", | ||
| }} | ||
| > | ||
| <FooterHint kbd={["↑", "↓"]} label={t("footerNavigate")} /> | ||
| <FooterHint kbd={["↵"]} label={t("footerSelect")} /> | ||
| <FooterHint kbd={[modKey, "↵"]} label={t("footerSelectAndKeep")} /> | ||
| <FooterHint kbd={["esc"]} label={t("footerClose")} /> | ||
|
Medformatik marked this conversation as resolved.
|
||
| </Box> | ||
| ); | ||
| } | ||
|
|
||
| function FooterHint({ kbd, label }: { kbd: string[]; label: string }) { | ||
| return ( | ||
| <Box sx={{ display: "flex", alignItems: "center", gap: 0.5 }}> | ||
| {kbd.map((k) => ( | ||
| <Typography key={k} component="kbd" sx={KBD_SX}> | ||
| {k} | ||
| </Typography> | ||
| ))} | ||
| <Typography variant="caption" color="text.secondary"> | ||
| {label} | ||
| </Typography> | ||
| </Box> | ||
| ); | ||
| } | ||
62 changes: 62 additions & 0 deletions
62
apps/web/src/components/command-palette/CommandPaletteInput.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| "use client"; | ||
|
|
||
| import CloseIcon from "@mui/icons-material/Close"; | ||
| import SearchIcon from "@mui/icons-material/Search"; | ||
| import Box from "@mui/material/Box"; | ||
| import IconButton from "@mui/material/IconButton"; | ||
| import InputBase from "@mui/material/InputBase"; | ||
| import { useTranslations } from "next-intl"; | ||
| import { forwardRef, type KeyboardEvent } from "react"; | ||
| import { COMMAND_PALETTE_LISTBOX_ID } from "./constants"; | ||
|
|
||
| interface Props { | ||
| query: string; | ||
| onQueryChange: (q: string) => void; | ||
| onClose: () => void; | ||
| onKeyDown: (e: KeyboardEvent<HTMLInputElement>) => void; | ||
| activeDescendantId: string | null; | ||
| } | ||
|
|
||
| export const CommandPaletteInput = forwardRef<HTMLInputElement, Props>(function CommandPaletteInput( | ||
| { query, onQueryChange, onClose, onKeyDown, activeDescendantId }, | ||
| ref, | ||
| ) { | ||
| const t = useTranslations("commandPalette"); | ||
| const tCommon = useTranslations("common"); | ||
|
|
||
| return ( | ||
| <Box | ||
| sx={{ | ||
| display: "flex", | ||
| alignItems: "center", | ||
| gap: 1, | ||
| px: 2, | ||
| py: 1.25, | ||
| borderBottom: 1, | ||
| borderColor: "divider", | ||
| }} | ||
| > | ||
| <SearchIcon color="action" fontSize="small" /> | ||
| <InputBase | ||
| inputRef={ref} | ||
| value={query} | ||
| onChange={(e) => onQueryChange(e.target.value)} | ||
| onKeyDown={onKeyDown} | ||
| placeholder={t("placeholder")} | ||
| autoFocus | ||
| fullWidth | ||
| inputProps={{ | ||
| role: "combobox", | ||
| "aria-expanded": true, | ||
| "aria-controls": COMMAND_PALETTE_LISTBOX_ID, | ||
| "aria-activedescendant": activeDescendantId ?? undefined, | ||
| "aria-autocomplete": "list", | ||
| }} | ||
|
Medformatik marked this conversation as resolved.
|
||
| sx={{ fontSize: 16 }} | ||
| /> | ||
| <IconButton onClick={onClose} aria-label={tCommon("close")} size="small"> | ||
| <CloseIcon fontSize="small" /> | ||
| </IconButton> | ||
| </Box> | ||
| ); | ||
| }); | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.