PromucFlow_constructor/app/client/src/components/editorComponents/DraggableComponent.tsx
Pawan Kumar 8395f5e18f
feat: property pane docking (#7361)
* add tailwindcss

* docked property pane

* uncomment a line

* make entity explorer as drawer on unpin

* remove unused imports

* add pin state in  reducer

* add menu icon in header

* fix widget sidebar

* fix widgets sidebar

* style property pane

* update property pane css

* update icons in property pane

* update property pane header styles

* update spacing

* fix few ui issues

* wip: preview mode

* wip:preview mode

* remove unused import

* comments sidebar in app and edit mode

* fix order of import

* use selected state for property pane

* update scrollbar style

* add classes to sidebar and property pane

* make widgets editor fluid

* make widgets editor fluid and refactor logic

* resize the widgets editor if explorer is pinned

* add shortcut for preview mode

* fix link for tabs in edit mode

* zoom in/zoom out for 0.75

* fix chart widget + table widget crashing

* allow zooming of canvas

* fix weird canvas draw issue + update container for handling zoom

* add actions for is panning

* allow panning with grab cursor

* reset panning + zooming when entering preview mode

* add grabbing cursor when grabbing

* only prevent default when space key is pressed

* dont allow zoom in preview mode

* remove unused imports

* fix dont allow zoom in preview mode

* fix ux of panning on space hit

* make fluid as the default app layout

* chart spec

* fix dropdown_on change spec

* fix add widget table and bind spec

* remove draggable property pane spec

* fix container spec

* fix form widget spec

* fix jest test

* fix the function typo

* remove clicking of close button for property pane in cypress tests

* remove property pane actions test

* fix drag and drop test failing

* add cypress selector id to back button in property pane

* fix toggle js spec

* fix merge conflicts from new design system

* editor header

* fix product updates styles + widget card

* remove all unused imports

* fix dynamic layout spec

* fix entity explorer tab rename test failing

* fix table spec

* fix bind tabletextpagination spec

* fix js object spec

* fix entity explorer rename issue

* fix cypress test

* fix cypress command wrong commit

* fix tab spec

* fix property pane copy tests

* add zoom header

* zoom levels

* make property pane sidebar resizable

* add multi select property pane

* fix widget search bug

* update property pane width in state on drag end

* fix viewer header

* fix editor header

* update editor header + remove zooming

* update small style

* dont allow closing of explorer when resizing

* fix jest test

* fix dropdown widget jest test

* preview test case wip

* add entity explorer pinning tests + preview mode tests

* add tooltip in layout control + add padding bottom in property pane view

* incorporate aakash feedbacks

* fix preview mode margin issue

* remove panning code

* fix cypress failing test

* uncomment jest test

* remove redundant code

* fix maincontainer test

* incorporate review feedbacks

* incorporate aakash feedbacks

* review feedbacks

* incorporate review feedbacks

* incorporate qa feedbacks

* fix dynamic layout spec

* updated test based on latest change

* dsl updated

* Updated dsl

* Updated dsl

* resize deselects widget issue.

* fix canvas height issue

* fix typo

* incorporate qa feedbacks

* incorporate qa feedbacks

* incorporate qa feedbacks

* update color for setting control for widget name

* fix onboarding styles conflicts

* Updated tests

* fix application overflow issue

* updated test method

Co-authored-by: root <root@DESKTOP-9GENCK0.localdomain>
Co-authored-by: Pawan Kumar <pawankumar@Pawans-MacBook-Pro.local>
Co-authored-by: Ashok Kumar M <35134347+marks0351@users.noreply.github.com>
Co-authored-by: Apple <nandan@thinkify.io>
2021-11-23 13:31:46 +05:30

208 lines
6.6 KiB
TypeScript

import React, { CSSProperties, useMemo, useRef } from "react";
import styled from "styled-components";
import { WidgetProps } from "widgets/BaseWidget";
import { WIDGET_PADDING } from "constants/WidgetConstants";
import { useSelector } from "react-redux";
import { AppState } from "reducers";
import { getColorWithOpacity } from "constants/DefaultTheme";
import {
useShowTableFilterPane,
useWidgetDragResize,
} from "utils/hooks/dragResizeHooks";
import { commentModeSelector } from "selectors/commentsSelectors";
import {
previewModeSelector,
snipingModeSelector,
} from "selectors/editorSelectors";
import { useWidgetSelection } from "utils/hooks/useWidgetSelection";
const DraggableWrapper = styled.div`
display: block;
flex-direction: column;
width: 100%;
height: 100%;
user-select: none;
cursor: grab;
`;
// Widget Boundaries which is shown to indicate the boundaries of the widget
const WidgetBoundaries = styled.div`
transform: translate3d(-${WIDGET_PADDING + 1}px, -${WIDGET_PADDING + 1}px, 0);
z-index: 0;
width: calc(100% + ${WIDGET_PADDING - 2}px);
height: calc(100% + ${WIDGET_PADDING - 2}px);
position: absolute;
border: 1px dashed
${(props) => getColorWithOpacity(props.theme.colors.textAnchor, 0.5)};
pointer-events: none;
`;
type DraggableComponentProps = WidgetProps;
/* eslint-disable react/display-name */
/**
* can drag helper function for react-dnd hook
*
* @param isResizingOrDragging
* @param isDraggingDisabled
* @param props
* @returns
*/
export const canDrag = (
isResizingOrDragging: boolean,
isDraggingDisabled: boolean,
props: any,
isCommentMode: boolean,
isSnipingMode: boolean,
isPreviewMode: boolean,
) => {
return (
!isResizingOrDragging &&
!isDraggingDisabled &&
!props?.dragDisabled &&
!isCommentMode &&
!isSnipingMode &&
!isPreviewMode
);
};
function DraggableComponent(props: DraggableComponentProps) {
// Dispatch hook handy to set a widget as focused/selected
const { focusWidget, selectWidget } = useWidgetSelection();
const isCommentMode = useSelector(commentModeSelector);
const isSnipingMode = useSelector(snipingModeSelector);
const isPreviewMode = useSelector(previewModeSelector);
// Dispatch hook handy to set any `DraggableComponent` as dragging/ not dragging
// The value is boolean
const { setDraggingCanvas, setDraggingState } = useWidgetDragResize();
const showTableFilterPane = useShowTableFilterPane();
const selectedWidgets = useSelector(
(state: AppState) => state.ui.widgetDragResize.selectedWidgets,
);
// This state tels us which widget is focused
// The value is the widgetId of the focused widget.
const focusedWidget = useSelector(
(state: AppState) => state.ui.widgetDragResize.focusedWidget,
);
const isCurrentWidgetFocused = focusedWidget === props.widgetId;
const isCurrentWidgetSelected = selectedWidgets.includes(props.widgetId);
// This state tells us whether a `ResizableComponent` is resizing
const isResizing = useSelector(
(state: AppState) => state.ui.widgetDragResize.isResizing,
);
// This state tells us whether a `DraggableComponent` is dragging
const isDragging = useSelector(
(state: AppState) => state.ui.widgetDragResize.isDragging,
);
// This state tells us to disable dragging,
// This is usually true when widgets themselves implement drag/drop
// This flag resolves conflicting drag/drop triggers.
const isDraggingDisabled: boolean = useSelector(
(state: AppState) => state.ui.widgetDragResize.isDraggingDisabled,
);
// True when any widget is dragging or resizing, including this one
const isResizingOrDragging = !!isResizing || !!isDragging;
const isCurrentWidgetDragging = isDragging && isCurrentWidgetSelected;
const isCurrentWidgetResizing = isResizing && isCurrentWidgetSelected;
// When mouse is over this draggable
const handleMouseOver = (e: any) => {
focusWidget &&
!isResizingOrDragging &&
!isCurrentWidgetFocused &&
!props.resizeDisabled &&
focusWidget(props.widgetId);
e.stopPropagation();
};
const shouldRenderComponent = !(isCurrentWidgetSelected && isDragging);
// Display this draggable based on the current drag state
const dragWrapperStyle: CSSProperties = {
display: isCurrentWidgetDragging ? "none" : "block",
};
const dragBoundariesStyle: React.CSSProperties = useMemo(() => {
return {
opacity: !isResizingOrDragging || isCurrentWidgetResizing ? 0 : 1,
position: "absolute",
transform: `translate(-50%, -50%)`,
top: "50%",
left: "50%",
};
}, [isResizingOrDragging, isCurrentWidgetResizing]);
const widgetBoundaries = <WidgetBoundaries style={dragBoundariesStyle} />;
const classNameForTesting = `t--draggable-${props.type
.split("_")
.join("")
.toLowerCase()}`;
const allowDrag = canDrag(
isResizingOrDragging,
isDraggingDisabled,
props,
isCommentMode,
isSnipingMode,
isPreviewMode,
);
const className = `${classNameForTesting}`;
const draggableRef = useRef<HTMLDivElement>(null);
const onDragStart = (e: any) => {
e.preventDefault();
e.stopPropagation();
// allowDrag check is added as react jest test simulation is not respecting default behaviour
// of draggable=false and triggering onDragStart. allowDrag condition check is purely for the test cases.
if (allowDrag && draggableRef.current && !(e.metaKey || e.ctrlKey)) {
if (!isCurrentWidgetFocused) return;
if (!isCurrentWidgetSelected) {
selectWidget(props.widgetId);
}
const widgetHeight = props.bottomRow - props.topRow;
const widgetWidth = props.rightColumn - props.leftColumn;
const bounds = draggableRef.current.getBoundingClientRect();
const startPoints = {
top: Math.min(
Math.max((e.clientY - bounds.top) / props.parentRowSpace, 0),
widgetHeight - 1,
),
left: Math.min(
Math.max((e.clientX - bounds.left) / props.parentColumnSpace, 0),
widgetWidth - 1,
),
};
showTableFilterPane();
setDraggingCanvas(props.parentId);
setDraggingState({
isDragging: true,
dragGroupActualParent: props.parentId || "",
draggingGroupCenter: { widgetId: props.widgetId },
startPoints,
});
}
};
return (
<DraggableWrapper
className={className}
data-testid={isCurrentWidgetSelected ? "t--selected" : ""}
draggable={allowDrag}
onDragStart={onDragStart}
onMouseOver={handleMouseOver}
ref={draggableRef}
style={dragWrapperStyle}
>
{shouldRenderComponent && props.children}
{widgetBoundaries}
</DraggableWrapper>
);
}
export default DraggableComponent;