Skip to content

armgit / plane

Public Imported from GitHub
0

πŸ”₯πŸ”₯πŸ”₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.

[WEB-4779] chore: app sidebar wrapper component for consistency and reusability (#7655)

Anmol Singh Bhatiacfe710d492e5
diff --git a/apps/web/app/(all)/[workspaceSlug]/(projects)/sidebar.tsx b/apps/web/app/(all)/[workspaceSlug]/(projects)/sidebar.tsx
index 2fd3218c07..f392746443 100644
--- a/apps/web/app/(all)/[workspaceSlug]/(projects)/sidebar.tsx
+++ b/apps/web/app/(all)/[workspaceSlug]/(projects)/sidebar.tsx
@@ -1,36 +1,24 @@
-import { FC, useEffect, useRef } from "react";
+import { FC } from "react";
import isEmpty from "lodash/isEmpty";
import { observer } from "mobx-react";
// plane helpers
import { EUserPermissions, EUserPermissionsLevel } from "@plane/constants";
-import { useOutsideClickDetector } from "@plane/hooks";
// components
-import { AppSidebarToggleButton } from "@/components/sidebar/sidebar-toggle-button";
-import { SidebarDropdown } from "@/components/workspace/sidebar/dropdown";
+import { SidebarWrapper } from "@/components/sidebar/sidebar-wrapper";
import { SidebarFavoritesMenu } from "@/components/workspace/sidebar/favorites/favorites-menu";
-import { HelpMenu } from "@/components/workspace/sidebar/help-menu";
import { SidebarProjectsList } from "@/components/workspace/sidebar/projects-list";
import { SidebarQuickActions } from "@/components/workspace/sidebar/quick-actions";
import { SidebarMenuItems } from "@/components/workspace/sidebar/sidebar-menu-items";
// hooks
-import { useAppTheme } from "@/hooks/store/use-app-theme";
import { useFavorite } from "@/hooks/store/use-favorite";
import { useUserPermissions } from "@/hooks/store/user";
-import { useAppRail } from "@/hooks/use-app-rail";
-import useSize from "@/hooks/use-window-size";
// plane web components
-import { WorkspaceEditionBadge } from "@/plane-web/components/workspace/edition-badge";
import { SidebarTeamsList } from "@/plane-web/components/workspace/sidebar/teams-sidebar-list";
export const AppSidebar: FC = observer(() => {
// store hooks
const { allowPermissions } = useUserPermissions();
- const { toggleSidebar, sidebarCollapsed } = useAppTheme();
- const { shouldRenderAppRail, isEnabled: isAppRailEnabled } = useAppRail();
const { groupedFavorites } = useFavorite();
- const windowSize = useSize();
- // refs
- const ref = useRef<HTMLDivElement>(null);
// derived values
const canPerformWorkspaceMemberActions = allowPermissions(
@@ -38,55 +26,17 @@ export const AppSidebar: FC = observer(() => {
EUserPermissionsLevel.WORKSPACE
);
- useOutsideClickDetector(ref, () => {
- if (sidebarCollapsed === false) {
- if (window.innerWidth < 768) {
- toggleSidebar();
- }
- }
- });
-
- useEffect(() => {
- if (windowSize[0] < 768 && !sidebarCollapsed) toggleSidebar();
- // eslint-disable-next-line react-hooks/exhaustive-deps
- }, [windowSize]);
-
const isFavoriteEmpty = isEmpty(groupedFavorites);
return (
- <>
- <div className="flex flex-col gap-3 px-3">
- {/* Workspace switcher and settings */}
- {!shouldRenderAppRail && <SidebarDropdown />}
-
- {isAppRailEnabled && (
- <div className="flex items-center justify-between gap-2">
- <span className="text-md text-custom-text-200 font-medium pt-1">Projects</span>
- <div className="flex items-center gap-2">
- <AppSidebarToggleButton />
- </div>
- </div>
- )}
- {/* Quick actions */}
- <SidebarQuickActions />
- </div>
- <div className="flex flex-col gap-3 overflow-x-hidden scrollbar-sm h-full w-full overflow-y-auto vertical-scrollbar px-3 pt-3 pb-0.5">
- <SidebarMenuItems />
- {/* Favorites Menu */}
- {canPerformWorkspaceMemberActions && !isFavoriteEmpty && <SidebarFavoritesMenu />}
- {/* Teams List */}
- <SidebarTeamsList />
- {/* Projects List */}
- <SidebarProjectsList />
- </div>
- {/* Help Section */}
- <div className="flex items-center justify-between p-3 border-t border-custom-border-200 bg-custom-sidebar-background-100 h-12">
- <WorkspaceEditionBadge />
- <div className="flex items-center gap-2">
- {!shouldRenderAppRail && <HelpMenu />}
- {!isAppRailEnabled && <AppSidebarToggleButton />}
- </div>
- </div>
- </>
+ <SidebarWrapper title="Projects" quickActions={<SidebarQuickActions />}>
+ <SidebarMenuItems />
+ {/* Favorites Menu */}
+ {canPerformWorkspaceMemberActions && !isFavoriteEmpty && <SidebarFavoritesMenu />}
+ {/* Teams List */}
+ <SidebarTeamsList />
+ {/* Projects List */}
+ <SidebarProjectsList />
+ </SidebarWrapper>
);
});
diff --git a/apps/web/core/components/sidebar/sidebar-wrapper.tsx b/apps/web/core/components/sidebar/sidebar-wrapper.tsx
new file mode 100644
index 0000000000..386f590cd7
--- /dev/null
+++ b/apps/web/core/components/sidebar/sidebar-wrapper.tsx
@@ -0,0 +1,72 @@
+import { FC, useEffect, useRef } from "react";
+import { observer } from "mobx-react";
+// plane helpers
+import { useOutsideClickDetector } from "@plane/hooks";
+// components
+import { AppSidebarToggleButton } from "@/components/sidebar/sidebar-toggle-button";
+import { SidebarDropdown } from "@/components/workspace/sidebar/dropdown";
+import { HelpMenu } from "@/components/workspace/sidebar/help-menu";
+// hooks
+import { useAppTheme } from "@/hooks/store/use-app-theme";
+import { useAppRail } from "@/hooks/use-app-rail";
+import useSize from "@/hooks/use-window-size";
+// plane web components
+import { WorkspaceEditionBadge } from "@/plane-web/components/workspace/edition-badge";
+
+type TSidebarWrapperProps = {
+ title: string;
+ children: React.ReactNode;
+ quickActions?: React.ReactNode;
+};
+
+export const SidebarWrapper: FC<TSidebarWrapperProps> = observer((props) => {
+ const { children, title, quickActions } = props;
+ // store hooks
+ const { toggleSidebar, sidebarCollapsed } = useAppTheme();
+ const { shouldRenderAppRail, isEnabled: isAppRailEnabled } = useAppRail();
+ const windowSize = useSize();
+ // refs
+ const ref = useRef<HTMLDivElement>(null);
+
+ useOutsideClickDetector(ref, () => {
+ if (sidebarCollapsed === false && window.innerWidth < 768) {
+ toggleSidebar();
+ }
+ });
+
+ useEffect(() => {
+ if (windowSize[0] < 768 && !sidebarCollapsed) toggleSidebar();
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ }, [windowSize]);
+
+ return (
+ <div ref={ref} className="flex flex-col h-full w-full">
+ <div className="flex flex-col gap-3 px-3">
+ {/* Workspace switcher and settings */}
+ {!shouldRenderAppRail && <SidebarDropdown />}
+
+ {isAppRailEnabled && (
+ <div className="flex items-center justify-between gap-2">
+ <span className="text-md text-custom-text-200 font-medium pt-1">{title}</span>
+ <div className="flex items-center gap-2">
+ <AppSidebarToggleButton />
+ </div>
+ </div>
+ )}
+ {/* Quick actions */}
+ {quickActions}
+ </div>
+ <div className="flex flex-col gap-3 overflow-x-hidden scrollbar-sm h-full w-full overflow-y-auto vertical-scrollbar px-3 pt-3 pb-0.5">
+ {children}
+ </div>
+ {/* Help Section */}
+ <div className="flex items-center justify-between p-3 border-t border-custom-border-200 bg-custom-sidebar-background-100 h-12">
+ <WorkspaceEditionBadge />
+ <div className="flex items-center gap-2">
+ {!shouldRenderAppRail && <HelpMenu />}
+ {!isAppRailEnabled && <AppSidebarToggleButton />}
+ </div>
+ </div>
+ </div>
+ );
+});