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-2917] Fix home widget (#6560)

Akshita Goyal456c7f55a963
diff --git a/packages/i18n/src/locales/en/translations.json b/packages/i18n/src/locales/en/translations.json
index a1705deceb..32eb6b64f7 100644
--- a/packages/i18n/src/locales/en/translations.json
+++ b/packages/i18n/src/locales/en/translations.json
@@ -376,6 +376,8 @@
"home": {
"empty": {
+ "quickstart_guide": "Your quickstart guide",
+ "not_right_now": "Not right now",
"create_project": {
"title": "Create a project",
"description": "Most things start with a project in Plane.",
diff --git a/packages/i18n/src/locales/es/translations.json b/packages/i18n/src/locales/es/translations.json
index 1b38b1cbe0..c7a3da312d 100644
--- a/packages/i18n/src/locales/es/translations.json
+++ b/packages/i18n/src/locales/es/translations.json
@@ -546,6 +546,8 @@
"home": {
"empty": {
+ "quickstart_guide": "Guía de inicio rápido",
+ "not_right_now": "Ahora no",
"create_project": {
"title": "Crear un proyecto",
"description": "La mayoría de las cosas comienzan con un proyecto en Plane.",
diff --git a/packages/i18n/src/locales/fr/translations.json b/packages/i18n/src/locales/fr/translations.json
index c67ceceaf2..83b1b31db1 100644
--- a/packages/i18n/src/locales/fr/translations.json
+++ b/packages/i18n/src/locales/fr/translations.json
@@ -546,6 +546,8 @@
"home": {
"empty": {
+ "quickstart_guide": "Guide de démarrage rapide",
+ "not_right_now": "Pas maintenant",
"create_project": {
"title": "Créer un projet",
"description": "La plupart des choses commencent par un projet dans Plane.",
diff --git a/packages/i18n/src/locales/ja/translations.json b/packages/i18n/src/locales/ja/translations.json
index 3b71443fa0..d34a26aaae 100644
--- a/packages/i18n/src/locales/ja/translations.json
+++ b/packages/i18n/src/locales/ja/translations.json
@@ -546,6 +546,8 @@
"home": {
"empty": {
+ "quickstart_guide": "クイックスタートガイド",
+ "not_right_now": "今はしない",
"create_project": {
"title": "プロジェクトを作成",
"description": "Planeのほとんどはプロジェクトから始まります。",
diff --git a/packages/i18n/src/locales/zh-CN/translations.json b/packages/i18n/src/locales/zh-CN/translations.json
index 3bfe142ea8..f715a21ae5 100644
--- a/packages/i18n/src/locales/zh-CN/translations.json
+++ b/packages/i18n/src/locales/zh-CN/translations.json
@@ -546,6 +546,8 @@
"home": {
"empty": {
+ "quickstart_guide": "快速入门指南",
+ "not_right_now": "暂时不要",
"create_project": {
"title": "创建项目",
"description": "在Plane中,大多数事情都从项目开始。",
diff --git a/web/core/components/home/home-dashboard-widgets.tsx b/web/core/components/home/home-dashboard-widgets.tsx
index e391567c4d..75daa83646 100644
--- a/web/core/components/home/home-dashboard-widgets.tsx
+++ b/web/core/components/home/home-dashboard-widgets.tsx
@@ -1,17 +1,18 @@
import { observer } from "mobx-react";
-import { useParams } from "next/navigation";
+import { useParams, usePathname } from "next/navigation";
// plane imports
import { useTranslation } from "@plane/i18n";
import { THomeWidgetKeys, THomeWidgetProps } from "@plane/types";
// components
import { SimpleEmptyState } from "@/components/empty-state";
// hooks
+import { useProject } from "@/hooks/store";
import { useHome } from "@/hooks/store/use-home";
// plane web components
import { useResolvedAssetPath } from "@/hooks/use-resolved-asset-path";
import { HomePageHeader } from "@/plane-web/components/home/header";
import { StickiesWidget } from "../stickies";
-import { RecentActivityWidget } from "./widgets";
+import { HomeLoader, NoProjectsEmptyState, RecentActivityWidget } from "./widgets";
import { DashboardQuickLinks } from "./widgets/links";
import { ManageWidgetsModal } from "./widgets/manage";
@@ -52,14 +53,21 @@ export const HOME_WIDGETS_LIST: {
export const DashboardWidgets = observer(() => {
// router
const { workspaceSlug } = useParams();
+ // navigation
+ const pathname = usePathname();
+ // store hooks
+ const { toggleWidgetSettings, widgetsMap, showWidgetSettings, orderedWidgets, isAnyWidgetEnabled, loading } =
+ useHome();
+ const { loader } = useProject();
// plane hooks
const { t } = useTranslation();
- // store hooks
- const { toggleWidgetSettings, widgetsMap, showWidgetSettings, orderedWidgets, isAnyWidgetEnabled } = useHome();
// derived values
const noWidgetsResolvedPath = useResolvedAssetPath({ basePath: "/empty-state/dashboard/widgets" });
+ // derived values
+ const isWikiApp = pathname.includes(`/${workspaceSlug.toString()}/pages`);
if (!workspaceSlug) return null;
+ if (loading || loader !== "loaded") return <HomeLoader />;
return (
<div className="h-full w-full relative flex flex-col gap-7">
@@ -69,6 +77,8 @@ export const DashboardWidgets = observer(() => {
isModalOpen={showWidgetSettings}
handleOnClose={() => toggleWidgetSettings(false)}
/>
+ {!isWikiApp && <NoProjectsEmptyState />}
+
{isAnyWidgetEnabled ? (
<div className="flex flex-col divide-y-[1px] divide-custom-border-100">
{orderedWidgets.map((key) => {
diff --git a/web/core/components/home/widgets/empty-states/no-projects.tsx b/web/core/components/home/widgets/empty-states/no-projects.tsx
index 08a8bdaf4e..84d7b638bc 100644
--- a/web/core/components/home/widgets/empty-states/no-projects.tsx
+++ b/web/core/components/home/widgets/empty-states/no-projects.tsx
@@ -1,17 +1,21 @@
import React from "react";
+// mobx
+import { observer } from "mobx-react";
import Link from "next/link";
import { useParams } from "next/navigation";
-import { Briefcase, Hotel, Users } from "lucide-react";
+import { Briefcase, Check, Hotel, Users, X } from "lucide-react";
// plane ui
import { EUserPermissions, EUserPermissionsLevel } from "@plane/constants";
+import { useLocalStorage } from "@plane/hooks";
import { useTranslation } from "@plane/i18n";
// helpers
+import { cn } from "@plane/utils";
import { getFileURL } from "@/helpers/file.helper";
// hooks
-import { useCommandPalette, useEventTracker, useUser, useUserPermissions } from "@/hooks/store";
+import { useCommandPalette, useEventTracker, useProject, useUser, useUserPermissions } from "@/hooks/store";
// plane web constants
-export const NoProjectsEmptyState = () => {
+export const NoProjectsEmptyState = observer(() => {
// navigation
const { workspaceSlug } = useParams();
// store hooks
@@ -19,6 +23,14 @@ export const NoProjectsEmptyState = () => {
const { toggleCreateProjectModal } = useCommandPalette();
const { setTrackElement } = useEventTracker();
const { data: currentUser } = useUser();
+ const { joinedProjectIds } = useProject();
+ // local storage
+ const { storedValue, setValue } = useLocalStorage(`quickstart-guide-${workspaceSlug}`, {
+ hide: false,
+ visited_members: false,
+ visited_workspace: false,
+ visited_profile: false,
+ });
const { t } = useTranslation();
// derived values
const canCreateProject = allowPermissions(
@@ -31,7 +43,8 @@ export const NoProjectsEmptyState = () => {
id: "create-project",
title: "home.empty.create_project.title",
description: "home.empty.create_project.description",
- icon: <Briefcase className="w-[40px] h-[40px] text-custom-primary-100" />,
+ icon: <Briefcase className="size-10" />,
+ flag: "projects",
cta: {
text: "home.empty.create_project.cta",
onClick: (e: React.MouseEvent<HTMLButtonElement, MouseEvent>) => {
@@ -47,7 +60,8 @@ export const NoProjectsEmptyState = () => {
id: "invite-team",
title: "home.empty.invite_team.title",
description: "home.empty.invite_team.description",
- icon: <Users className="w-[40px] h-[40px] text-custom-primary-100" />,
+ icon: <Users className="size-10" />,
+ flag: "visited_members",
cta: {
text: "home.empty.invite_team.cta",
link: `/${workspaceSlug}/settings/members`,
@@ -57,7 +71,8 @@ export const NoProjectsEmptyState = () => {
id: "configure-workspace",
title: "home.empty.configure_workspace.title",
description: "home.empty.configure_workspace.description",
- icon: <Hotel className="w-[40px] h-[40px] text-custom-primary-100" />,
+ icon: <Hotel className="size-10" />,
+ flag: "visited_workspace",
cta: {
text: "home.empty.configure_workspace.cta",
link: "settings",
@@ -85,44 +100,94 @@ export const NoProjectsEmptyState = () => {
</span>
</Link>
),
+ flag: "visited_profile",
cta: {
text: "home.empty.personalize_account.cta",
link: "/profile",
},
},
];
+ const isComplete = (type: string) => {
+ switch (type) {
+ case "projects":
+ return joinedProjectIds?.length > 0;
+ case "visited_members":
+ return storedValue?.visited_members;
+ case "visited_workspace":
+ return storedValue?.visited_workspace;
+ case "visited_profile":
+ return storedValue?.visited_profile;
+ }
+ };
+
+ if (storedValue?.hide) return null;
return (
- <div className="grid grid-cols-1 md:grid-cols-2 xl:grid-cols-4 gap-4">
- {EMPTY_STATE_DATA.map((item) => (
- <div
- key={item.id}
- className="flex flex-col items-center justify-center p-6 bg-custom-background-100 rounded-lg text-center border border-custom-border-200/40"
+ <div>
+ <div className="flex items-center justify-between mb-4">
+ <div className="text-base font-semibold text-custom-text-350">{t("home.empty.quickstart_guide")}</div>
+ <button
+ className="text-custom-text-300 font-medium text-sm flex items-center gap-1"
+ onClick={() => {
+ if (!storedValue) return;
+ setValue({ ...storedValue, hide: true });
+ }}
>
- <div className="grid place-items-center bg-custom-primary-100/10 rounded-full size-24 mb-3">
- <span className="text-3xl my-auto">{item.icon}</span>
- </div>
- <h3 className="text-lg font-medium text-custom-text-100 mb-2">{t(item.title)}</h3>
- <p className="text-sm text-custom-text-200 mb-4 w-[80%] flex-1">{t(item.description)}</p>
-
- {item.cta.link ? (
- <Link
- href={item.cta.link}
- className="text-custom-primary-100 hover:text-custom-primary-200 text-sm font-medium"
- >
- {t(item.cta.text)}
- </Link>
- ) : (
- <button
- type="button"
- className="text-custom-primary-100 hover:text-custom-primary-200 text-sm font-medium"
- onClick={item.cta.onClick}
+ <X className="size-4" />
+ {t("home.empty.not_right_now")}
+ </button>
+ </div>
+ <div className="grid grid-cols-1 md:grid-cols-2 xl:grid-cols-4 gap-4">
+ {EMPTY_STATE_DATA.map((item) => {
+ const isStateComplete = isComplete(item.flag);
+ return (
+ <div
+ key={item.id}
+ className="flex flex-col items-center justify-center p-6 bg-custom-background-100 rounded-lg text-center border border-custom-border-200/40"
>
- {t(item.cta.text)}
- </button>
- )}
- </div>
- ))}
+ <div
+ className={cn(
+ "grid place-items-center bg-custom-background-90 rounded-full size-20 mb-3 text-custom-text-400",
+ {
+ "text-custom-primary-100 bg-custom-primary-100/10": !isStateComplete,
+ }
+ )}
+ >
+ <span className="text-3xl my-auto">{item.icon}</span>
+ </div>
+ <h3 className="text-base font-medium text-custom-text-100 mb-2">{t(item.title)}</h3>
+ <p className="text-sm text-custom-text-300 mb-2">{t(item.description)}</p>
+ {isStateComplete ? (
+ <div className="flex items-center gap-2 bg-[#17a34a] rounded-full p-1">
+ <Check className="size-3 text-custom-primary-100 text-white" />
+ </div>
+ ) : item.cta.link ? (
+ <Link
+ href={item.cta.link}
+ onClick={() => {
+ if (!storedValue) return;
+ setValue({
+ ...storedValue,
+ [item.flag]: true,
+ });
+ }}
+ className="text-custom-primary-100 hover:text-custom-primary-200 text-sm font-medium"
+ >
+ {t(item.cta.text)}
+ </Link>
+ ) : (
+ <button
+ type="button"
+ className="text-custom-primary-100 hover:text-custom-primary-200 text-sm font-medium"
+ onClick={item.cta.onClick}
+ >
+ {t(item.cta.text)}
+ </button>
+ )}
+ </div>
+ );
+ })}
+ </div>
</div>
);
-};
+});
diff --git a/web/core/components/home/widgets/links/use-links.tsx b/web/core/components/home/widgets/links/use-links.tsx
index 0cb1f6ac52..a2ad8a0cc8 100644
--- a/web/core/components/home/widgets/links/use-links.tsx
+++ b/web/core/components/home/widgets/links/use-links.tsx
@@ -42,9 +42,9 @@ export const useLinks = (workspaceSlug: string) => {
});
toggleLinkModal(false);
} catch (error: any) {
- console.error("error", error);
+ console.error("error", error?.data?.url?.error);
setToast({
- message: error?.data?.error ?? t("links.toasts.not_created.message"),
+ message: error?.data?.url?.error ?? t("links.toasts.not_created.message"),
type: TOAST_TYPE.ERROR,
title: t("links.toasts.not_created.title"),
});
diff --git a/web/core/components/home/widgets/loaders/home-loader.tsx b/web/core/components/home/widgets/loaders/home-loader.tsx
new file mode 100644
index 0000000000..56d32725bf
--- /dev/null
+++ b/web/core/components/home/widgets/loaders/home-loader.tsx
@@ -0,0 +1,22 @@
+"use client";
+
+import range from "lodash/range";
+// ui
+import { Loader } from "@plane/ui";
+
+export const HomeLoader = () => (
+ <>
+ {range(3).map((index) => (
+ <div key={index}>
+ <div className="mb-2">
+ <div className="text-base font-semibold text-custom-text-350 mb-4">
+ <Loader.Item height="20px" width="100px" />
+ </div>
+ <Loader className="h-[110px] w-full flex items-center justify-center gap-2 text-custom-text-400 rounded">
+ <Loader.Item height="100%" width="100%" />
+ </Loader>
+ </div>
+ </div>
+ ))}
+ </>
+);
diff --git a/web/core/components/home/widgets/loaders/index.ts b/web/core/components/home/widgets/loaders/index.ts
index ee5286f0fb..a0925eccdf 100644
--- a/web/core/components/home/widgets/loaders/index.ts
+++ b/web/core/components/home/widgets/loaders/index.ts
@@ -1 +1,2 @@
export * from "./loader";
+export * from "./home-loader";
diff --git a/web/core/components/home/widgets/recents/index.tsx b/web/core/components/home/widgets/recents/index.tsx
index 6f06432fdf..5622a2541d 100644
--- a/web/core/components/home/widgets/recents/index.tsx
+++ b/web/core/components/home/widgets/recents/index.tsx
@@ -2,7 +2,6 @@
import { useRef, useState } from "react";
import { observer } from "mobx-react";
-import { usePathname } from "next/navigation";
import useSWR from "swr";
import { Briefcase, FileText } from "lucide-react";
import { useTranslation } from "@plane/i18n";
@@ -12,11 +11,9 @@ import { TActivityEntityData, THomeWidgetProps, TRecentActivityFilterKeys } from
import { LayersIcon } from "@plane/ui";
// components
import { ContentOverflowWrapper } from "@/components/core/content-overflow-HOC";
-// hooks
-import { useProject } from "@/hooks/store";
// plane web services
import { WorkspaceService } from "@/plane-web/services";
-import { NoProjectsEmptyState, RecentsEmptyState } from "../empty-states";
+import { RecentsEmptyState } from "../empty-states";
import { EWidgetKeys, WidgetLoader } from "../loaders";
import { FiltersDropdown } from "./filters";
import { RecentIssue } from "./issue";
@@ -41,15 +38,9 @@ export const RecentActivityWidget: React.FC<TRecentWidgetProps> = observer((prop
const { presetFilter, showFilterSelect = true, workspaceSlug } = props;
// states
const [filter, setFilter] = useState<TRecentActivityFilterKeys>(presetFilter ?? filters[0].name);
- // navigation
- const pathname = usePathname();
+ const { t } = useTranslation();
// ref
const ref = useRef<HTMLDivElement>(null);
- // store hooks
- const { joinedProjectIds, loader } = useProject();
- const { t } = useTranslation();
- // derived values
- const isWikiApp = pathname.includes(`/${workspaceSlug.toString()}/pages`);
const { data: recents, isLoading } = useSWR(
workspaceSlug ? `WORKSPACE_RECENT_ACTIVITY_${workspaceSlug}_${filter}` : null,
@@ -81,8 +72,6 @@ export const RecentActivityWidget: React.FC<TRecentWidgetProps> = observer((prop
}
};
- if (loader === "loaded" && !isWikiApp && joinedProjectIds?.length === 0) return <NoProjectsEmptyState />;
-
if (!isLoading && recents?.length === 0)
return (
<div ref={ref} className="max-h-[500px] overflow-y-scroll">
diff --git a/web/core/components/stickies/layout/stickies-list.tsx b/web/core/components/stickies/layout/stickies-list.tsx
index 3ee1f568ba..47e6e66980 100644
--- a/web/core/components/stickies/layout/stickies-list.tsx
+++ b/web/core/components/stickies/layout/stickies-list.tsx
@@ -192,7 +192,7 @@ export const StickiesLayout = (props: TStickiesLayout) => {
const columnCount = getColumnCount(containerWidth);
return (
- <div ref={ref} className="size-full min-h-[500px]">
+ <div ref={ref} className="size-full">
<StickiesList {...props} columnCount={columnCount} />
</div>
);
diff --git a/web/core/store/workspace/home.ts b/web/core/store/workspace/home.ts
index dc53b707b3..023767ef3d 100644
--- a/web/core/store/workspace/home.ts
+++ b/web/core/store/workspace/home.ts
@@ -7,6 +7,7 @@ import { IWorkspaceLinkStore, WorkspaceLinkStore } from "./link.store";
export interface IHomeStore {
// observables
+ loading: boolean;
showWidgetSettings: boolean;
widgetsMap: Record<string, TWidgetEntityData>;
widgets: THomeWidgetKeys[];
@@ -25,6 +26,7 @@ export interface IHomeStore {
export class HomeStore implements IHomeStore {
// observables
showWidgetSettings = false;
+ loading = false;
widgetsMap: Record<string, TWidgetEntityData> = {};
widgets: THomeWidgetKeys[] = [];
// stores
@@ -35,6 +37,7 @@ export class HomeStore implements IHomeStore {
constructor() {
makeObservable(this, {
// observables
+ loading: observable,
showWidgetSettings: observable,
widgetsMap: observable,
widgets: observable,
@@ -68,15 +71,18 @@ export class HomeStore implements IHomeStore {
fetchWidgets = async (workspaceSlug: string) => {
try {
+ this.loading = true;
const widgets = await this.workspaceService.fetchWorkspaceWidgets(workspaceSlug);
runInAction(() => {
this.widgets = orderBy(Object.values(widgets), "sort_order", "desc").map((widget) => widget.key);
widgets.forEach((widget) => {
this.widgetsMap[widget.key] = widget;
});
+ this.loading = false;
});
} catch (error) {
console.error("Failed to fetch widgets");
+ this.loading = false;
throw error;
}
};
diff --git a/web/core/store/workspace/link.store.ts b/web/core/store/workspace/link.store.ts
index a6b2cd40ec..4a19f92c0f 100644
--- a/web/core/store/workspace/link.store.ts
+++ b/web/core/store/workspace/link.store.ts
@@ -93,7 +93,6 @@ export class WorkspaceLinkStore implements IWorkspaceLinkStore {
};
createLink = async (workspaceSlug: string, data: Partial<TLink>) => {
- console.log("hereee");
const response = await this.workspaceService.createWorkspaceLink(workspaceSlug, data);
runInAction(() => {