π₯π₯π₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.
TypeScript boardsbug-trackerdjangodockerganttissue-trackerjirajira-alternativekanbanlinearpostgresqlproduct-managementproject-managementproject-planningpythonreactredistypesciptvitework-management
refactor: favorites sidebar implementation (#6716)
Aaryan Khandelwalcb344ea1f5de
diff --git a/web/ce/constants/index.ts b/web/ce/constants/index.tsindex 895c18c3db..1a86ad1e24 100644--- a/web/ce/constants/index.ts+++ b/web/ce/constants/index.ts@@ -2,3 +2,4 @@ export * from "./ai";export * from "./estimates";export * from "./gantt-chart";export * from "./project";+export * from "./sidebar-favorites";diff --git a/web/ce/constants/sidebar-favorites.ts b/web/ce/constants/sidebar-favorites.tsnew file mode 100644index 0000000000..9fa80e05f4--- /dev/null+++ b/web/ce/constants/sidebar-favorites.ts@@ -0,0 +1,41 @@+import { Briefcase, ContrastIcon, FileText, Layers, LucideIcon } from "lucide-react";+// plane imports+import { IFavorite } from "@plane/types";+import { DiceIcon, FavoriteFolderIcon, ISvgIcons } from "@plane/ui";++export const FAVORITE_ITEM_ICONS: Record<string, React.FC<ISvgIcons> | LucideIcon> = {+ page: FileText,+ project: Briefcase,+ view: Layers,+ module: DiceIcon,+ cycle: ContrastIcon,+ folder: FavoriteFolderIcon,+};++export const FAVORITE_ITEM_LINKS: {+ [key: string]: {+ itemLevel: "project" | "workspace";+ getLink: (favorite: IFavorite) => string;+ };+} = {+ project: {+ itemLevel: "project",+ getLink: () => `issues`,+ },+ cycle: {+ itemLevel: "project",+ getLink: (favorite) => `cycles/${favorite.entity_identifier}`,+ },+ module: {+ itemLevel: "project",+ getLink: (favorite) => `modules/${favorite.entity_identifier}`,+ },+ view: {+ itemLevel: "project",+ getLink: (favorite) => `views/${favorite.entity_identifier}`,+ },+ page: {+ itemLevel: "project",+ getLink: (favorite) => `pages/${favorite.entity_identifier}`,+ },+};diff --git a/web/ce/hooks/use-additional-favorite-item-details.ts b/web/ce/hooks/use-additional-favorite-item-details.tsnew file mode 100644index 0000000000..412f4a39a2--- /dev/null+++ b/web/ce/hooks/use-additional-favorite-item-details.ts@@ -0,0 +1,26 @@+// plane imports+import { IFavorite } from "@plane/types";+// components+import { getFavoriteItemIcon } from "@/components/workspace/sidebar/favorites/favorite-items/common";++export const useAdditionalFavoriteItemDetails = () => {+ const getAdditionalFavoriteItemDetails = (_workspaceSlug: string, favorite: IFavorite) => {+ const { entity_type: favoriteItemEntityType } = favorite;+ const favoriteItemName = favorite?.entity_data?.name || favorite?.name;++ let itemIcon;+ let itemTitle;++ switch (favoriteItemEntityType) {+ default:+ itemTitle = favoriteItemName;+ itemIcon = getFavoriteItemIcon(favoriteItemEntityType);+ break;+ }+ return { itemIcon, itemTitle };+ };++ return {+ getAdditionalFavoriteItemDetails,+ };+};diff --git a/web/core/components/workspace/sidebar/favorites/favorite-items/common/helper.tsx b/web/core/components/workspace/sidebar/favorites/favorite-items/common/helper.tsxindex e2f303afe7..670f9ba116 100644--- a/web/core/components/workspace/sidebar/favorites/favorite-items/common/helper.tsx+++ b/web/core/components/workspace/sidebar/favorites/favorite-items/common/helper.tsx@@ -1,49 +1,45 @@"use client";-// lucide-import { Briefcase, FileText, Layers } from "lucide-react";-// types++import { FileText } from "lucide-react";+// plane importsimport { IFavorite, TLogoProps } from "@plane/types";-// ui-import { ContrastIcon, DiceIcon, FavoriteFolderIcon } from "@plane/ui";+// componentsimport { Logo } from "@/components/common";+// plane web constants+import { FAVORITE_ITEM_ICONS, FAVORITE_ITEM_LINKS } from "@/plane-web/constants";-const iconClassName = `flex-shrink-0 size-4 stroke-[1.5] m-auto`;+export const getFavoriteItemIcon = (type: string, logo?: TLogoProps | undefined) => {+ const Icon = FAVORITE_ITEM_ICONS[type] || FileText;-export const FAVORITE_ITEM_ICON: Record<string, JSX.Element> = {- page: <FileText className={iconClassName} />,- project: <Briefcase className={iconClassName} />,- view: <Layers className={iconClassName} />,- module: <DiceIcon className={iconClassName} />,- cycle: <ContrastIcon className={iconClassName} />,- folder: <FavoriteFolderIcon className={iconClassName} />,+ return (+ <>+ <div className="hidden group-hover:flex items-center justify-center size-5">+ <Icon className="flex-shrink-0 size-4 stroke-[1.5] m-auto" />+ </div>+ <div className="flex items-center justify-center size-5 group-hover:hidden">+ {logo?.in_use ? (+ <Logo logo={logo} size={16} type={type === "project" ? "material" : "lucide"} />+ ) : (+ <Icon className="flex-shrink-0 size-4 stroke-[1.5] m-auto" />+ )}+ </div>+ </>+ );};-export const getFavoriteItemIcon = (type: string, logo?: TLogoProps | undefined) => (- <>- <div className="hidden group-hover:flex items-center justify-center size-5">- {FAVORITE_ITEM_ICON[type] || <FileText className={iconClassName} />}- </div>- <div className="flex items-center justify-center size-5 group-hover:hidden">- {logo?.in_use ? (- <Logo logo={logo} size={16} type={type === "project" ? "material" : "lucide"} />- ) : (- FAVORITE_ITEM_ICON[type] || <FileText className={iconClassName} />- )}- </div>- </>-);+export const generateFavoriteItemLink = (workspaceSlug: string, favorite: IFavorite) => {+ const entityLinkDetails = FAVORITE_ITEM_LINKS[favorite.entity_type];-const entityPaths: Record<string, string> = {- project: "issues",- cycle: "cycles",- module: "modules",- view: "views",- page: "pages",-};+ if (!entityLinkDetails) {+ console.error(`Unrecognized favorite entity type: ${favorite.entity_type}`);+ return `/${workspaceSlug}`;+ }-export const generateFavoriteItemLink = (workspaceSlug: string, favorite: IFavorite) => {- const entityPath = entityPaths[favorite.entity_type];- return entityPath- ? `/${workspaceSlug}/projects/${favorite.project_id}/${entityPath}/${entityPath === "issues" ? "" : favorite.entity_identifier || ""}`- : `/${workspaceSlug}`;+ if (entityLinkDetails.itemLevel === "workspace") {+ return `/${workspaceSlug}/${entityLinkDetails.getLink(favorite)}`;+ } else if (entityLinkDetails.itemLevel === "project") {+ return `/${workspaceSlug}/projects/${favorite.project_id}/${entityLinkDetails.getLink(favorite)}`;+ } else {+ return `/${workspaceSlug}`;+ }};diff --git a/web/core/hooks/use-favorite-item-details.tsx b/web/core/hooks/use-favorite-item-details.tsxindex b873ad07b5..343e143ed8 100644--- a/web/core/hooks/use-favorite-item-details.tsx+++ b/web/core/hooks/use-favorite-item-details.tsx@@ -1,4 +1,4 @@-// plane types+// plane importsimport { IFavorite } from "@plane/types";// componentsimport {@@ -11,19 +11,22 @@ import { getPageName } from "@/helpers/page.helper";import { useProject, useProjectView, useCycle, useModule } from "@/hooks/store";// plane web hooksimport { EPageStoreType, usePage } from "@/plane-web/hooks/store";+import { useAdditionalFavoriteItemDetails } from "@/plane-web/hooks/use-additional-favorite-item-details";export const useFavoriteItemDetails = (workspaceSlug: string, favorite: IFavorite) => {- const favoriteItemId = favorite?.entity_identifier;- const favoriteItemLogoProps = favorite?.entity_data?.logo_props;+ const {+ entity_identifier: favoriteItemId,+ entity_data: { logo_props: favoriteItemLogoProps },+ entity_type: favoriteItemEntityType,+ } = favorite;const favoriteItemName = favorite?.entity_data?.name || favorite?.name;- const favoriteItemEntityType = favorite?.entity_type;-// store hooksconst { getViewById } = useProjectView();const { getProjectById } = useProject();const { getCycleById } = useCycle();const { getModuleById } = useModule();-+ // additional details+ const { getAdditionalFavoriteItemDetails } = useAdditionalFavoriteItemDetails();// derived valuesconst pageDetail = usePage({pageId: favoriteItemId ?? "",@@ -32,7 +35,6 @@ export const useFavoriteItemDetails = (workspaceSlug: string, favorite: IFavoritconst viewDetails = getViewById(favoriteItemId ?? "");const cycleDetail = getCycleById(favoriteItemId ?? "");const moduleDetail = getModuleById(favoriteItemId ?? "");-const currentProjectDetails = getProjectById(favorite.project_id ?? "");let itemIcon;@@ -60,10 +62,12 @@ export const useFavoriteItemDetails = (workspaceSlug: string, favorite: IFavorititemTitle = moduleDetail?.name || favoriteItemName;itemIcon = getFavoriteItemIcon("module");break;- default:- itemTitle = favoriteItemName;- itemIcon = getFavoriteItemIcon(favoriteItemEntityType);+ default: {+ const additionalDetails = getAdditionalFavoriteItemDetails(workspaceSlug, favorite);+ itemTitle = additionalDetails.itemTitle;+ itemIcon = additionalDetails.itemIcon;break;+ }}return { itemIcon, itemTitle, itemLink };diff --git a/web/ee/constants/index.ts b/web/ee/constants/index.tsnew file mode 100644index 0000000000..049f831bdf--- /dev/null+++ b/web/ee/constants/index.ts@@ -0,0 +1 @@+export * from "./sidebar-favorites";diff --git a/web/ee/constants/sidebar-favorites.ts b/web/ee/constants/sidebar-favorites.tsnew file mode 100644index 0000000000..540c918e73--- /dev/null+++ b/web/ee/constants/sidebar-favorites.ts@@ -0,0 +1 @@+export * from "ce/constants/sidebar-favorites";diff --git a/web/ee/hooks/use-additional-favorite-item-details.ts b/web/ee/hooks/use-additional-favorite-item-details.tsnew file mode 100644index 0000000000..c3e863cea0--- /dev/null+++ b/web/ee/hooks/use-additional-favorite-item-details.ts@@ -0,0 +1 @@+export * from "ce/hooks/use-additional-favorite-item-details";