-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
[WEB-2818] chore: project navigation items code refactor #6170
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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 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 |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| export * from "./app-switcher"; | ||
| export * from "./project-navigation-root"; |
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,15 @@ | ||
| "use client"; | ||
|
|
||
| import { FC } from "react"; | ||
| // components | ||
| import { ProjectNavigation } from "@/components/workspace"; | ||
|
|
||
| type TProjectItemsRootProps = { | ||
| workspaceSlug: string; | ||
| projectId: string; | ||
| }; | ||
|
|
||
| export const ProjectNavigationRoot: FC<TProjectItemsRootProps> = (props) => { | ||
| const { workspaceSlug, projectId } = props; | ||
| return <ProjectNavigation workspaceSlug={workspaceSlug} projectId={projectId} />; | ||
| }; |
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
163 changes: 163 additions & 0 deletions
163
web/core/components/workspace/sidebar/project-navigation.tsx
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,163 @@ | ||
| "use client"; | ||
|
|
||
| import React, { FC, useCallback, useMemo } from "react"; | ||
| import { observer } from "mobx-react"; | ||
| import Link from "next/link"; | ||
| import { usePathname } from "next/navigation"; | ||
| import { FileText, Layers } from "lucide-react"; | ||
| // plane ui | ||
| import { Tooltip, DiceIcon, ContrastIcon, LayersIcon, Intake } from "@plane/ui"; | ||
| // components | ||
| import { SidebarNavItem } from "@/components/sidebar"; | ||
| // hooks | ||
| import { useAppTheme, useProject, useUserPermissions } from "@/hooks/store"; | ||
| import { usePlatformOS } from "@/hooks/use-platform-os"; | ||
| // plane-web constants | ||
| import { EUserPermissions } from "@/plane-web/constants"; | ||
| import { EUserPermissionsLevel } from "@/plane-web/constants/user-permissions"; | ||
|
|
||
| export type TNavigationItem = { | ||
| name: string; | ||
| href: string; | ||
| icon: React.ElementType; | ||
| access: EUserPermissions[]; | ||
| shouldRender: boolean; | ||
| sortOrder: number; | ||
| }; | ||
|
|
||
| type TProjectItemsProps = { | ||
| workspaceSlug: string; | ||
| projectId: string; | ||
| additionalNavigationItems?: (workspaceSlug: string, projectId: string) => TNavigationItem[]; | ||
| }; | ||
|
|
||
| export const ProjectNavigation: FC<TProjectItemsProps> = observer((props) => { | ||
| const { workspaceSlug, projectId, additionalNavigationItems } = props; | ||
| // store hooks | ||
| const { sidebarCollapsed: isSidebarCollapsed, toggleSidebar } = useAppTheme(); | ||
| const { getProjectById } = useProject(); | ||
| const { isMobile } = usePlatformOS(); | ||
| const { allowPermissions } = useUserPermissions(); | ||
| // pathname | ||
| const pathname = usePathname(); | ||
| // derived values | ||
| const project = getProjectById(projectId); | ||
| // handlers | ||
| const handleProjectClick = () => { | ||
| if (window.innerWidth < 768) { | ||
| toggleSidebar(); | ||
| } | ||
| }; | ||
|
|
||
| if (!project) return null; | ||
|
|
||
| const baseNavigation = useCallback( | ||
| (workspaceSlug: string, projectId: string): TNavigationItem[] => [ | ||
| { | ||
| name: "Issues", | ||
| href: `/${workspaceSlug}/projects/${projectId}/issues`, | ||
| icon: LayersIcon, | ||
| access: [EUserPermissions.ADMIN, EUserPermissions.MEMBER, EUserPermissions.GUEST], | ||
| shouldRender: true, | ||
| sortOrder: 1, | ||
| }, | ||
| { | ||
| name: "Cycles", | ||
| href: `/${workspaceSlug}/projects/${projectId}/cycles`, | ||
| icon: ContrastIcon, | ||
| access: [EUserPermissions.ADMIN, EUserPermissions.MEMBER], | ||
| shouldRender: project.cycle_view, | ||
| sortOrder: 2, | ||
| }, | ||
| { | ||
| name: "Modules", | ||
| href: `/${workspaceSlug}/projects/${projectId}/modules`, | ||
| icon: DiceIcon, | ||
| access: [EUserPermissions.ADMIN, EUserPermissions.MEMBER], | ||
| shouldRender: project.module_view, | ||
| sortOrder: 3, | ||
| }, | ||
| { | ||
| name: "Views", | ||
| href: `/${workspaceSlug}/projects/${projectId}/views`, | ||
| icon: Layers, | ||
| access: [EUserPermissions.ADMIN, EUserPermissions.MEMBER, EUserPermissions.GUEST], | ||
| shouldRender: project.issue_views_view, | ||
| sortOrder: 4, | ||
| }, | ||
| { | ||
| name: "Pages", | ||
| href: `/${workspaceSlug}/projects/${projectId}/pages`, | ||
| icon: FileText, | ||
| access: [EUserPermissions.ADMIN, EUserPermissions.MEMBER, EUserPermissions.GUEST], | ||
| shouldRender: project.page_view, | ||
| sortOrder: 5, | ||
| }, | ||
| { | ||
| name: "Intake", | ||
| href: `/${workspaceSlug}/projects/${projectId}/inbox`, | ||
| icon: Intake, | ||
| access: [EUserPermissions.ADMIN, EUserPermissions.MEMBER, EUserPermissions.GUEST], | ||
| shouldRender: project.inbox_view, | ||
| sortOrder: 6, | ||
| }, | ||
| ], | ||
| [project] | ||
| ); | ||
|
|
||
| // memoized navigation items and adding additional navigation items | ||
| const navigationItemsMemo = useMemo(() => { | ||
| const navigationItems = (workspaceSlug: string, projectId: string): TNavigationItem[] => { | ||
| const navItems = baseNavigation(workspaceSlug, projectId); | ||
|
|
||
| if (additionalNavigationItems) { | ||
| navItems.push(...additionalNavigationItems(workspaceSlug, projectId)); | ||
| } | ||
|
|
||
| return navItems; | ||
| }; | ||
|
|
||
| // sort navigation items by sortOrder | ||
| const sortedNavigationItems = navigationItems(workspaceSlug, projectId).sort( | ||
| (a, b) => (a.sortOrder || 0) - (b.sortOrder || 0) | ||
| ); | ||
|
|
||
| return sortedNavigationItems; | ||
| }, [workspaceSlug, projectId, baseNavigation, additionalNavigationItems]); | ||
|
|
||
| return ( | ||
| <> | ||
| {navigationItemsMemo.map((item) => { | ||
| if (!item.shouldRender) return; | ||
|
|
||
| const hasAccess = allowPermissions(item.access, EUserPermissionsLevel.PROJECT, workspaceSlug, project.id); | ||
| if (!hasAccess) return null; | ||
|
|
||
| return ( | ||
| <Tooltip | ||
| key={item.name} | ||
| isMobile={isMobile} | ||
| tooltipContent={`${project?.name}: ${item.name}`} | ||
| position="right" | ||
| className="ml-2" | ||
| disabled={!isSidebarCollapsed} | ||
| > | ||
| <Link href={item.href} onClick={handleProjectClick}> | ||
| <SidebarNavItem | ||
| className={`pl-[18px] ${isSidebarCollapsed ? "p-0 size-7 justify-center mx-auto" : ""}`} | ||
| isActive={pathname.includes(item.href)} | ||
| > | ||
| <div className="flex items-center gap-1.5 py-[1px]"> | ||
| <item.icon | ||
| className={`flex-shrink-0 size-4 ${item.name === "Intake" ? "stroke-1" : "stroke-[1.5]"}`} | ||
| /> | ||
| {!isSidebarCollapsed && <span className="text-xs font-medium">{item.name}</span>} | ||
| </div> | ||
| </SidebarNavItem> | ||
| </Link> | ||
| </Tooltip> | ||
| ); | ||
| })} | ||
| </> | ||
| ); | ||
| }); |
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
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.
Critical: Required imports are missing
Several icons and UI components that are used in the component are missing from the imports. This will cause runtime errors.
Add back the following imports:
Also applies to: 18-18