feat(flow): add properties for configuring no-interaction classes
This commit is contained in:
@@ -1,5 +1,6 @@
|
|||||||
import React, { memo, CSSProperties, useCallback } from 'react';
|
import React, { memo, CSSProperties, useCallback } from 'react';
|
||||||
import shallow from 'zustand/shallow';
|
import shallow from 'zustand/shallow';
|
||||||
|
import cc from 'classcat';
|
||||||
|
|
||||||
import { useStore } from '../../store';
|
import { useStore } from '../../store';
|
||||||
import ConnectionLine from '../../components/ConnectionLine/index';
|
import ConnectionLine from '../../components/ConnectionLine/index';
|
||||||
@@ -35,6 +36,7 @@ interface EdgeRendererProps {
|
|||||||
onEdgeUpdateStart?: (event: React.MouseEvent, edge: Edge) => void;
|
onEdgeUpdateStart?: (event: React.MouseEvent, edge: Edge) => void;
|
||||||
onEdgeUpdateEnd?: (event: MouseEvent, edge: Edge) => void;
|
onEdgeUpdateEnd?: (event: MouseEvent, edge: Edge) => void;
|
||||||
edgeUpdaterRadius?: number;
|
edgeUpdaterRadius?: number;
|
||||||
|
noPanClassName?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
interface EdgeWrapperProps {
|
interface EdgeWrapperProps {
|
||||||
@@ -63,6 +65,7 @@ interface EdgeWrapperProps {
|
|||||||
targetNodeX?: number;
|
targetNodeX?: number;
|
||||||
targetNodeY?: number;
|
targetNodeY?: number;
|
||||||
targetNodeHandleBounds?: NodeHandleBounds;
|
targetNodeHandleBounds?: NodeHandleBounds;
|
||||||
|
noPanClassName?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
const Edge = memo(
|
const Edge = memo(
|
||||||
@@ -92,6 +95,7 @@ const Edge = memo(
|
|||||||
targetNodeX,
|
targetNodeX,
|
||||||
targetNodeY,
|
targetNodeY,
|
||||||
targetNodeHandleBounds,
|
targetNodeHandleBounds,
|
||||||
|
noPanClassName,
|
||||||
}: EdgeWrapperProps) => {
|
}: EdgeWrapperProps) => {
|
||||||
const sourceHandleId = edge.sourceHandle || null;
|
const sourceHandleId = edge.sourceHandle || null;
|
||||||
const targetHandleId = edge.targetHandle || null;
|
const targetHandleId = edge.targetHandle || null;
|
||||||
@@ -163,7 +167,7 @@ const Edge = memo(
|
|||||||
<EdgeComponent
|
<EdgeComponent
|
||||||
key={edge.id}
|
key={edge.id}
|
||||||
id={edge.id}
|
id={edge.id}
|
||||||
className={edge.className}
|
className={cc([edge.className, noPanClassName])}
|
||||||
type={edgeType}
|
type={edgeType}
|
||||||
data={edge.data}
|
data={edge.data}
|
||||||
onClick={onEdgeClick}
|
onClick={onEdgeClick}
|
||||||
@@ -283,6 +287,7 @@ const EdgeRenderer = (props: EdgeRendererProps) => {
|
|||||||
onEdgeUpdate={props.onEdgeUpdate}
|
onEdgeUpdate={props.onEdgeUpdate}
|
||||||
edgeTypes={props.edgeTypes}
|
edgeTypes={props.edgeTypes}
|
||||||
connectionMode={connectionMode}
|
connectionMode={connectionMode}
|
||||||
|
noPanClassName={props.noPanClassName}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
})}
|
})}
|
||||||
|
|||||||
@@ -59,6 +59,9 @@ const FlowRenderer = ({
|
|||||||
onSelectionDrag,
|
onSelectionDrag,
|
||||||
onSelectionDragStop,
|
onSelectionDragStop,
|
||||||
onSelectionContextMenu,
|
onSelectionContextMenu,
|
||||||
|
noDragClassName,
|
||||||
|
noZoomClassName,
|
||||||
|
noPanClassName,
|
||||||
}: FlowRendererProps) => {
|
}: FlowRendererProps) => {
|
||||||
const { unsetNodesSelection, resetSelectedElements, nodesSelectionActive } = useStore(selector, shallow);
|
const { unsetNodesSelection, resetSelectedElements, nodesSelectionActive } = useStore(selector, shallow);
|
||||||
|
|
||||||
@@ -107,6 +110,9 @@ const FlowRenderer = ({
|
|||||||
defaultZoom={defaultZoom}
|
defaultZoom={defaultZoom}
|
||||||
zoomActivationKeyCode={zoomActivationKeyCode}
|
zoomActivationKeyCode={zoomActivationKeyCode}
|
||||||
preventScrolling={preventScrolling}
|
preventScrolling={preventScrolling}
|
||||||
|
noDragClassName={noDragClassName}
|
||||||
|
noZoomClassName={noZoomClassName}
|
||||||
|
noPanClassName={noPanClassName}
|
||||||
>
|
>
|
||||||
{children}
|
{children}
|
||||||
<UserSelection selectionKeyPressed={selectionKeyPressed} />
|
<UserSelection selectionKeyPressed={selectionKeyPressed} />
|
||||||
|
|||||||
@@ -76,6 +76,9 @@ const GraphView = ({
|
|||||||
edgeUpdaterRadius,
|
edgeUpdaterRadius,
|
||||||
onEdgeUpdateStart,
|
onEdgeUpdateStart,
|
||||||
onEdgeUpdateEnd,
|
onEdgeUpdateEnd,
|
||||||
|
noDragClassName,
|
||||||
|
noZoomClassName,
|
||||||
|
noPanClassName,
|
||||||
}: GraphViewProps) => {
|
}: GraphViewProps) => {
|
||||||
useOnLoadHandler(onLoad);
|
useOnLoadHandler(onLoad);
|
||||||
|
|
||||||
@@ -106,6 +109,9 @@ const GraphView = ({
|
|||||||
onSelectionDragStop={onSelectionDragStop}
|
onSelectionDragStop={onSelectionDragStop}
|
||||||
onSelectionContextMenu={onSelectionContextMenu}
|
onSelectionContextMenu={onSelectionContextMenu}
|
||||||
preventScrolling={preventScrolling}
|
preventScrolling={preventScrolling}
|
||||||
|
noDragClassName={noDragClassName}
|
||||||
|
noZoomClassName={noZoomClassName}
|
||||||
|
noPanClassName={noPanClassName}
|
||||||
>
|
>
|
||||||
<Viewport>
|
<Viewport>
|
||||||
<EdgeRenderer
|
<EdgeRenderer
|
||||||
@@ -125,6 +131,7 @@ const GraphView = ({
|
|||||||
onEdgeUpdateEnd={onEdgeUpdateEnd}
|
onEdgeUpdateEnd={onEdgeUpdateEnd}
|
||||||
edgeUpdaterRadius={edgeUpdaterRadius}
|
edgeUpdaterRadius={edgeUpdaterRadius}
|
||||||
defaultMarkerColor={defaultMarkerColor}
|
defaultMarkerColor={defaultMarkerColor}
|
||||||
|
noPanClassName={noPanClassName}
|
||||||
/>
|
/>
|
||||||
<NodeRenderer
|
<NodeRenderer
|
||||||
nodeTypes={nodeTypes}
|
nodeTypes={nodeTypes}
|
||||||
@@ -139,6 +146,7 @@ const GraphView = ({
|
|||||||
onNodeDragStart={onNodeDragStart}
|
onNodeDragStart={onNodeDragStart}
|
||||||
selectNodesOnDrag={selectNodesOnDrag}
|
selectNodesOnDrag={selectNodesOnDrag}
|
||||||
onlyRenderVisibleElements={onlyRenderVisibleElements}
|
onlyRenderVisibleElements={onlyRenderVisibleElements}
|
||||||
|
noPanClassName={noPanClassName}
|
||||||
/>
|
/>
|
||||||
</Viewport>
|
</Viewport>
|
||||||
</FlowRenderer>
|
</FlowRenderer>
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
import React, { memo, useMemo, ComponentType, MouseEvent } from 'react';
|
import React, { memo, useMemo, ComponentType, MouseEvent } from 'react';
|
||||||
import shallow from 'zustand/shallow';
|
import shallow from 'zustand/shallow';
|
||||||
|
import cc from 'classcat';
|
||||||
|
|
||||||
import { useStore } from '../../store';
|
import { useStore } from '../../store';
|
||||||
import { Node, NodeTypesType, ReactFlowState, WrapNodeProps } from '../../types';
|
import { Node, NodeTypesType, ReactFlowState, WrapNodeProps } from '../../types';
|
||||||
@@ -19,6 +20,7 @@ interface NodeRendererProps {
|
|||||||
onNodeDrag?: (event: MouseEvent, node: Node) => void;
|
onNodeDrag?: (event: MouseEvent, node: Node) => void;
|
||||||
onNodeDragStop?: (event: MouseEvent, node: Node) => void;
|
onNodeDragStop?: (event: MouseEvent, node: Node) => void;
|
||||||
onlyRenderVisibleElements: boolean;
|
onlyRenderVisibleElements: boolean;
|
||||||
|
noPanClassName?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
const selector = (s: ReactFlowState) => ({
|
const selector = (s: ReactFlowState) => ({
|
||||||
@@ -76,7 +78,7 @@ const NodeRenderer = (props: NodeRendererProps) => {
|
|||||||
<NodeComponent
|
<NodeComponent
|
||||||
key={node.id}
|
key={node.id}
|
||||||
id={node.id}
|
id={node.id}
|
||||||
className={node.className}
|
className={cc([node.className, props.noPanClassName])}
|
||||||
style={node.style}
|
style={node.style}
|
||||||
type={nodeType}
|
type={nodeType}
|
||||||
data={node.data}
|
data={node.data}
|
||||||
|
|||||||
@@ -129,6 +129,9 @@ export interface ReactFlowProps extends Omit<HTMLAttributes<HTMLDivElement>, 'on
|
|||||||
onEdgeUpdateStart?: (event: ReactMouseEvent, edge: Edge) => void;
|
onEdgeUpdateStart?: (event: ReactMouseEvent, edge: Edge) => void;
|
||||||
onEdgeUpdateEnd?: (event: MouseEvent, edge: Edge) => void;
|
onEdgeUpdateEnd?: (event: MouseEvent, edge: Edge) => void;
|
||||||
edgeUpdaterRadius?: number;
|
edgeUpdaterRadius?: number;
|
||||||
|
noDragClassName?: string;
|
||||||
|
noZoomClassName?: string;
|
||||||
|
noPanClassName?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export type ReactFlowRefType = HTMLDivElement;
|
export type ReactFlowRefType = HTMLDivElement;
|
||||||
@@ -212,6 +215,9 @@ const ReactFlow = forwardRef<ReactFlowRefType, ReactFlowProps>(
|
|||||||
edgeUpdaterRadius = 10,
|
edgeUpdaterRadius = 10,
|
||||||
onNodesChange,
|
onNodesChange,
|
||||||
onEdgesChange,
|
onEdgesChange,
|
||||||
|
noDragClassName = 'nodrag',
|
||||||
|
noZoomClassName = 'nowheel',
|
||||||
|
noPanClassName = 'nopan',
|
||||||
...rest
|
...rest
|
||||||
},
|
},
|
||||||
ref
|
ref
|
||||||
@@ -276,6 +282,9 @@ const ReactFlow = forwardRef<ReactFlowRefType, ReactFlowProps>(
|
|||||||
onEdgeUpdateEnd={onEdgeUpdateEnd}
|
onEdgeUpdateEnd={onEdgeUpdateEnd}
|
||||||
edgeUpdaterRadius={edgeUpdaterRadius}
|
edgeUpdaterRadius={edgeUpdaterRadius}
|
||||||
defaultMarkerColor={defaultMarkerColor}
|
defaultMarkerColor={defaultMarkerColor}
|
||||||
|
noDragClassName={noDragClassName}
|
||||||
|
noZoomClassName={noZoomClassName}
|
||||||
|
noPanClassName={noPanClassName}
|
||||||
/>
|
/>
|
||||||
<StoreUpdater
|
<StoreUpdater
|
||||||
nodes={nodes}
|
nodes={nodes}
|
||||||
|
|||||||
@@ -27,6 +27,9 @@ interface ZoomPaneProps {
|
|||||||
zoomActivationKeyCode?: KeyCode;
|
zoomActivationKeyCode?: KeyCode;
|
||||||
preventScrolling?: boolean;
|
preventScrolling?: boolean;
|
||||||
children: ReactNode;
|
children: ReactNode;
|
||||||
|
noDragClassName?: string;
|
||||||
|
noZoomClassName?: string;
|
||||||
|
noPanClassName?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
const viewChanged = (prevTransform: FlowTransform, eventTransform: any): boolean =>
|
const viewChanged = (prevTransform: FlowTransform, eventTransform: any): boolean =>
|
||||||
@@ -40,7 +43,8 @@ const eventToFlowTransform = (eventTransform: any): FlowTransform => ({
|
|||||||
zoom: eventTransform.k,
|
zoom: eventTransform.k,
|
||||||
});
|
});
|
||||||
|
|
||||||
const hasNoWheelClass = (event: any) => event.target.closest('.nowheel');
|
const isWrappedWithClass = (event: any, className: string | undefined) => event.target.closest(`.${className}`);
|
||||||
|
// const hasNoWheelClass = (event: any) => event.target.closest('.nowheel');
|
||||||
|
|
||||||
const selector = (s: ReactFlowState) => ({
|
const selector = (s: ReactFlowState) => ({
|
||||||
d3Zoom: s.d3Zoom,
|
d3Zoom: s.d3Zoom,
|
||||||
@@ -69,6 +73,8 @@ const ZoomPane = ({
|
|||||||
zoomActivationKeyCode,
|
zoomActivationKeyCode,
|
||||||
preventScrolling = true,
|
preventScrolling = true,
|
||||||
children,
|
children,
|
||||||
|
noZoomClassName,
|
||||||
|
noPanClassName,
|
||||||
}: ZoomPaneProps) => {
|
}: ZoomPaneProps) => {
|
||||||
const store = useStoreApi();
|
const store = useStoreApi();
|
||||||
const zoomPane = useRef<HTMLDivElement>(null);
|
const zoomPane = useRef<HTMLDivElement>(null);
|
||||||
@@ -106,7 +112,7 @@ const ZoomPane = ({
|
|||||||
if (panOnScroll && !zoomActivationKeyPressed) {
|
if (panOnScroll && !zoomActivationKeyPressed) {
|
||||||
d3Selection
|
d3Selection
|
||||||
.on('wheel', (event: any) => {
|
.on('wheel', (event: any) => {
|
||||||
if (hasNoWheelClass(event)) {
|
if (isWrappedWithClass(event, noZoomClassName)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
event.preventDefault();
|
event.preventDefault();
|
||||||
@@ -140,7 +146,7 @@ const ZoomPane = ({
|
|||||||
} else if (typeof d3ZoomHandler !== 'undefined') {
|
} else if (typeof d3ZoomHandler !== 'undefined') {
|
||||||
d3Selection
|
d3Selection
|
||||||
.on('wheel', (event: any) => {
|
.on('wheel', (event: any) => {
|
||||||
if (!preventScrolling || hasNoWheelClass(event)) {
|
if (!preventScrolling || isWrappedWithClass(event, noZoomClassName)) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -158,6 +164,7 @@ const ZoomPane = ({
|
|||||||
zoomActivationKeyPressed,
|
zoomActivationKeyPressed,
|
||||||
zoomOnPinch,
|
zoomOnPinch,
|
||||||
preventScrolling,
|
preventScrolling,
|
||||||
|
noZoomClassName,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
@@ -230,22 +237,28 @@ const ZoomPane = ({
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (hasNoWheelClass(event) && event.type === 'wheel') {
|
// if the target element is inside the nowheel class, we prevent zooming
|
||||||
|
if (isWrappedWithClass(event, noZoomClassName) && event.type === 'wheel') {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
// if the target element is inside the nopan class, we prevent panning
|
||||||
|
if (isWrappedWithClass(event, noPanClassName) && event.type !== 'wheel') {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
// when the target element is a node, we still allow zooming
|
// when the target element is a node, we still allow zooming
|
||||||
if (
|
// if (
|
||||||
(event.target.closest('.react-flow__node') || event.target.closest('.react-flow__edge')) &&
|
// (event.target.closest('.react-flow__node') || event.target.closest('.react-flow__edge')) &&
|
||||||
event.type !== 'wheel'
|
// event.type !== 'wheel'
|
||||||
) {
|
// ) {
|
||||||
return false;
|
// return false;
|
||||||
}
|
// }
|
||||||
|
|
||||||
// when the target element is a node selection, we still allow zooming
|
// // when the target element is a node selection, we still allow zooming
|
||||||
if (event.target.closest('.react-flow__nodesselection') && event.type !== 'wheel') {
|
// if (event.target.closest('.react-flow__nodesselection') && event.type !== 'wheel') {
|
||||||
return false;
|
// return false;
|
||||||
}
|
// }
|
||||||
|
|
||||||
if (!zoomOnPinch && event.ctrlKey && event.type === 'wheel') {
|
if (!zoomOnPinch && event.ctrlKey && event.type === 'wheel') {
|
||||||
return false;
|
return false;
|
||||||
|
|||||||
Reference in New Issue
Block a user