π₯π₯π₯ 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
chore: show content loader untile the server has synced (#5657)
Aaryan Khandelwal3b0f3ca7613b
diff --git a/packages/editor/src/core/components/editors/document/collaborative-editor.tsx b/packages/editor/src/core/components/editors/document/collaborative-editor.tsxindex 4d7008f2ec..a008d5c60b 100644--- a/packages/editor/src/core/components/editors/document/collaborative-editor.tsx+++ b/packages/editor/src/core/components/editors/document/collaborative-editor.tsx@@ -1,6 +1,6 @@import React from "react";// components-import { PageRenderer } from "@/components/editors";+import { DocumentContentLoader, PageRenderer } from "@/components/editors";// constantsimport { DEFAULT_DISPLAY_CONFIG } from "@/constants/config";// extensions@@ -42,7 +42,7 @@ const CollaborativeDocumentEditor = (props: ICollaborativeDocumentEditor) => {}// use document editor- const { editor } = useCollaborativeEditor({+ const { editor, hasServerConnectionFailed, hasServerSynced } = useCollaborativeEditor({disabledExtensions,editorClassName,embedHandler,@@ -67,6 +67,8 @@ const CollaborativeDocumentEditor = (props: ICollaborativeDocumentEditor) => {if (!editor) return null;+ if (!hasServerSynced && !hasServerConnectionFailed) return <DocumentContentLoader />;+return (<PageRendererdisplayConfig={displayConfig}diff --git a/packages/editor/src/core/components/editors/document/collaborative-read-only-editor.tsx b/packages/editor/src/core/components/editors/document/collaborative-read-only-editor.tsxindex f12eb62748..35b833bf9a 100644--- a/packages/editor/src/core/components/editors/document/collaborative-read-only-editor.tsx+++ b/packages/editor/src/core/components/editors/document/collaborative-read-only-editor.tsx@@ -1,6 +1,6 @@import { forwardRef, MutableRefObject } from "react";// components-import { PageRenderer } from "@/components/editors";+import { DocumentContentLoader, PageRenderer } from "@/components/editors";// constantsimport { DEFAULT_DISPLAY_CONFIG } from "@/constants/config";// extensions@@ -35,7 +35,7 @@ const CollaborativeDocumentReadOnlyEditor = (props: ICollaborativeDocumentReadOn);}- const { editor } = useReadOnlyCollaborativeEditor({+ const { editor, hasServerConnectionFailed, hasServerSynced } = useReadOnlyCollaborativeEditor({editorClassName,extensions,forwardedRef,@@ -52,6 +52,9 @@ const CollaborativeDocumentReadOnlyEditor = (props: ICollaborativeDocumentReadOn});if (!editor) return null;++ if (!hasServerSynced && !hasServerConnectionFailed) return <DocumentContentLoader />;+return (<PageRendererdisplayConfig={displayConfig}diff --git a/packages/editor/src/core/components/editors/document/index.ts b/packages/editor/src/core/components/editors/document/index.tsindex a327d282da..514b620e3a 100644--- a/packages/editor/src/core/components/editors/document/index.ts+++ b/packages/editor/src/core/components/editors/document/index.ts@@ -1,4 +1,5 @@export * from "./collaborative-editor";export * from "./collaborative-read-only-editor";+export * from "./loader";export * from "./page-renderer";export * from "./read-only-editor";diff --git a/packages/editor/src/core/components/editors/document/loader.tsx b/packages/editor/src/core/components/editors/document/loader.tsxnew file mode 100644index 0000000000..ab9c3b479d--- /dev/null+++ b/packages/editor/src/core/components/editors/document/loader.tsx@@ -0,0 +1,42 @@+// ui+import { Loader } from "@plane/ui";++export const DocumentContentLoader = () => (+ <div className="size-full px-5">+ <Loader className="relative space-y-4">+ <div className="space-y-2">+ <div className="py-2">+ <Loader.Item width="100%" height="36px" />+ </div>+ <Loader.Item width="80%" height="22px" />+ <div className="relative flex items-center gap-2">+ <Loader.Item width="30px" height="30px" />+ <Loader.Item width="30%" height="22px" />+ </div>+ <div className="py-2">+ <Loader.Item width="60%" height="36px" />+ </div>+ <Loader.Item width="70%" height="22px" />+ <Loader.Item width="30%" height="22px" />+ <div className="relative flex items-center gap-2">+ <Loader.Item width="30px" height="30px" />+ <Loader.Item width="30%" height="22px" />+ </div>+ <div className="py-2">+ <Loader.Item width="50%" height="30px" />+ </div>+ <Loader.Item width="100%" height="22px" />+ <div className="py-2">+ <Loader.Item width="30%" height="30px" />+ </div>+ <Loader.Item width="30%" height="22px" />+ <div className="relative flex items-center gap-2">+ <div className="py-2">+ <Loader.Item width="30px" height="30px" />+ </div>+ <Loader.Item width="30%" height="22px" />+ </div>+ </div>+ </Loader>+ </div>+);diff --git a/packages/editor/src/core/hooks/use-collaborative-editor.ts b/packages/editor/src/core/hooks/use-collaborative-editor.tsindex b2f18039a2..5a004bff28 100644--- a/packages/editor/src/core/hooks/use-collaborative-editor.ts+++ b/packages/editor/src/core/hooks/use-collaborative-editor.ts@@ -1,4 +1,4 @@-import { useEffect, useLayoutEffect, useMemo } from "react";+import { useEffect, useLayoutEffect, useMemo, useState } from "react";import { HocuspocusProvider } from "@hocuspocus/provider";import Collaboration from "@tiptap/extension-collaboration";import { IndexeddbPersistence } from "y-indexeddb";@@ -29,6 +29,9 @@ export const useCollaborativeEditor = (props: TCollaborativeEditorProps) => {tabIndex,user,} = props;+ // states+ const [hasServerConnectionFailed, setHasServerConnectionFailed] = useState(false);+ const [hasServerSynced, setHasServerSynced] = useState(false);// initialize Hocuspocus providerconst provider = useMemo(() =>@@ -38,11 +41,18 @@ export const useCollaborativeEditor = (props: TCollaborativeEditorProps) => {// using user id as a token to verify the user on the servertoken: user.id,url: realtimeConfig.url,- onAuthenticationFailed: () => serverHandler?.onServerError?.(),+ onAuthenticationFailed: () => {+ serverHandler?.onServerError?.();+ setHasServerConnectionFailed(true);+ },onConnect: () => serverHandler?.onConnect?.(),onClose: (data) => {- if (data.event.code === 1006) serverHandler?.onServerError?.();+ if (data.event.code === 1006) {+ serverHandler?.onServerError?.();+ setHasServerConnectionFailed(true);+ }},+ onSynced: () => setHasServerSynced(true),}),[id, realtimeConfig, serverHandler, user.id]);@@ -94,5 +104,9 @@ export const useCollaborativeEditor = (props: TCollaborativeEditorProps) => {tabIndex,});- return { editor };+ return {+ editor,+ hasServerConnectionFailed,+ hasServerSynced,+ };};diff --git a/packages/editor/src/core/hooks/use-read-only-collaborative-editor.ts b/packages/editor/src/core/hooks/use-read-only-collaborative-editor.tsindex e262776ec0..1aff29aa74 100644--- a/packages/editor/src/core/hooks/use-read-only-collaborative-editor.ts+++ b/packages/editor/src/core/hooks/use-read-only-collaborative-editor.ts@@ -1,4 +1,4 @@-import { useEffect, useLayoutEffect, useMemo } from "react";+import { useEffect, useLayoutEffect, useMemo, useState } from "react";import { HocuspocusProvider } from "@hocuspocus/provider";import Collaboration from "@tiptap/extension-collaboration";import { IndexeddbPersistence } from "y-indexeddb";@@ -22,6 +22,9 @@ export const useReadOnlyCollaborativeEditor = (props: TReadOnlyCollaborativeEditserverHandler,user,} = props;+ // states+ const [hasServerConnectionFailed, setHasServerConnectionFailed] = useState(false);+ const [hasServerSynced, setHasServerSynced] = useState(false);// initialize Hocuspocus providerconst provider = useMemo(() =>@@ -30,10 +33,18 @@ export const useReadOnlyCollaborativeEditor = (props: TReadOnlyCollaborativeEditname: id,token: user.id,parameters: realtimeConfig.queryParams,+ onAuthenticationFailed: () => {+ serverHandler?.onServerError?.();+ setHasServerConnectionFailed(true);+ },onConnect: () => serverHandler?.onConnect?.(),onClose: (data) => {- if (data.event.code === 1006) serverHandler?.onServerError?.();+ if (data.event.code === 1006) {+ serverHandler?.onServerError?.();+ setHasServerConnectionFailed(true);+ }},+ onSynced: () => setHasServerSynced(true),}),[id, realtimeConfig, user.id]);@@ -69,5 +80,9 @@ export const useReadOnlyCollaborativeEditor = (props: TReadOnlyCollaborativeEditprovider,});- return { editor, isIndexedDbSynced: true };+ return {+ editor,+ hasServerConnectionFailed,+ hasServerSynced,+ };};