refactor: export CanvasContextProvider to follow established context pattern

As noted [in the review](
https://github.com/drawdb-io/drawdb/pull/148#discussion_r1681584836
), I disagree with this pattern. However, I will follow it to get
these features added.
This commit is contained in:
Felix Zedén Yverås 2024-07-17 21:45:51 +02:00
parent 471d2ebdf0
commit 5a56c3b354
6 changed files with 188 additions and 171 deletions

View File

@ -1,4 +1,4 @@
import { useContext, useRef, useState } from "react"; import { useRef, useState } from "react";
import { Button, Popover, Input } from "@douyinfe/semi-ui"; import { Button, Popover, Input } from "@douyinfe/semi-ui";
import { IconEdit, IconDeleteStroked } from "@douyinfe/semi-icons"; import { IconEdit, IconDeleteStroked } from "@douyinfe/semi-icons";
import { import {
@ -9,6 +9,7 @@ import {
State, State,
} from "../../data/constants"; } from "../../data/constants";
import { import {
useCanvas,
useLayout, useLayout,
useSettings, useSettings,
useUndoRedo, useUndoRedo,
@ -19,7 +20,6 @@ import {
import ColorPalette from "../ColorPicker"; import ColorPalette from "../ColorPicker";
import { useTranslation } from "react-i18next"; import { useTranslation } from "react-i18next";
import { useHover } from "usehooks-ts"; import { useHover } from "usehooks-ts";
import { CanvasContext } from "../../context/CanvasContext";
export default function Area({ export default function Area({
data, data,
@ -33,7 +33,7 @@ export default function Area({
pointer: { pointer: {
spaces: { diagram: pointer }, spaces: { diagram: pointer },
}, },
} = useContext(CanvasContext); } = useCanvas();
const { layout } = useLayout(); const { layout } = useLayout();
const { settings } = useSettings(); const { settings } = useSettings();
const { setSaveState } = useSaveState(); const { setSaveState } = useSaveState();

View File

@ -11,6 +11,7 @@ import Area from "./Area";
import Relationship from "./Relationship"; import Relationship from "./Relationship";
import Note from "./Note"; import Note from "./Note";
import { import {
useCanvas,
useSettings, useSettings,
useTransform, useTransform,
useDiagram, useDiagram,
@ -22,14 +23,13 @@ import {
} from "../../hooks"; } from "../../hooks";
import { useTranslation } from "react-i18next"; import { useTranslation } from "react-i18next";
import { diagram } from "../../data/heroDiagram"; import { diagram } from "../../data/heroDiagram";
import { CanvasContext, useCanvasContextProviderValue } from "../../context/CanvasContext";
import { useEventListener } from "usehooks-ts"; import { useEventListener } from "usehooks-ts";
export default function Canvas() { export default function Canvas() {
const { t } = useTranslation(); const { t } = useTranslation();
const canvasRef = useRef(null); const canvasRef = useRef(null);
const canvasContextValue = useCanvasContextProviderValue(canvasRef); const canvasContextValue = useCanvas();
const { const {
canvas: { viewBox }, canvas: { viewBox },
pointer, pointer,
@ -481,7 +481,6 @@ export default function Canvas() {
const theme = localStorage.getItem("theme"); const theme = localStorage.getItem("theme");
return ( return (
<CanvasContext.Provider value={canvasContextValue}>
<div className="flex-grow h-full touch-none" id="canvas"> <div className="flex-grow h-full touch-none" id="canvas">
<div <div
className="w-full h-full" className="w-full h-full"
@ -644,6 +643,5 @@ export default function Canvas() {
</div> </div>
)} )}
</div> </div>
</CanvasContext.Provider>
); );
} }

View File

@ -1,6 +1,7 @@
import { useState, useEffect, useCallback } from "react"; import { useState, useEffect, useCallback } from "react";
import ControlPanel from "./EditorHeader/ControlPanel"; import ControlPanel from "./EditorHeader/ControlPanel";
import Canvas from "./EditorCanvas/Canvas"; import Canvas from "./EditorCanvas/Canvas";
import { CanvasContextProvider } from "../context/CanvasContext";
import SidePanel from "./EditorSidePanel/SidePanel"; import SidePanel from "./EditorSidePanel/SidePanel";
import { DB, State } from "../data/constants"; import { DB, State } from "../data/constants";
import { db } from "../data/db"; import { db } from "../data/db";
@ -362,7 +363,9 @@ export default function WorkSpace() {
<SidePanel resize={resize} setResize={setResize} width={width} /> <SidePanel resize={resize} setResize={setResize} width={width} />
)} )}
<div className="relative w-full h-full overflow-hidden"> <div className="relative w-full h-full overflow-hidden">
<CanvasContextProvider className="h-full w-full">
<Canvas saveState={saveState} setSaveState={setSaveState} /> <Canvas saveState={saveState} setSaveState={setSaveState} />
</CanvasContextProvider>
{!(layout.sidebar || layout.toolbar || layout.header) && ( {!(layout.sidebar || layout.toolbar || layout.header) && (
<div className="fixed right-5 bottom-4"> <div className="fixed right-5 bottom-4">
<FloatingControls /> <FloatingControls />

View File

@ -1,5 +1,5 @@
import { useTransform } from "../hooks"; import { useTransform } from "../hooks";
import { createContext, useCallback, useMemo, useState } from "react"; import { createContext, useCallback, useMemo, useRef, useState } from "react";
import { useEventListener, useResizeObserver } from "usehooks-ts"; import { useEventListener, useResizeObserver } from "usehooks-ts";
export const CanvasContext = createContext({ export const CanvasContext = createContext({
@ -34,10 +34,11 @@ export const CanvasContext = createContext({
}, },
}); });
export function useCanvasContextProviderValue(canvasRef) { export function CanvasContextProvider({ children, ...attrs }) {
const canvasWrapRef = useRef(null);
const { transform } = useTransform(); const { transform } = useTransform();
const canvasSize = useResizeObserver({ const canvasSize = useResizeObserver({
ref: canvasRef, ref: canvasWrapRef,
box: "content-box", box: "content-box",
}); });
const screenSize = useMemo( const screenSize = useMemo(
@ -133,11 +134,11 @@ export function useCanvasContextProviderValue(canvasRef) {
} }
// Important for touch screen devices! // Important for touch screen devices!
useEventListener("pointerdown", detectPointerMovement, canvasRef); useEventListener("pointerdown", detectPointerMovement, canvasWrapRef);
useEventListener("pointermove", detectPointerMovement, canvasRef); useEventListener("pointermove", detectPointerMovement, canvasWrapRef);
return { const contextValue = {
canvas: { canvas: {
screenSize, screenSize,
viewBox, viewBox,
@ -155,4 +156,12 @@ export function useCanvasContextProviderValue(canvasRef) {
setStyle: setPointerStyle, setStyle: setPointerStyle,
}, },
}; };
return (
<CanvasContext.Provider value={contextValue}>
<div {...attrs} ref={canvasWrapRef}>
{children}
</div>
</CanvasContext.Provider>
)
} }

View File

@ -1,4 +1,5 @@
export { default as useAreas } from "./useAreas"; export { default as useAreas } from "./useAreas";
export { default as useCanvas } from "./useCanvas";
export { default as useLayout } from "./useLayout"; export { default as useLayout } from "./useLayout";
export { default as useNotes } from "./useNotes"; export { default as useNotes } from "./useNotes";
export { default as useSaveState } from "./useSaveState"; export { default as useSaveState } from "./useSaveState";

6
src/hooks/useCanvas.js Normal file
View File

@ -0,0 +1,6 @@
import { useContext } from "react";
import { CanvasContext } from "../context/CanvasContext";
export default function useCanvas() {
return useContext(CanvasContext);
}