web: add a simple command palette #7314
There are no files selected for viewing
This file contains 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 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 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 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 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,277 @@ | ||
| /* | ||
| This file is part of the Notesnook project (https://notesnook.com/) | ||
|
|
||
| Copyright (C) 2023 Streetwriters (Private) Limited | ||
|
|
||
| This program is free software: you can redistribute it and/or modify | ||
| it under the terms of the GNU General Public License as published by | ||
| the Free Software Foundation, either version 3 of the License, or | ||
| (at your option) any later version. | ||
|
|
||
| This program is distributed in the hope that it will be useful, | ||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| GNU General Public License for more details. | ||
|
|
||
| You should have received a copy of the GNU General Public License | ||
| along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| import { ScrollContainer } from "@notesnook/ui"; | ||
| import { Button, Flex, Text } from "@theme-ui/components"; | ||
| import { Fragment, useEffect, useRef } from "react"; | ||
| import { BaseDialogProps, DialogManager } from "../../common/dialog-manager"; | ||
| import Dialog from "../../components/dialog"; | ||
| import Field from "../../components/field"; | ||
| import { | ||
| type Command, | ||
| useCommandPaletteStore, | ||
| getCommandAction, | ||
| getCommandIcon | ||
| } from "../../stores/command-palette-store"; | ||
| import { Icon } from "../../components/icons"; | ||
| import { toTitleCase } from "@notesnook/common"; | ||
| import { match, surround } from "fuzzyjs"; | ||
|
|
||
| type GroupedCommands = Record< | ||
| string, | ||
| (Command & { index: number; icon: Icon | undefined })[] | ||
| >; | ||
|
|
||
| export const CommandPaletteDialog = DialogManager.register( | ||
| function CommandPaletteDialog(props: BaseDialogProps<boolean>) { | ||
| const { | ||
| selected, | ||
| setSelected, | ||
| query, | ||
| setQuery, | ||
| commands, | ||
| search, | ||
| setCommands, | ||
| reset | ||
| } = useCommandPaletteStore(); | ||
| const selectedRef = useRef<HTMLButtonElement>(null); | ||
|
|
||
| useEffect(() => { | ||
| selectedRef.current?.scrollIntoView({ | ||
| block: "nearest" | ||
| }); | ||
| }, [selected]); | ||
|
|
||
| useEffect(() => { | ||
| const searchWithoutDebounce = | ||
| query.startsWith(">") || query.trim().length < 1; | ||
| if (searchWithoutDebounce) { | ||
| const res = search(query); | ||
| if (res instanceof Promise) { | ||
| } else { | ||
| setCommands(res ?? []); | ||
| } | ||
| } | ||
|
|
||
| const timeoutId = setTimeout(async () => { | ||
| const res = search(query); | ||
| if (res instanceof Promise) { | ||
| const commands = await res; | ||
| setCommands(commands ?? []); | ||
| return; | ||
| } else { | ||
| setCommands(res ?? []); | ||
| } | ||
| }, 500); | ||
|
|
||
| return () => { | ||
| clearTimeout(timeoutId); | ||
| }; | ||
| }, [query]); | ||
|
Comment on lines
+61
to
+86
There was a problem hiding this comment. This doesn't need to be in a |
||
|
|
||
| const grouped = commands.reduce((acc, command, index) => { | ||
| if (!acc[command.group]) { | ||
| acc[command.group] = []; | ||
| } | ||
| acc[command.group].push({ | ||
| ...command, | ||
| icon: getCommandIcon(command), | ||
| index | ||
| }); | ||
| return acc; | ||
| }, {} as GroupedCommands); | ||
|
|
||
| return ( | ||
| <Dialog | ||
| isOpen={true} | ||
| width={650} | ||
| onClose={() => { | ||
| reset(); | ||
| props.onClose(false); | ||
| }} | ||
| noScroll | ||
| sx={{ | ||
| fontFamily: "body" | ||
| }} | ||
| > | ||
| <Flex | ||
| variant="columnFill" | ||
| sx={{ mx: 3, overflow: "hidden", height: 350 }} | ||
| onKeyDown={(e) => { | ||
| if (e.key == "Enter") { | ||
| e.preventDefault(); | ||
| const command = commands[selected]; | ||
| if (!command) return; | ||
| const action = getCommandAction({ | ||
| id: command.id, | ||
| type: command.type | ||
| }); | ||
| if (action) { | ||
| action(command.id); | ||
| reset(); | ||
| props.onClose(true); | ||
| } | ||
| setSelected(0); | ||
| } | ||
| if (e.key === "ArrowDown") { | ||
| e.preventDefault(); | ||
| setSelected((selected + 1) % commands.length); | ||
| } | ||
| if (e.key === "ArrowUp") { | ||
| e.preventDefault(); | ||
| setSelected((selected - 1 + commands.length) % commands.length); | ||
| } | ||
| }} | ||
| > | ||
| <> | ||
| <Field | ||
| autoFocus | ||
| placeholder={"Search in notes, notebooks, and tags"} | ||
| sx={{ mx: 0, my: 2 }} | ||
| value={query} | ||
| onChange={(e) => { | ||
| setSelected(0); | ||
| setQuery(e.target.value); | ||
| }} | ||
| /> | ||
| <ScrollContainer> | ||
| <Flex | ||
| sx={{ | ||
| flexDirection: "column", | ||
| gap: 1, | ||
| mt: 2, | ||
| mb: 4 | ||
| }} | ||
| > | ||
| {Object.entries(grouped).map(([group, commands]) => ( | ||
| <Flex sx={{ flexDirection: "column", gap: 1, mx: 1 }}> | ||
| <Text variant="subBody">{toTitleCase(group)}</Text> | ||
| <Flex | ||
| sx={{ | ||
| flexDirection: "column", | ||
| gap: 1 | ||
| }} | ||
| > | ||
| {commands.map((command, index) => ( | ||
| <Button | ||
| ref={command.index === selected ? selectedRef : null} | ||
| key={index} | ||
| onClick={() => { | ||
| const action = getCommandAction({ | ||
| id: command.id, | ||
| type: command.type | ||
| }); | ||
| if (action) { | ||
| action(command.id); | ||
| reset(); | ||
| props.onClose(true); | ||
| } | ||
| }} | ||
| sx={{ | ||
| display: "flex", | ||
| flexDirection: "row", | ||
| alignItems: "center", | ||
| gap: 2, | ||
| py: 1, | ||
| bg: | ||
| command.index === selected | ||
| ? "hover" | ||
| : "transparent", | ||
| ".chip": { | ||
| bg: | ||
| command.index === selected | ||
| ? "color-mix(in srgb, var(--accent) 20%, transparent)" | ||
| : "var(--background-secondary)" | ||
| }, | ||
| ":hover:not(:disabled):not(:active)": { | ||
| bg: "hover" | ||
| } | ||
| }} | ||
| > | ||
| {command.icon && ( | ||
| <command.icon | ||
| size={18} | ||
| color={ | ||
| command.index === selected | ||
| ? "icon-selected" | ||
| : "icon" | ||
| } | ||
| /> | ||
| )} | ||
| {["note", "notebook", "reminder", "tag"].includes( | ||
| command.type | ||
| ) ? ( | ||
| <Text | ||
| className="chip" | ||
| sx={{ | ||
| px: 1, | ||
| borderRadius: "4px", | ||
| border: "1px solid", | ||
| borderColor: "border" | ||
| }} | ||
| > | ||
| <Highlighter text={command.title} query={query} /> | ||
| </Text> | ||
| ) : ( | ||
| <Highlighter text={command.title} query={query} /> | ||
| )} | ||
| </Button> | ||
| ))} | ||
| </Flex> | ||
| </Flex> | ||
| ))} | ||
| </Flex> | ||
| </ScrollContainer> | ||
| </> | ||
| </Flex> | ||
| <Flex | ||
| sx={{ flexDirection: "row", bg: "hover", justifyContent: "center" }} | ||
| > | ||
| <Text variant="subBody" sx={{ m: 0.5 }}> | ||
| <kbd>{">"}</kbd> for command mode · remove <kbd>{">"}</kbd> for | ||
| search mode · <kbd>⏎</kbd> to select · <kbd>↑</kbd> | ||
| <kbd>↓</kbd> to navigate | ||
| </Text> | ||
| </Flex> | ||
| </Dialog> | ||
| ); | ||
| } | ||
| ); | ||
|
|
||
| function Highlighter({ text, query }: { text: string; query: string }) { | ||
| const queryClean = query.startsWith(">") | ||
| ? query.slice(1).trim() | ||
| : query.trim(); | ||
| const result = queryClean.length > 0 ? match(queryClean, text) : false; | ||
|
|
||
| return ( | ||
| <span | ||
| dangerouslySetInnerHTML={{ | ||
| __html: | ||
| result && result.match | ||
| ? surround(text, { | ||
| result: result, | ||
|
Comment on lines
+261
to
+269
There was a problem hiding this comment. I have to use fuzzyjs's There was a problem hiding this comment. Hm. I think lookup.ts should expose an API to return results with the results wrapped (the prefix/suffix could be configurable). That'll allow us to change the matcher library in the future without any other changes and also simplify all this. |
||
| prefix: "<b style='color: var(--accent-foreground)'>", | ||
| suffix: "</b>" | ||
| }) | ||
| : text | ||
| }} | ||
| ></span> | ||
| ); | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be true, I think.