Refactor DashboardCanvas and DashboardBaseComponent to enhance component positioning and sizing logic

This commit is contained in:
Simon Larsen 2024-11-01 14:22:13 +00:00
parent 8877ce6d12
commit 90c0e42eb1
No known key found for this signature in database
GPG Key ID: 96C5DCA24769DBCA
2 changed files with 84 additions and 34 deletions

View File

@ -17,6 +17,9 @@ export interface ComponentProps {
const DashboardCanvas: FunctionComponent<ComponentProps> = (
props: ComponentProps,
): ReactElement => {
const dashboardCanvasRef: React.RefObject<HTMLDivElement> =
React.useRef<HTMLDivElement>(null);
const renderComponents: GetReactElementFunction = (): ReactElement => {
const canvasHeight: number =
props.dashboardViewConfig.heightInDashboardUnits ||
@ -111,7 +114,9 @@ const DashboardCanvas: FunctionComponent<ComponentProps> = (
const width: number = DefaultDashboardSize.widthInDashboardUnits;
return (
<div className={`grid grid-cols-${width}`}>{finalRenderedComponents}</div>
<div ref={dashboardCanvasRef} className={`grid grid-cols-${width}`}>
{finalRenderedComponents}
</div>
);
};
@ -128,7 +133,14 @@ const DashboardCanvas: FunctionComponent<ComponentProps> = (
): ReactElement => {
return (
<DashboardBaseComponentElement
dashboardViewConfig={props.dashboardViewConfig}
isEditMode={props.isEditMode}
dashboardCanvasHeightInPx={
dashboardCanvasRef.current?.clientHeight || 0
}
dashboardCanvasWidthInPx={dashboardCanvasRef.current?.clientWidth || 0}
dashboardCanvasTopInPx={dashboardCanvasRef.current?.clientTop || 0}
dashboardCanvasLeftInPx={dashboardCanvasRef.current?.clientLeft || 0}
totalCurrentDashboardWidthInPx={props.currentTotalDashboardWidthInPx}
component={component}
key={component.componentId.toString()}

View File

@ -7,7 +7,7 @@ import { ObjectType } from "Common/Types/JSON";
import DashboardChartComponent from "./DashboardChartComponent";
import DashboardValueComponent from "./DashboardValueComponent";
import DashboardTextComponent from "./DashboardTextComponent";
import {
import DefaultDashboardSize, {
GetDashboardComponentHeightInDashboardUnits,
GetDashboardComponentWidthInDashboardUnits,
GetDashboardUnitHeightInPx,
@ -16,6 +16,7 @@ import {
SpaceBetweenUnitsInPx,
} from "Common/Types/Dashboard/DashboardSize";
import { GetReactElementFunction } from "Common/UI/Types/FunctionTypes";
import DashboardViewConfig from "Common/Types/Dashboard/DashboardViewConfig";
export interface DashboardCommonComponentProps
extends DashboardBaseComponentProps {
@ -29,6 +30,11 @@ export interface DashboardBaseComponentProps {
key: string;
onComponentUpdate: (component: DashboardBaseComponent) => void;
totalCurrentDashboardWidthInPx: number;
dashboardCanvasTopInPx: number;
dashboardCanvasLeftInPx: number;
dashboardCanvasWidthInPx: number;
dashboardCanvasHeightInPx: number;
dashboardViewConfig: DashboardViewConfig;
}
export interface ComponentProps extends DashboardBaseComponentProps {
@ -54,28 +60,72 @@ const DashboardBaseComponentElement: FunctionComponent<ComponentProps> = (
const dashboardComponentRef: React.RefObject<HTMLDivElement> =
React.useRef<HTMLDivElement>(null);
type MoveComponentTypeFunction = (
moveLeftOffset: number,
moveTopOffset: number,
) => (mouseEvent: MouseEvent) => void;
type MoveComponentFunction = (mouseEvent: MouseEvent) => void;
const moveComponent: MoveComponentTypeFunction = (
moveLeftOffset: number,
moveTopOffset: number,
): ((mouseEvent: MouseEvent) => void) => {
return (event: MouseEvent) => {
if (dashboardComponentRef.current === null) {
return;
const moveComponent: MoveComponentFunction = (
mouseEvent: MouseEvent,
): void => {
const dashboardComponentOldTopInPx: number =
dashboardComponentRef.current?.getBoundingClientRect().top || 0;
const dashboardComponentOldLeftInPx: number =
dashboardComponentRef.current?.getBoundingClientRect().left || 0;
const newMoveToTop: number = mouseEvent.pageY;
const newMoveToLeft: number = mouseEvent.pageX;
const oldTopDashboardUnits: number = props.component.topInDashboardUnits;
const oldLeftDashboardUnits: number = props.component.leftInDashboardUnits;
// calculare new top and new left.
let newTopInDashboardUnits: number = Math.floor(
(newMoveToTop * oldTopDashboardUnits) / dashboardComponentOldTopInPx,
);
let newLeftInDashboardUnits: number = Math.floor(
(newMoveToLeft * oldLeftDashboardUnits) / dashboardComponentOldLeftInPx,
);
// check if the new top and left are within the bounds of the dashboard
const dahsboardTotalWidthInDashboardUnits: number =
DefaultDashboardSize.widthInDashboardUnits; // width does not change
const dashboardTotalHeightInDashboardUnits: number =
props.dashboardViewConfig.heightInDashboardUnits;
const heightOfTheComponntInDashboardUnits: number =
props.component.heightInDashboardUnits;
const widthOfTheComponentInDashboardUnits: number =
props.component.widthInDashboardUnits;
// if it goes outside the bounds then max it out to the bounds
if (
newTopInDashboardUnits + heightOfTheComponntInDashboardUnits >
dashboardTotalHeightInDashboardUnits
) {
newTopInDashboardUnits =
dashboardTotalHeightInDashboardUnits -
heightOfTheComponntInDashboardUnits;
}
dashboardComponentRef.current.style.left =
event.clientX - moveLeftOffset + "px";
dashboardComponentRef.current.style.top =
event.clientY - moveTopOffset + "px";
};
if (
newLeftInDashboardUnits + widthOfTheComponentInDashboardUnits >
dahsboardTotalWidthInDashboardUnits
) {
newLeftInDashboardUnits =
dahsboardTotalWidthInDashboardUnits -
widthOfTheComponentInDashboardUnits;
}
// update the component
const newComponentProps: DashboardBaseComponent = {
...props.component,
topInDashboardUnits: newTopInDashboardUnits,
leftInDashboardUnits: newLeftInDashboardUnits,
};
let moveFunction: ((event: MouseEvent) => void) | undefined = undefined;
props.onComponentUpdate(newComponentProps);
};
const resizeWidth: (event: MouseEvent) => void = (event: MouseEvent) => {
if (dashboardComponentRef.current === null) {
@ -149,10 +199,7 @@ const DashboardBaseComponentElement: FunctionComponent<ComponentProps> = (
const stopResizeAndMove: () => void = () => {
window.removeEventListener("mousemove", resizeHeight);
window.removeEventListener("mousemove", resizeWidth);
if (moveFunction) {
window.removeEventListener("mousemove", moveFunction);
moveFunction = undefined;
}
window.removeEventListener("mousemove", moveComponent);
window.removeEventListener("mouseup", stopResizeAndMove);
};
@ -194,16 +241,7 @@ const DashboardBaseComponentElement: FunctionComponent<ComponentProps> = (
onMouseDown={(event: React.MouseEvent<HTMLDivElement, MouseEvent>) => {
event.preventDefault();
const leftOffset: number = dashboardComponentRef.current
? dashboardComponentRef.current?.getBoundingClientRect()?.left
: 0;
const topOffset: number = dashboardComponentRef.current
? dashboardComponentRef.current.getBoundingClientRect().top
: 0;
moveFunction = moveComponent(leftOffset, topOffset);
window.addEventListener("mousemove", moveFunction as any);
window.addEventListener("mousemove", moveComponent);
window.addEventListener("mouseup", stopResizeAndMove);
}}
className="move-element cursor-move absolute w-4 h-4 bg-blue-300 hover:bg-blue-400 rounded-full cursor-pointer"