[WEB-1101] chore: workspace view quick action enhancement (#4324)

* chore: workspace view quick action enhancement

* fix: issue quick action height
This commit is contained in:
Anmol Singh Bhatia 2024-05-01 18:03:13 +05:30 committed by GitHub
parent d69f025b9a
commit ecc277c571
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 339 additions and 30 deletions

View File

@ -161,6 +161,7 @@ export const AllIssueQuickActions: React.FC<IQuickActionProps> = observer((props
portalElement={portalElement} portalElement={portalElement}
placement={placements} placement={placements}
menuItemsClassName="z-[14]" menuItemsClassName="z-[14]"
maxHeight="lg"
closeOnSelect closeOnSelect
> >
{MENU_ITEMS.map((item) => { {MENU_ITEMS.map((item) => {

View File

@ -123,6 +123,7 @@ export const ArchivedIssueQuickActions: React.FC<IQuickActionProps> = observer((
portalElement={portalElement} portalElement={portalElement}
placement={placements} placement={placements}
menuItemsClassName="z-[14]" menuItemsClassName="z-[14]"
maxHeight="lg"
closeOnSelect closeOnSelect
> >
{MENU_ITEMS.map((item) => { {MENU_ITEMS.map((item) => {

View File

@ -181,6 +181,7 @@ export const CycleIssueQuickActions: React.FC<IQuickActionProps> = observer((pro
customButton={customActionButton} customButton={customActionButton}
portalElement={portalElement} portalElement={portalElement}
menuItemsClassName="z-[14]" menuItemsClassName="z-[14]"
maxHeight="lg"
closeOnSelect closeOnSelect
> >
{MENU_ITEMS.map((item) => { {MENU_ITEMS.map((item) => {

View File

@ -107,6 +107,7 @@ export const DraftIssueQuickActions: React.FC<IQuickActionProps> = observer((pro
portalElement={portalElement} portalElement={portalElement}
placement={placements} placement={placements}
menuItemsClassName="z-[14]" menuItemsClassName="z-[14]"
maxHeight="lg"
closeOnSelect closeOnSelect
> >
{MENU_ITEMS.map((item) => { {MENU_ITEMS.map((item) => {

View File

@ -178,6 +178,7 @@ export const ModuleIssueQuickActions: React.FC<IQuickActionProps> = observer((pr
customButton={customActionButton} customButton={customActionButton}
portalElement={portalElement} portalElement={portalElement}
menuItemsClassName="z-[14]" menuItemsClassName="z-[14]"
maxHeight="lg"
closeOnSelect closeOnSelect
> >
{MENU_ITEMS.map((item) => { {MENU_ITEMS.map((item) => {

View File

@ -171,6 +171,7 @@ export const ProjectIssueQuickActions: React.FC<IQuickActionProps> = observer((p
customButton={customActionButton} customButton={customActionButton}
portalElement={portalElement} portalElement={portalElement}
menuItemsClassName="z-[14]" menuItemsClassName="z-[14]"
maxHeight="lg"
closeOnSelect closeOnSelect
> >
{MENU_ITEMS.map((item) => { {MENU_ITEMS.map((item) => {

View File

@ -0,0 +1,127 @@
import { observer } from "mobx-react";
import Link from "next/link";
import { ExternalLink, LinkIcon } from "lucide-react";
// ui
import { TStaticViewTypes } from "@plane/types";
import { ContextMenu, CustomMenu, TContextMenuItem, TOAST_TYPE, setToast } from "@plane/ui";
// helpers
import { cn } from "@/helpers/common.helper";
import { copyUrlToClipboard } from "@/helpers/string.helper";
type Props = {
parentRef: React.RefObject<HTMLElement>;
workspaceSlug: string;
globalViewId: string | undefined;
view: {
key: TStaticViewTypes;
label: string;
};
};
export const DefaultWorkspaceViewQuickActions: React.FC<Props> = observer((props) => {
const { parentRef, globalViewId, view, workspaceSlug } = props;
const viewLink = `${workspaceSlug}/workspace-views/${view.key}`;
const handleCopyText = () =>
copyUrlToClipboard(viewLink).then(() => {
setToast({
type: TOAST_TYPE.SUCCESS,
title: "Link Copied!",
message: "View link copied to clipboard.",
});
});
const handleOpenInNewTab = () => window.open(`/${viewLink}`, "_blank");
const MENU_ITEMS: TContextMenuItem[] = [
{
key: "open-new-tab",
action: handleOpenInNewTab,
title: "Open in new tab",
icon: ExternalLink,
},
{
key: "copy-link",
action: handleCopyText,
title: "Copy link",
icon: LinkIcon,
},
];
return (
<>
<ContextMenu parentRef={parentRef} items={MENU_ITEMS} />
<CustomMenu
customButton={
<>
{view.key === globalViewId ? (
<span
className={`flex min-w-min flex-shrink-0 whitespace-nowrap border-b-2 p-3 text-sm font-medium outline-none ${
view.key === globalViewId
? "border-custom-primary-100 text-custom-primary-100"
: "border-transparent hover:border-custom-border-200 hover:text-custom-text-400"
}`}
>
{view.label}
</span>
) : (
<Link
key={view.key}
id={`global-view-${view.key}`}
href={`/${workspaceSlug}/workspace-views/${view.key}`}
>
<span
className={`flex min-w-min flex-shrink-0 whitespace-nowrap border-b-2 p-3 text-sm font-medium outline-none ${
view.key === globalViewId
? "border-custom-primary-100 text-custom-primary-100"
: "border-transparent hover:border-custom-border-200 hover:text-custom-text-400"
}`}
>
{view.label}
</span>
</Link>
)}
</>
}
placement="bottom-end"
menuItemsClassName="z-20"
closeOnSelect
>
{MENU_ITEMS.map((item) => {
if (item.shouldRender === false) return null;
return (
<CustomMenu.MenuItem
key={item.key}
onClick={(e) => {
e.preventDefault();
e.stopPropagation();
item.action();
}}
className={cn(
"flex items-center gap-2",
{
"text-custom-text-400": item.disabled,
},
item.className
)}
>
{item.icon && <item.icon className={cn("h-3 w-3", item.iconClassName)} />}
<div>
<h5>{item.title}</h5>
{item.description && (
<p
className={cn("text-custom-text-300 whitespace-pre-line", {
"text-custom-text-400": item.disabled,
})}
>
{item.description}
</p>
)}
</div>
</CustomMenu.MenuItem>
);
})}
</CustomMenu>
</>
);
});

View File

@ -1,11 +1,16 @@
import React, { useEffect, useRef, useState } from "react"; import React, { useEffect, useRef, useState } from "react";
import { observer } from "mobx-react-lite"; import { observer } from "mobx-react-lite";
import Link from "next/link";
import { useRouter } from "next/router"; import { useRouter } from "next/router";
// icons // icons
import { Plus } from "lucide-react"; import { Plus } from "lucide-react";
// types
import { TStaticViewTypes } from "@plane/types";
// components // components
import { CreateUpdateWorkspaceViewModal } from "@/components/workspace"; import {
CreateUpdateWorkspaceViewModal,
DefaultWorkspaceViewQuickActions,
WorkspaceViewQuickActions,
} from "@/components/workspace";
// constants // constants
import { GLOBAL_VIEW_OPENED } from "@/constants/event-tracker"; import { GLOBAL_VIEW_OPENED } from "@/constants/event-tracker";
import { DEFAULT_GLOBAL_VIEWS_LIST, EUserWorkspaceRoles } from "@/constants/workspace"; import { DEFAULT_GLOBAL_VIEWS_LIST, EUserWorkspaceRoles } from "@/constants/workspace";
@ -14,6 +19,8 @@ import { useEventTracker, useGlobalView, useUser } from "@/hooks/store";
const ViewTab = observer((props: { viewId: string }) => { const ViewTab = observer((props: { viewId: string }) => {
const { viewId } = props; const { viewId } = props;
// refs
const parentRef = useRef<HTMLDivElement>(null);
// router // router
const router = useRouter(); const router = useRouter();
const { workspaceSlug, globalViewId } = router.query; const { workspaceSlug, globalViewId } = router.query;
@ -22,30 +29,54 @@ const ViewTab = observer((props: { viewId: string }) => {
const view = getViewDetailsById(viewId); const view = getViewDetailsById(viewId);
if (!view) return null; if (!view || !workspaceSlug || !globalViewId) return null;
return ( return (
<Link key={viewId} id={`global-view-${viewId}`} href={`/${workspaceSlug}/workspace-views/${viewId}`}> <div ref={parentRef} className="relative">
<span <WorkspaceViewQuickActions
className={`flex min-w-min flex-shrink-0 whitespace-nowrap border-b-2 p-3 text-sm font-medium outline-none ${ parentRef={parentRef}
viewId === globalViewId view={view}
? "border-custom-primary-100 text-custom-primary-100" viewId={viewId}
: "border-transparent hover:border-custom-border-200 hover:text-custom-text-400" globalViewId={globalViewId?.toString()}
}`} workspaceSlug={workspaceSlug?.toString()}
> />
{view.name} </div>
</span>
</Link>
); );
}); });
const DefaultViewTab = (props: {
tab: {
key: TStaticViewTypes;
label: string;
};
}) => {
const { tab } = props;
// refs
const parentRef = useRef<HTMLDivElement>(null);
// router
const router = useRouter();
const { workspaceSlug, globalViewId } = router.query;
if (!workspaceSlug || !globalViewId) return null;
return (
<div key={tab.key} ref={parentRef} className="relative">
<DefaultWorkspaceViewQuickActions
parentRef={parentRef}
globalViewId={globalViewId?.toString()}
workspaceSlug={workspaceSlug?.toString()}
view={tab}
/>
</div>
);
};
export const GlobalViewsHeader: React.FC = observer(() => { export const GlobalViewsHeader: React.FC = observer(() => {
// states // states
const [createViewModal, setCreateViewModal] = useState(false); const [createViewModal, setCreateViewModal] = useState(false);
const containerRef = useRef<HTMLDivElement>(null); const containerRef = useRef<HTMLDivElement>(null);
// router // router
const router = useRouter(); const router = useRouter();
const { workspaceSlug, globalViewId } = router.query; const { globalViewId } = router.query;
// store hooks // store hooks
const { currentWorkspaceViews } = useGlobalView(); const { currentWorkspaceViews } = useGlobalView();
const { const {
@ -82,23 +113,11 @@ export const GlobalViewsHeader: React.FC = observer(() => {
ref={containerRef} ref={containerRef}
className="flex w-full items-center overflow-x-auto px-4 horizontal-scrollbar scrollbar-sm" className="flex w-full items-center overflow-x-auto px-4 horizontal-scrollbar scrollbar-sm"
> >
{DEFAULT_GLOBAL_VIEWS_LIST.map((tab) => ( {DEFAULT_GLOBAL_VIEWS_LIST.map((tab, index) => (
<Link key={tab.key} id={`global-view-${tab.key}`} href={`/${workspaceSlug}/workspace-views/${tab.key}`}> <DefaultViewTab key={`${tab.key}-${index}`} tab={tab} />
<span
className={`flex min-w-min flex-shrink-0 whitespace-nowrap border-b-2 p-3 text-sm font-medium outline-none ${
tab.key === globalViewId
? "border-custom-primary-100 text-custom-primary-100"
: "border-transparent hover:border-custom-border-200 hover:text-custom-text-400"
}`}
>
{tab.label}
</span>
</Link>
))} ))}
{currentWorkspaceViews?.map((viewId) => ( {currentWorkspaceViews?.map((viewId) => <ViewTab key={viewId} viewId={viewId} />)}
<ViewTab key={viewId} viewId={viewId} />
))}
</div> </div>
{isAuthorizedUser && ( {isAuthorizedUser && (

View File

@ -5,3 +5,5 @@ export * from "./header";
export * from "./modal"; export * from "./modal";
export * from "./view-list-item"; export * from "./view-list-item";
export * from "./views-list"; export * from "./views-list";
export * from "./quick-action";
export * from "./default-view-quick-action";

View File

@ -0,0 +1,155 @@
import { useState } from "react";
import { observer } from "mobx-react";
import Link from "next/link";
import { ExternalLink, LinkIcon, Pencil, Trash2 } from "lucide-react";
// types
import { IWorkspaceView } from "@plane/types";
// ui
import { ContextMenu, CustomMenu, TContextMenuItem, TOAST_TYPE, setToast } from "@plane/ui";
// components
import { CreateUpdateWorkspaceViewModal, DeleteGlobalViewModal } from "@/components/workspace";
// constants
import { EUserProjectRoles } from "@/constants/project";
// helpers
import { cn } from "@/helpers/common.helper";
import { copyUrlToClipboard } from "@/helpers/string.helper";
// hooks
import { useUser } from "@/hooks/store";
type Props = {
parentRef: React.RefObject<HTMLElement>;
workspaceSlug: string;
globalViewId: string;
viewId: string;
view: IWorkspaceView;
};
export const WorkspaceViewQuickActions: React.FC<Props> = observer((props) => {
const { parentRef, view, globalViewId, viewId, workspaceSlug } = props;
// states
const [updateViewModal, setUpdateViewModal] = useState(false);
const [deleteViewModal, setDeleteViewModal] = useState(false);
// store hooks
const {
membership: { currentWorkspaceRole },
} = useUser();
// auth
const isEditingAllowed = !!currentWorkspaceRole && currentWorkspaceRole >= EUserProjectRoles.MEMBER;
const viewLink = `${workspaceSlug}/workspace-views/${view.id}`;
const handleCopyText = () =>
copyUrlToClipboard(viewLink).then(() => {
setToast({
type: TOAST_TYPE.SUCCESS,
title: "Link Copied!",
message: "View link copied to clipboard.",
});
});
const handleOpenInNewTab = () => window.open(`/${viewLink}`, "_blank");
const MENU_ITEMS: TContextMenuItem[] = [
{
key: "edit",
action: () => setUpdateViewModal(true),
title: "Edit",
icon: Pencil,
shouldRender: isEditingAllowed,
},
{
key: "open-new-tab",
action: handleOpenInNewTab,
title: "Open in new tab",
icon: ExternalLink,
},
{
key: "copy-link",
action: handleCopyText,
title: "Copy link",
icon: LinkIcon,
},
{
key: "delete",
action: () => setDeleteViewModal(true),
title: "Delete",
icon: Trash2,
shouldRender: isEditingAllowed,
},
];
return (
<>
<CreateUpdateWorkspaceViewModal data={view} isOpen={updateViewModal} onClose={() => setUpdateViewModal(false)} />
<DeleteGlobalViewModal data={view} isOpen={deleteViewModal} onClose={() => setDeleteViewModal(false)} />
<ContextMenu parentRef={parentRef} items={MENU_ITEMS} />
<CustomMenu
customButton={
<>
{viewId === globalViewId ? (
<span
className={`flex min-w-min flex-shrink-0 whitespace-nowrap border-b-2 p-3 text-sm font-medium outline-none ${
viewId === globalViewId
? "border-custom-primary-100 text-custom-primary-100"
: "border-transparent hover:border-custom-border-200 hover:text-custom-text-400"
}`}
>
{view.name}
</span>
) : (
<Link key={viewId} id={`global-view-${viewId}`} href={`/${workspaceSlug}/workspace-views/${viewId}`}>
<span
className={`flex min-w-min flex-shrink-0 whitespace-nowrap border-b-2 p-3 text-sm font-medium outline-none ${
viewId === globalViewId
? "border-custom-primary-100 text-custom-primary-100"
: "border-transparent hover:border-custom-border-200 hover:text-custom-text-400"
}`}
>
{view.name}
</span>
</Link>
)}
</>
}
placement="bottom-end"
menuItemsClassName="z-20"
closeOnSelect
>
{MENU_ITEMS.map((item) => {
if (item.shouldRender === false) return null;
return (
<CustomMenu.MenuItem
key={item.key}
onClick={(e) => {
e.preventDefault();
e.stopPropagation();
item.action();
}}
className={cn(
"flex items-center gap-2",
{
"text-custom-text-400": item.disabled,
},
item.className
)}
>
{item.icon && <item.icon className={cn("h-3 w-3", item.iconClassName)} />}
<div>
<h5>{item.title}</h5>
{item.description && (
<p
className={cn("text-custom-text-300 whitespace-pre-line", {
"text-custom-text-400": item.disabled,
})}
>
{item.description}
</p>
)}
</div>
</CustomMenu.MenuItem>
);
})}
</CustomMenu>
</>
);
});