import React, { useCallback, useEffect, useState } from "react"; import { useRouter } from "next/router"; import useSWR, { mutate } from "swr"; // icons import { InboxIcon, MagnifyingGlassIcon } from "@heroicons/react/24/outline"; import { DiscordIcon, GithubIcon, SettingIcon } from "components/icons"; // headless ui import { Dialog, Transition } from "@headlessui/react"; // cmdk import { Command } from "cmdk"; // hooks import useProjectDetails from "hooks/use-project-details"; import useTheme from "hooks/use-theme"; import useToast from "hooks/use-toast"; import useUser from "hooks/use-user"; import useDebounce from "hooks/use-debounce"; // components import { ShortcutsModal, ChangeIssueState, ChangeIssuePriority, ChangeIssueAssignee, ChangeInterfaceTheme, } from "components/command-palette"; import { BulkDeleteIssuesModal } from "components/core"; import { CreateUpdateCycleModal } from "components/cycles"; import { CreateUpdateIssueModal, DeleteIssueModal } from "components/issues"; import { CreateUpdateModuleModal } from "components/modules"; import { CreateProjectModal } from "components/project"; import { CreateUpdateViewModal } from "components/views"; import { CreateUpdatePageModal } from "components/pages"; import { Icon, Loader, ToggleSwitch, Tooltip } from "components/ui"; // helpers import { copyTextToClipboard } from "helpers/string.helper"; // services import issuesService from "services/issues.service"; import workspaceService from "services/workspace.service"; import inboxService from "services/inbox.service"; // types import { IIssue, IWorkspaceDefaultSearchResult, IWorkspaceIssueSearchResult, IWorkspaceProjectSearchResult, IWorkspaceSearchResult, IWorkspaceSearchResults, } from "types"; // fetch keys import { INBOX_LIST, ISSUE_DETAILS, PROJECT_ISSUES_ACTIVITY } from "constants/fetch-keys"; const commandGroups: { [key: string]: { icon: string; itemName: (item: any) => React.ReactNode; path: (item: any) => string; title: string; }; } = { cycle: { icon: "contrast", itemName: (cycle: IWorkspaceDefaultSearchResult) => cycle?.name, path: (cycle: IWorkspaceDefaultSearchResult) => `/${cycle?.workspace__slug}/projects/${cycle?.project_id}/cycles/${cycle?.id}`, title: "Cycles", }, issue: { icon: "stack", itemName: (issue: IWorkspaceIssueSearchResult) => issue?.name, path: (issue: IWorkspaceIssueSearchResult) => `/${issue?.workspace__slug}/projects/${issue?.project_id}/issues/${issue?.id}`, title: "Issues", }, issue_view: { icon: "photo_filter", itemName: (view: IWorkspaceDefaultSearchResult) => view?.name, path: (view: IWorkspaceDefaultSearchResult) => `/${view?.workspace__slug}/projects/${view?.project_id}/views/${view?.id}`, title: "Views", }, module: { icon: "dataset", itemName: (module: IWorkspaceDefaultSearchResult) => module?.name, path: (module: IWorkspaceDefaultSearchResult) => `/${module?.workspace__slug}/projects/${module?.project_id}/modules/${module?.id}`, title: "Modules", }, page: { icon: "article", itemName: (page: IWorkspaceDefaultSearchResult) => page?.name, path: (page: IWorkspaceDefaultSearchResult) => `/${page?.workspace__slug}/projects/${page?.project_id}/pages/${page?.id}`, title: "Pages", }, project: { icon: "work", itemName: (project: IWorkspaceProjectSearchResult) => project?.name, path: (project: IWorkspaceProjectSearchResult) => `/${project?.workspace__slug}/projects/${project?.id}/issues/`, title: "Projects", }, workspace: { icon: "grid_view", itemName: (workspace: IWorkspaceSearchResult) => workspace?.name, path: (workspace: IWorkspaceSearchResult) => `/${workspace?.slug}/`, title: "Workspaces", }, }; export const CommandPalette: React.FC = () => { const [isPaletteOpen, setIsPaletteOpen] = useState(false); const [isIssueModalOpen, setIsIssueModalOpen] = useState(false); const [isProjectModalOpen, setIsProjectModalOpen] = useState(false); const [isShortcutsModalOpen, setIsShortcutsModalOpen] = useState(false); const [isCreateCycleModalOpen, setIsCreateCycleModalOpen] = useState(false); const [isCreateViewModalOpen, setIsCreateViewModalOpen] = useState(false); const [isCreateModuleModalOpen, setIsCreateModuleModalOpen] = useState(false); const [isBulkDeleteIssuesModalOpen, setIsBulkDeleteIssuesModalOpen] = useState(false); const [deleteIssueModal, setDeleteIssueModal] = useState(false); const [isCreateUpdatePageModalOpen, setIsCreateUpdatePageModalOpen] = useState(false); const [searchTerm, setSearchTerm] = useState(""); const [results, setResults] = useState({ results: { workspace: [], project: [], issue: [], cycle: [], module: [], issue_view: [], page: [], }, }); const [resultsCount, setResultsCount] = useState(0); const [isLoading, setIsLoading] = useState(false); const [isSearching, setIsSearching] = useState(false); const debouncedSearchTerm = useDebounce(searchTerm, 500); const [placeholder, setPlaceholder] = React.useState("Type a command or search..."); const [pages, setPages] = useState([]); const page = pages[pages.length - 1]; const [isWorkspaceLevel, setIsWorkspaceLevel] = useState(false); const router = useRouter(); const { workspaceSlug, projectId, issueId, inboxId } = router.query; const { user } = useUser(); const { projectDetails } = useProjectDetails(); const { setToastAlert } = useToast(); const { toggleCollapsed } = useTheme(); const { data: issueDetails } = useSWR( workspaceSlug && projectId && issueId ? ISSUE_DETAILS(issueId as string) : null, workspaceSlug && projectId && issueId ? () => issuesService.retrieve(workspaceSlug as string, projectId as string, issueId as string) : null ); const { data: inboxList } = useSWR( workspaceSlug && projectId ? INBOX_LIST(projectId as string) : null, workspaceSlug && projectId ? () => inboxService.getInboxes(workspaceSlug as string, projectId as string) : null ); const updateIssue = useCallback( async (formData: Partial) => { if (!workspaceSlug || !projectId || !issueId) return; mutate( ISSUE_DETAILS(issueId as string), (prevData) => { if (!prevData) return prevData; return { ...prevData, ...formData, }; }, false ); const payload = { ...formData }; await issuesService .patchIssue(workspaceSlug as string, projectId as string, issueId as string, payload, user) .then(() => { mutate(PROJECT_ISSUES_ACTIVITY(issueId as string)); mutate(ISSUE_DETAILS(issueId as string)); }) .catch((e) => { console.error(e); }); }, [workspaceSlug, issueId, projectId, user] ); const handleIssueAssignees = (assignee: string) => { if (!issueDetails) return; setIsPaletteOpen(false); const updatedAssignees = issueDetails.assignees ?? []; if (updatedAssignees.includes(assignee)) { updatedAssignees.splice(updatedAssignees.indexOf(assignee), 1); } else { updatedAssignees.push(assignee); } updateIssue({ assignees_list: updatedAssignees }); }; const copyIssueUrlToClipboard = useCallback(() => { if (!router.query.issueId) return; const url = new URL(window.location.href); copyTextToClipboard(url.href) .then(() => { setToastAlert({ type: "success", title: "Copied to clipboard", }); }) .catch(() => { setToastAlert({ type: "error", title: "Some error occurred", }); }); }, [router, setToastAlert]); const handleKeyDown = useCallback( (e: KeyboardEvent) => { const singleShortcutKeys = ["p", "v", "d", "h", "q", "m"]; const { key, ctrlKey, metaKey, altKey, shiftKey } = e; if (!key) return; const keyPressed = key.toLowerCase(); if ( !(e.target instanceof HTMLTextAreaElement) && !(e.target instanceof HTMLInputElement) && !(e.target as Element).classList?.contains("remirror-editor") ) { if ((ctrlKey || metaKey) && keyPressed === "k") { e.preventDefault(); setIsPaletteOpen(true); } else if ((ctrlKey || metaKey) && keyPressed === "c") { if (altKey) { e.preventDefault(); copyIssueUrlToClipboard(); } } else if (keyPressed === "c") { e.preventDefault(); setIsIssueModalOpen(true); } else if ((ctrlKey || metaKey) && keyPressed === "b") { e.preventDefault(); toggleCollapsed(); } else if (key === "Delete") { e.preventDefault(); setIsBulkDeleteIssuesModalOpen(true); } else if ( singleShortcutKeys.includes(keyPressed) && (ctrlKey || metaKey || altKey || shiftKey) ) { e.preventDefault(); } else if (keyPressed === "p") { setIsProjectModalOpen(true); } else if (keyPressed === "v") { setIsCreateViewModalOpen(true); } else if (keyPressed === "d") { setIsCreateUpdatePageModalOpen(true); } else if (keyPressed === "h") { setIsShortcutsModalOpen(true); } else if (keyPressed === "q") { setIsCreateCycleModalOpen(true); } else if (keyPressed === "m") { setIsCreateModuleModalOpen(true); } } }, [toggleCollapsed, copyIssueUrlToClipboard] ); useEffect(() => { document.addEventListener("keydown", handleKeyDown); return () => document.removeEventListener("keydown", handleKeyDown); }, [handleKeyDown]); useEffect( () => { if (!workspaceSlug) return; setIsLoading(true); if (debouncedSearchTerm) { setIsSearching(true); workspaceService .searchWorkspace(workspaceSlug as string, { ...(projectId ? { project_id: projectId.toString() } : {}), search: debouncedSearchTerm, workspace_search: !projectId ? true : isWorkspaceLevel, }) .then((results) => { setResults(results); const count = Object.keys(results.results).reduce( (accumulator, key) => (results.results as any)[key].length + accumulator, 0 ); setResultsCount(count); }) .finally(() => { setIsLoading(false); setIsSearching(false); }); } else { setResults({ results: { workspace: [], project: [], issue: [], cycle: [], module: [], issue_view: [], page: [], }, }); setIsLoading(false); setIsSearching(false); } }, [debouncedSearchTerm, isWorkspaceLevel, projectId, workspaceSlug] // Only call effect if debounced search term changes ); if (!user) return null; const createNewWorkspace = () => { setIsPaletteOpen(false); router.push("/create-workspace"); }; const createNewProject = () => { setIsPaletteOpen(false); setIsProjectModalOpen(true); }; const createNewIssue = () => { setIsPaletteOpen(false); setIsIssueModalOpen(true); }; const createNewCycle = () => { setIsPaletteOpen(false); setIsCreateCycleModalOpen(true); }; const createNewView = () => { setIsPaletteOpen(false); setIsCreateViewModalOpen(true); }; const createNewPage = () => { setIsPaletteOpen(false); setIsCreateUpdatePageModalOpen(true); }; const createNewModule = () => { setIsPaletteOpen(false); setIsCreateModuleModalOpen(true); }; const deleteIssue = () => { setIsPaletteOpen(false); setDeleteIssueModal(true); }; const redirect = (path: string) => { setIsPaletteOpen(false); router.push(path); }; return ( <> {workspaceSlug && ( )} {projectId && ( <> setIsCreateCycleModalOpen(false)} user={user} /> setIsCreateViewModalOpen(false)} isOpen={isCreateViewModalOpen} user={user} /> setIsCreateUpdatePageModalOpen(false)} user={user} /> )} {issueId && issueDetails && ( setDeleteIssueModal(false)} isOpen={deleteIssueModal} data={issueDetails} user={user} /> )} setIsIssueModalOpen(false)} fieldsToShow={inboxId ? ["name", "description", "priority"] : ["all"]} /> { setSearchTerm(""); }} as={React.Fragment} > setIsPaletteOpen(false)}>
{ if (value.toLowerCase().includes(search.toLowerCase())) return 1; return 0; }} onKeyDown={(e) => { // when search is empty and page is undefined // when user tries to close the modal with esc if (e.key === "Escape" && !page && !searchTerm) { setIsPaletteOpen(false); } // Escape goes to previous page // Backspace goes to previous page when search is empty if (e.key === "Escape" || (e.key === "Backspace" && !searchTerm)) { e.preventDefault(); setPages((pages) => pages.slice(0, -1)); setPlaceholder("Type a command or search..."); } }} >
{issueDetails && (
{issueDetails.project_detail.identifier}-{issueDetails.sequence_id}{" "} {issueDetails.name}
)} {projectId && (
setIsWorkspaceLevel((prevData) => !prevData)} />
)}
{!page && ( <> {issueId && ( { setPlaceholder("Change state..."); setSearchTerm(""); setPages([...pages, "change-issue-state"]); }} className="focus:outline-none" >
Change state...
{ setPlaceholder("Change priority..."); setSearchTerm(""); setPages([...pages, "change-issue-priority"]); }} className="focus:outline-none" >
Change priority...
{ setPlaceholder("Assign to..."); setSearchTerm(""); setPages([...pages, "change-issue-assignee"]); }} className="focus:outline-none" >
Assign to...
{ handleIssueAssignees(user.id); setSearchTerm(""); }} className="focus:outline-none" >
{issueDetails?.assignees.includes(user.id) ? ( <> Un-assign from me ) : ( <> Assign to me )}
Delete issue
{ setIsPaletteOpen(false); copyIssueUrlToClipboard(); }} className="focus:outline-none" >
Copy issue URL
)}
Create new issue
C
{workspaceSlug && (
Create new project
P
)} {projectId && ( <>
Create new cycle
Q
Create new module
M
Create new view
V
Create new page
D
{projectDetails && projectDetails.inbox_view && ( redirect( `/${workspaceSlug}/projects/${projectId}/inbox/${inboxList?.[0]?.id}` ) } className="focus:outline-none" >
Open inbox
)} )} { setPlaceholder("Search workspace settings..."); setSearchTerm(""); setPages([...pages, "settings"]); }} className="focus:outline-none" >
Search settings...
Create new workspace
{ setPlaceholder("Change interface theme..."); setSearchTerm(""); setPages([...pages, "change-interface-theme"]); }} className="focus:outline-none" >
Change interface theme...
{ setIsPaletteOpen(false); const e = new KeyboardEvent("keydown", { key: "h", }); document.dispatchEvent(e); }} className="focus:outline-none" >
Open keyboard shortcuts
{ setIsPaletteOpen(false); window.open("https://docs.plane.so/", "_blank"); }} className="focus:outline-none" >
Open Plane documentation
{ setIsPaletteOpen(false); window.open("https://discord.com/invite/A92xrEGCge", "_blank"); }} className="focus:outline-none" >
Join our Discord
{ setIsPaletteOpen(false); window.open( "https://github.com/makeplane/plane/issues/new/choose", "_blank" ); }} className="focus:outline-none" >
Report a bug
{ setIsPaletteOpen(false); (window as any).$crisp.push(["do", "chat:open"]); }} className="focus:outline-none" >
Chat with us
)} {searchTerm !== "" && (
Search results for{" "} {'"'} {searchTerm} {'"'} {" "} in project:
)} {!isLoading && resultsCount === 0 && searchTerm !== "" && debouncedSearchTerm !== "" && (
No results found.
)} {(isLoading || isSearching) && ( )} {debouncedSearchTerm !== "" && Object.keys(results.results).map((key) => { const section = (results.results as any)[key]; const currentSection = commandGroups[key]; if (section.length > 0) { return ( {section.map((item: any) => ( { router.push(currentSection.path(item)); setIsPaletteOpen(false); }} value={`${key}-${item?.name}`} className="focus:outline-none" >

{item.name}

))}
); } })} {page === "settings" && workspaceSlug && ( <> redirect(`/${workspaceSlug}/settings`)} className="focus:outline-none" >
General
redirect(`/${workspaceSlug}/settings/members`)} className="focus:outline-none" >
Members
redirect(`/${workspaceSlug}/settings/billing`)} className="focus:outline-none" >
Billing and Plans
redirect(`/${workspaceSlug}/settings/integrations`)} className="focus:outline-none" >
Integrations
redirect(`/${workspaceSlug}/settings/import-export`)} className="focus:outline-none" >
Import/Export
)} {page === "change-issue-state" && issueDetails && ( )} {page === "change-issue-priority" && issueDetails && ( )} {page === "change-issue-assignee" && issueDetails && ( )} {page === "change-interface-theme" && ( )}
); };