6aa139a851
* fix: workspace level toggle position, paddings, and tab navigation * chore: platform-specific command icons --------- Co-authored-by: Anmol Singh Bhatia <anmolsinghbhatia@plane.so>
466 lines
21 KiB
TypeScript
466 lines
21 KiB
TypeScript
"use client";
|
|
|
|
import React, { useEffect, useState } from "react";
|
|
import { Command } from "cmdk";
|
|
import { observer } from "mobx-react";
|
|
import { useParams } from "next/navigation";
|
|
import useSWR from "swr";
|
|
import { CommandIcon, FolderPlus, Search, Settings } from "lucide-react";
|
|
import { Dialog, Transition } from "@headlessui/react";
|
|
// plane imports
|
|
import { EUserPermissions, EUserPermissionsLevel } from "@plane/constants";
|
|
import { useTranslation } from "@plane/i18n";
|
|
import { IWorkspaceSearchResults } from "@plane/types";
|
|
import { LayersIcon, Loader, ToggleSwitch } from "@plane/ui";
|
|
// components
|
|
import {
|
|
ChangeIssueAssignee,
|
|
ChangeIssuePriority,
|
|
ChangeIssueState,
|
|
CommandPaletteHelpActions,
|
|
CommandPaletteIssueActions,
|
|
CommandPaletteProjectActions,
|
|
CommandPaletteSearchResults,
|
|
CommandPaletteThemeActions,
|
|
CommandPaletteWorkspaceSettingsActions,
|
|
} from "@/components/command-palette";
|
|
import { SimpleEmptyState } from "@/components/empty-state";
|
|
// fetch-keys
|
|
import { ISSUE_DETAILS } from "@/constants/fetch-keys";
|
|
// helpers
|
|
import { getTabIndex } from "@/helpers/tab-indices.helper";
|
|
// hooks
|
|
import { useCommandPalette, useEventTracker, useProject, useUser, useUserPermissions } from "@/hooks/store";
|
|
import { useAppRouter } from "@/hooks/use-app-router";
|
|
import useDebounce from "@/hooks/use-debounce";
|
|
import { usePlatformOS } from "@/hooks/use-platform-os";
|
|
// plane web components
|
|
import { useResolvedAssetPath } from "@/hooks/use-resolved-asset-path";
|
|
import { IssueIdentifier } from "@/plane-web/components/issues";
|
|
// plane web services
|
|
import { WorkspaceService } from "@/plane-web/services";
|
|
// services
|
|
import { IssueService } from "@/services/issue";
|
|
|
|
const workspaceService = new WorkspaceService();
|
|
const issueService = new IssueService();
|
|
|
|
export const CommandModal: React.FC = observer(() => {
|
|
// router
|
|
const router = useAppRouter();
|
|
const { workspaceSlug, projectId, issueId } = useParams();
|
|
// states
|
|
const [placeholder, setPlaceholder] = useState("Type a command or search...");
|
|
const [resultsCount, setResultsCount] = useState(0);
|
|
const [isLoading, setIsLoading] = useState(false);
|
|
const [isSearching, setIsSearching] = useState(false);
|
|
const [searchTerm, setSearchTerm] = useState("");
|
|
const [results, setResults] = useState<IWorkspaceSearchResults>({
|
|
results: {
|
|
workspace: [],
|
|
project: [],
|
|
issue: [],
|
|
cycle: [],
|
|
module: [],
|
|
issue_view: [],
|
|
page: [],
|
|
},
|
|
});
|
|
const [isWorkspaceLevel, setIsWorkspaceLevel] = useState(true);
|
|
const [pages, setPages] = useState<string[]>([]);
|
|
// plane hooks
|
|
const { t } = useTranslation();
|
|
// hooks
|
|
const { workspaceProjectIds } = useProject();
|
|
const { platform, isMobile } = usePlatformOS();
|
|
const { canPerformAnyCreateAction } = useUser();
|
|
const { isCommandPaletteOpen, toggleCommandPaletteModal, toggleCreateIssueModal, toggleCreateProjectModal } =
|
|
useCommandPalette();
|
|
const { allowPermissions } = useUserPermissions();
|
|
const { setTrackElement } = useEventTracker();
|
|
// derived values
|
|
const page = pages[pages.length - 1];
|
|
const debouncedSearchTerm = useDebounce(searchTerm, 500);
|
|
const { baseTabIndex } = getTabIndex(undefined, isMobile);
|
|
const canPerformWorkspaceActions = allowPermissions(
|
|
[EUserPermissions.ADMIN, EUserPermissions.MEMBER],
|
|
EUserPermissionsLevel.WORKSPACE
|
|
);
|
|
const resolvedPath = useResolvedAssetPath({ basePath: "/empty-state/search/search" });
|
|
|
|
// TODO: update this to mobx store
|
|
const { data: issueDetails } = useSWR(
|
|
workspaceSlug && projectId && issueId ? ISSUE_DETAILS(issueId.toString()) : null,
|
|
workspaceSlug && projectId && issueId
|
|
? () => issueService.retrieve(workspaceSlug.toString(), projectId.toString(), issueId.toString())
|
|
: null
|
|
);
|
|
|
|
const closePalette = () => {
|
|
toggleCommandPaletteModal(false);
|
|
};
|
|
|
|
const createNewWorkspace = () => {
|
|
closePalette();
|
|
router.push("/create-workspace");
|
|
};
|
|
|
|
useEffect(
|
|
() => {
|
|
if (!workspaceSlug) return;
|
|
|
|
setIsLoading(true);
|
|
|
|
if (debouncedSearchTerm) {
|
|
setIsSearching(true);
|
|
workspaceService
|
|
.searchWorkspace(workspaceSlug.toString(), {
|
|
...(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
|
|
);
|
|
|
|
return (
|
|
<Transition.Root show={isCommandPaletteOpen} afterLeave={() => setSearchTerm("")} as={React.Fragment}>
|
|
<Dialog as="div" className="relative z-30" onClose={() => closePalette()}>
|
|
<Transition.Child
|
|
as={React.Fragment}
|
|
enter="ease-out duration-300"
|
|
enterFrom="opacity-0"
|
|
enterTo="opacity-100"
|
|
leave="ease-in duration-200"
|
|
leaveFrom="opacity-100"
|
|
leaveTo="opacity-0"
|
|
>
|
|
<div className="fixed inset-0 bg-custom-backdrop transition-opacity" />
|
|
</Transition.Child>
|
|
|
|
<div className="fixed inset-0 z-30 overflow-y-auto">
|
|
<div className="flex items-center justify-center p-4 sm:p-6 md:p-20">
|
|
<Transition.Child
|
|
as={React.Fragment}
|
|
enter="ease-out duration-300"
|
|
enterFrom="opacity-0 translate-y-4 sm:translate-y-0 sm:scale-95"
|
|
enterTo="opacity-100 translate-y-0 sm:scale-100"
|
|
leave="ease-in duration-200"
|
|
leaveFrom="opacity-100 translate-y-0 sm:scale-100"
|
|
leaveTo="opacity-0 translate-y-4 sm:translate-y-0 sm:scale-95"
|
|
>
|
|
<Dialog.Panel className="relative flex w-full max-w-2xl transform flex-col items-center justify-center divide-y divide-custom-border-200 divide-opacity-10 rounded-lg bg-custom-background-100 shadow-custom-shadow-md transition-all">
|
|
<div className="w-full max-w-2xl">
|
|
<Command
|
|
filter={(value, search) => {
|
|
if (value.toLowerCase().includes(search.toLowerCase())) return 1;
|
|
return 0;
|
|
}}
|
|
shouldFilter={searchTerm.length > 0}
|
|
onKeyDown={(e: any) => {
|
|
if ((e.metaKey || e.ctrlKey) && e.key.toLowerCase() === "k") {
|
|
e.preventDefault();
|
|
e.stopPropagation();
|
|
closePalette();
|
|
return;
|
|
}
|
|
|
|
if (e.key === "Tab") {
|
|
e.preventDefault();
|
|
const commandList = document.querySelector("[cmdk-list]");
|
|
const items = commandList?.querySelectorAll("[cmdk-item]") || [];
|
|
const selectedItem = commandList?.querySelector('[aria-selected="true"]');
|
|
if (items.length === 0) return;
|
|
|
|
const currentIndex = Array.from(items).indexOf(selectedItem as Element);
|
|
let nextIndex;
|
|
|
|
if (e.shiftKey) {
|
|
nextIndex = currentIndex > 0 ? currentIndex - 1 : items.length - 1;
|
|
} else {
|
|
nextIndex = currentIndex < items.length - 1 ? currentIndex + 1 : 0;
|
|
}
|
|
|
|
const nextItem = items[nextIndex] as HTMLElement;
|
|
if (nextItem) {
|
|
nextItem.setAttribute("aria-selected", "true");
|
|
selectedItem?.setAttribute("aria-selected", "false");
|
|
nextItem.focus();
|
|
nextItem.scrollIntoView({
|
|
behavior: "smooth",
|
|
block: "nearest",
|
|
});
|
|
}
|
|
}
|
|
|
|
if (e.key === "Escape" && searchTerm) {
|
|
e.preventDefault();
|
|
setSearchTerm("");
|
|
}
|
|
|
|
if (e.key === "Escape" && !page && !searchTerm) {
|
|
e.preventDefault();
|
|
closePalette();
|
|
}
|
|
|
|
if (e.key === "Escape" || (e.key === "Backspace" && !searchTerm)) {
|
|
e.preventDefault();
|
|
setPages((pages) => pages.slice(0, -1));
|
|
setPlaceholder("Type a command or search...");
|
|
}
|
|
}}
|
|
>
|
|
<div
|
|
className={`flex gap-4 pb-0 sm:items-center ${
|
|
issueDetails ? "flex-col justify-between sm:flex-row" : "justify-end"
|
|
}`}
|
|
>
|
|
{issueDetails && (
|
|
<div className="flex gap-2 items-center overflow-hidden truncate rounded-md bg-custom-background-80 p-2 text-xs font-medium text-custom-text-200">
|
|
{issueDetails.project_id && (
|
|
<IssueIdentifier
|
|
issueId={issueDetails.id}
|
|
projectId={issueDetails.project_id}
|
|
textContainerClassName="text-xs font-medium text-custom-text-200"
|
|
/>
|
|
)}
|
|
{issueDetails.name}
|
|
</div>
|
|
)}
|
|
</div>
|
|
<div className="relative">
|
|
<Search
|
|
className="pointer-events-none absolute left-4 top-1/2 h-4 w-4 -translate-y-1/2 text-custom-text-200"
|
|
aria-hidden="true"
|
|
strokeWidth={2}
|
|
/>
|
|
<Command.Input
|
|
className="w-full border-0 border-b border-custom-border-200 bg-transparent p-4 pl-11 text-sm text-custom-text-100 outline-none placeholder:text-custom-text-400 focus:ring-0"
|
|
placeholder={placeholder}
|
|
value={searchTerm}
|
|
onValueChange={(e) => setSearchTerm(e)}
|
|
autoFocus
|
|
tabIndex={baseTabIndex}
|
|
/>
|
|
</div>
|
|
|
|
<Command.List className="vertical-scrollbar scrollbar-sm max-h-96 overflow-scroll p-2">
|
|
{searchTerm !== "" && (
|
|
<h5 className="mx-[3px] my-4 text-xs text-custom-text-100">
|
|
Search results for{" "}
|
|
<span className="font-medium">
|
|
{'"'}
|
|
{searchTerm}
|
|
{'"'}
|
|
</span>{" "}
|
|
in {!projectId || isWorkspaceLevel ? "workspace" : "project"}:
|
|
</h5>
|
|
)}
|
|
|
|
{!isLoading && resultsCount === 0 && searchTerm !== "" && debouncedSearchTerm !== "" && (
|
|
<div className="flex flex-col items-center justify-center px-3 py-8 text-center">
|
|
<SimpleEmptyState title={t("command_k.empty_state.search.title")} assetPath={resolvedPath} />
|
|
</div>
|
|
)}
|
|
|
|
{(isLoading || isSearching) && (
|
|
<Command.Loading>
|
|
<Loader className="space-y-3">
|
|
<Loader.Item height="40px" />
|
|
<Loader.Item height="40px" />
|
|
<Loader.Item height="40px" />
|
|
<Loader.Item height="40px" />
|
|
</Loader>
|
|
</Command.Loading>
|
|
)}
|
|
|
|
{debouncedSearchTerm !== "" && (
|
|
<CommandPaletteSearchResults closePalette={closePalette} results={results} />
|
|
)}
|
|
|
|
{!page && (
|
|
<>
|
|
{/* issue actions */}
|
|
{issueId && (
|
|
<CommandPaletteIssueActions
|
|
closePalette={closePalette}
|
|
issueDetails={issueDetails}
|
|
pages={pages}
|
|
setPages={(newPages) => setPages(newPages)}
|
|
setPlaceholder={(newPlaceholder) => setPlaceholder(newPlaceholder)}
|
|
setSearchTerm={(newSearchTerm) => setSearchTerm(newSearchTerm)}
|
|
/>
|
|
)}
|
|
{workspaceSlug &&
|
|
workspaceProjectIds &&
|
|
workspaceProjectIds.length > 0 &&
|
|
canPerformAnyCreateAction && (
|
|
<Command.Group heading="Work item">
|
|
<Command.Item
|
|
onSelect={() => {
|
|
closePalette();
|
|
setTrackElement("Command Palette");
|
|
toggleCreateIssueModal(true);
|
|
}}
|
|
className="focus:bg-custom-background-80"
|
|
>
|
|
<div className="flex items-center gap-2 text-custom-text-200">
|
|
<LayersIcon className="h-3.5 w-3.5" />
|
|
Create new work item
|
|
</div>
|
|
<kbd>C</kbd>
|
|
</Command.Item>
|
|
</Command.Group>
|
|
)}
|
|
{workspaceSlug && canPerformWorkspaceActions && (
|
|
<Command.Group heading="Project">
|
|
<Command.Item
|
|
onSelect={() => {
|
|
closePalette();
|
|
setTrackElement("Command palette");
|
|
toggleCreateProjectModal(true);
|
|
}}
|
|
className="focus:outline-none"
|
|
>
|
|
<div className="flex items-center gap-2 text-custom-text-200">
|
|
<FolderPlus className="h-3.5 w-3.5" />
|
|
Create new project
|
|
</div>
|
|
<kbd>P</kbd>
|
|
</Command.Item>
|
|
</Command.Group>
|
|
)}
|
|
|
|
{/* project actions */}
|
|
{projectId && canPerformAnyCreateAction && (
|
|
<CommandPaletteProjectActions closePalette={closePalette} />
|
|
)}
|
|
{canPerformWorkspaceActions && (
|
|
<Command.Group heading="Workspace Settings">
|
|
<Command.Item
|
|
onSelect={() => {
|
|
setPlaceholder("Search workspace settings...");
|
|
setSearchTerm("");
|
|
setPages([...pages, "settings"]);
|
|
}}
|
|
className="focus:outline-none"
|
|
>
|
|
<div className="flex items-center gap-2 text-custom-text-200">
|
|
<Settings className="h-3.5 w-3.5" />
|
|
Search settings...
|
|
</div>
|
|
</Command.Item>
|
|
</Command.Group>
|
|
)}
|
|
<Command.Group heading="Account">
|
|
<Command.Item onSelect={createNewWorkspace} className="focus:outline-none">
|
|
<div className="flex items-center gap-2 text-custom-text-200">
|
|
<FolderPlus className="h-3.5 w-3.5" />
|
|
Create new workspace
|
|
</div>
|
|
</Command.Item>
|
|
<Command.Item
|
|
onSelect={() => {
|
|
setPlaceholder("Change interface theme...");
|
|
setSearchTerm("");
|
|
setPages([...pages, "change-interface-theme"]);
|
|
}}
|
|
className="focus:outline-none"
|
|
>
|
|
<div className="flex items-center gap-2 text-custom-text-200">
|
|
<Settings className="h-3.5 w-3.5" />
|
|
Change interface theme...
|
|
</div>
|
|
</Command.Item>
|
|
</Command.Group>
|
|
|
|
{/* help options */}
|
|
<CommandPaletteHelpActions closePalette={closePalette} />
|
|
</>
|
|
)}
|
|
|
|
{/* workspace settings actions */}
|
|
{page === "settings" && workspaceSlug && (
|
|
<CommandPaletteWorkspaceSettingsActions closePalette={closePalette} />
|
|
)}
|
|
|
|
{/* issue details page actions */}
|
|
{page === "change-issue-state" && issueDetails && (
|
|
<ChangeIssueState closePalette={closePalette} issue={issueDetails} />
|
|
)}
|
|
{page === "change-issue-priority" && issueDetails && (
|
|
<ChangeIssuePriority closePalette={closePalette} issue={issueDetails} />
|
|
)}
|
|
{page === "change-issue-assignee" && issueDetails && (
|
|
<ChangeIssueAssignee closePalette={closePalette} issue={issueDetails} />
|
|
)}
|
|
|
|
{/* theme actions */}
|
|
{page === "change-interface-theme" && (
|
|
<CommandPaletteThemeActions
|
|
closePalette={() => {
|
|
closePalette();
|
|
setPages((pages) => pages.slice(0, -1));
|
|
}}
|
|
/>
|
|
)}
|
|
</Command.List>
|
|
</Command>
|
|
</div>
|
|
{/* Bottom overlay */}
|
|
<div className="w-full flex items-center justify-between px-4 py-2 border-t border-custom-border-200 bg-custom-background-90/80 rounded-b-lg">
|
|
<div className="flex items-center gap-2">
|
|
<span className="text-xs text-custom-text-300">Actions</span>
|
|
<div className="flex items-center gap-1">
|
|
<div className="grid h-6 min-w-[1.5rem] place-items-center rounded bg-custom-background-80 border-[0.5px] border-custom-border-200 px-1.5 text-[10px] text-custom-text-200">
|
|
{platform === "MacOS" ? <CommandIcon className="h-2.5 w-2.5 text-custom-text-200" /> : "Ctrl"}
|
|
</div>
|
|
<kbd className="grid h-6 min-w-[1.5rem] place-items-center rounded bg-custom-background-80 border-[0.5px] border-custom-border-200 px-1.5 text-[10px] text-custom-text-200">
|
|
K
|
|
</kbd>
|
|
</div>
|
|
</div>
|
|
<div className="flex items-center gap-2">
|
|
<span className="text-xs text-custom-text-300">Workspace Level</span>
|
|
<ToggleSwitch
|
|
value={isWorkspaceLevel}
|
|
onChange={() => setIsWorkspaceLevel((prevData) => !prevData)}
|
|
size="sm"
|
|
/>
|
|
</div>
|
|
</div>
|
|
</Dialog.Panel>
|
|
</Transition.Child>
|
|
</div>
|
|
</div>
|
|
</Dialog>
|
|
</Transition.Root>
|
|
);
|
|
});
|