π₯π₯π₯ 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
[PE-155] chore: floating toolbar for pages (#6482)
Aaryan Khandelwalb698f445001d
diff --git a/packages/editor/src/core/components/editors/document/collaborative-editor.tsx b/packages/editor/src/core/components/editors/document/collaborative-editor.tsxindex 44c18c2f68..d7d3819f21 100644--- a/packages/editor/src/core/components/editors/document/collaborative-editor.tsx+++ b/packages/editor/src/core/components/editors/document/collaborative-editor.tsx@@ -16,6 +16,7 @@ const CollaborativeDocumentEditor = (props: ICollaborativeDocumentEditor) => {const {onTransaction,aiHandler,+ bubbleMenuEnabled = true,containerClassName,disabledExtensions,displayConfig = DEFAULT_DISPLAY_CONFIG,@@ -75,8 +76,9 @@ const CollaborativeDocumentEditor = (props: ICollaborativeDocumentEditor) => {return (<PageRenderer- displayConfig={displayConfig}aiHandler={aiHandler}+ bubbleMenuEnabled={bubbleMenuEnabled}+ displayConfig={displayConfig}editor={editor}editorContainerClassName={editorContainerClassNames}id={id}diff --git a/packages/editor/src/core/components/editors/document/page-renderer.tsx b/packages/editor/src/core/components/editors/document/page-renderer.tsxindex f291c8b3a3..a297686564 100644--- a/packages/editor/src/core/components/editors/document/page-renderer.tsx+++ b/packages/editor/src/core/components/editors/document/page-renderer.tsx@@ -15,12 +15,13 @@ import { Editor, ReactRenderer } from "@tiptap/react";// componentsimport { EditorContainer, EditorContentWrapper } from "@/components/editors";import { LinkView, LinkViewProps } from "@/components/links";-import { AIFeaturesMenu, BlockMenu } from "@/components/menus";+import { AIFeaturesMenu, BlockMenu, EditorBubbleMenu } from "@/components/menus";// typesimport { TAIHandler, TDisplayConfig } from "@/types";type IPageRenderer = {aiHandler?: TAIHandler;+ bubbleMenuEnabled: boolean;displayConfig: TDisplayConfig;editor: Editor;editorContainerClassName: string;@@ -29,7 +30,7 @@ type IPageRenderer = {};export const PageRenderer = (props: IPageRenderer) => {- const { aiHandler, displayConfig, editor, editorContainerClassName, id, tabIndex } = props;+ const { aiHandler, bubbleMenuEnabled, displayConfig, editor, editorContainerClassName, id, tabIndex } = props;// statesconst [linkViewProps, setLinkViewProps] = useState<LinkViewProps>();const [isOpen, setIsOpen] = useState(false);@@ -141,6 +142,7 @@ export const PageRenderer = (props: IPageRenderer) => {<EditorContentWrapper editor={editor} id={id} tabIndex={tabIndex} />{editor.isEditable && (<div>+ {bubbleMenuEnabled && <EditorBubbleMenu editor={editor} />}<BlockMenu editor={editor} /><AIFeaturesMenu menu={aiHandler?.menu} /></div>diff --git a/packages/editor/src/core/components/editors/document/read-only-editor.tsx b/packages/editor/src/core/components/editors/document/read-only-editor.tsxindex 0e8ab63f8a..c8753fe42f 100644--- a/packages/editor/src/core/components/editors/document/read-only-editor.tsx+++ b/packages/editor/src/core/components/editors/document/read-only-editor.tsx@@ -69,6 +69,7 @@ const DocumentReadOnlyEditor = (props: IDocumentReadOnlyEditor) => {return (<PageRenderer+ bubbleMenuEnabled={false}displayConfig={displayConfig}editor={editor}editorContainerClassName={editorContainerClassName}diff --git a/packages/editor/src/core/types/editor.ts b/packages/editor/src/core/types/editor.tsindex 648cdf859f..628c1ab258 100644--- a/packages/editor/src/core/types/editor.ts+++ b/packages/editor/src/core/types/editor.ts@@ -138,8 +138,9 @@ export interface IRichTextEditor extends IEditorProps {export interface ICollaborativeDocumentEditorextends Omit<IEditorProps, "initialValue" | "onChange" | "onEnterKeyPress" | "value"> {- editable: boolean;aiHandler?: TAIHandler;+ bubbleMenuEnabled?: boolean;+ editable: boolean;embedHandler: TEmbedConfig;handleEditorReady?: (value: boolean) => void;id: string;diff --git a/web/core/components/pages/dropdowns/actions.tsx b/web/core/components/pages/dropdowns/actions.tsxindex e4af59abe6..b948ca6bcb 100644--- a/web/core/components/pages/dropdowns/actions.tsx+++ b/web/core/components/pages/dropdowns/actions.tsx@@ -36,6 +36,7 @@ import { TPageInstance } from "@/store/pages/base-page";export type TPageActions =| "full-screen"+ | "sticky-toolbar"| "copy-markdown"| "toggle-lock"| "toggle-access"diff --git a/web/core/components/pages/editor/header/options-dropdown.tsx b/web/core/components/pages/editor/header/options-dropdown.tsxindex fb096ed2c6..e1807bcc9c 100644--- a/web/core/components/pages/editor/header/options-dropdown.tsx+++ b/web/core/components/pages/editor/header/options-dropdown.tsx@@ -30,9 +30,9 @@ export const PageOptionsDropdown: React.FC<Props> = observer((props) => {// routerconst router = useRouter();// store values- const { name } = page;+ const { name, isContentEditable } = page;// page filters- const { isFullWidth, handleFullWidth } = usePageFilters();+ const { isFullWidth, handleFullWidth, isStickyToolbarEnabled, handleStickyToolbar } = usePageFilters();// update query paramsconst { updateQueryParams } = useQueryParams();// menu items list@@ -49,6 +49,18 @@ export const PageOptionsDropdown: React.FC<Props> = observer((props) => {),className: "flex items-center justify-between gap-2",},+ {+ key: "sticky-toolbar",+ action: () => handleStickyToolbar(!isStickyToolbarEnabled),+ customContent: (+ <>+ Sticky toolbar+ <ToggleSwitch value={isStickyToolbarEnabled} onChange={() => {}} />+ </>+ ),+ className: "flex items-center justify-between gap-2",+ shouldRender: isContentEditable,+ },{key: "copy-markdown",action: () => {@@ -86,7 +98,16 @@ export const PageOptionsDropdown: React.FC<Props> = observer((props) => {shouldRender: true,},],- [editorRef, handleFullWidth, isFullWidth, router, updateQueryParams]+ [+ editorRef,+ handleFullWidth,+ handleStickyToolbar,+ isContentEditable,+ isFullWidth,+ isStickyToolbarEnabled,+ router,+ updateQueryParams,+ ]);return (@@ -102,6 +123,7 @@ export const PageOptionsDropdown: React.FC<Props> = observer((props) => {extraOptions={EXTRA_MENU_OPTIONS}optionsOrder={["full-screen",+ "sticky-toolbar","copy-link","make-a-copy","move",diff --git a/web/core/components/pages/editor/header/root.tsx b/web/core/components/pages/editor/header/root.tsxindex 996f501bb3..a9dfdad51b 100644--- a/web/core/components/pages/editor/header/root.tsx+++ b/web/core/components/pages/editor/header/root.tsx@@ -23,7 +23,7 @@ export const PageEditorHeaderRoot: React.FC<Props> = observer((props) => {// derived valuesconst { isContentEditable } = page;// page filters- const { isFullWidth } = usePageFilters();+ const { isFullWidth, isStickyToolbarEnabled } = usePageFilters();// derived valuesconst resolvedEditorRef = editorRef.current;@@ -48,7 +48,9 @@ export const PageEditorHeaderRoot: React.FC<Props> = observer((props) => {/></div>)}- {editorReady && isContentEditable && editorRef.current && <PageToolbar editorRef={editorRef?.current} />}+ {isStickyToolbarEnabled && editorReady && isContentEditable && editorRef.current && (+ <PageToolbar editorRef={editorRef?.current} />+ )}</Header.LeftItem><PageExtraOptions editorRef={resolvedEditorRef} page={page} /></Header>diff --git a/web/core/hooks/use-page-filters.ts b/web/core/hooks/use-page-filters.tsindex e7698a9340..448c589777 100644--- a/web/core/hooks/use-page-filters.ts+++ b/web/core/hooks/use-page-filters.ts@@ -8,12 +8,14 @@ export type TPagesPersonalizationConfig = {full_width: boolean;font_size: TEditorFontSize;font_style: TEditorFontStyle;+ sticky_toolbar: boolean;};const DEFAULT_PERSONALIZATION_VALUES: TPagesPersonalizationConfig = {full_width: false,font_size: "large-font",font_style: "sans-serif",+ sticky_toolbar: true,};export const usePageFilters = () => {@@ -23,7 +25,17 @@ export const usePageFilters = () => {DEFAULT_PERSONALIZATION_VALUES);// stored values- const isFullWidth = useMemo(() => !!pagesConfig?.full_width, [pagesConfig?.full_width]);+ const isFullWidth = useMemo(+ () => (pagesConfig?.full_width === undefined ? DEFAULT_PERSONALIZATION_VALUES.full_width : pagesConfig?.full_width),+ [pagesConfig?.full_width]+ );+ const isStickyToolbarEnabled = useMemo(+ () =>+ pagesConfig?.sticky_toolbar === undefined+ ? DEFAULT_PERSONALIZATION_VALUES.sticky_toolbar+ : pagesConfig?.sticky_toolbar,+ [pagesConfig?.sticky_toolbar]+ );const fontSize = useMemo(() => pagesConfig?.font_size ?? DEFAULT_PERSONALIZATION_VALUES.font_size,[pagesConfig?.font_size]@@ -78,6 +90,18 @@ export const usePageFilters = () => {},[handleUpdateConfig]);+ /**+ * @description action to update full_width value+ * @param {boolean} value+ */+ const handleStickyToolbar = useCallback(+ (value: boolean) => {+ handleUpdateConfig({+ sticky_toolbar: value,+ });+ },+ [handleUpdateConfig]+ );return {fontSize,@@ -86,5 +110,7 @@ export const usePageFilters = () => {handleFontStyle,isFullWidth,handleFullWidth,+ isStickyToolbarEnabled,+ handleStickyToolbar,};};