chore(types): enforce defaultProps inside react flow component
This commit is contained in:
@@ -50,6 +50,8 @@ export default (NodeComponent: ComponentType<NodeProps>) => {
|
|||||||
dragHandle,
|
dragHandle,
|
||||||
zIndex,
|
zIndex,
|
||||||
isParent,
|
isParent,
|
||||||
|
noPanClassName,
|
||||||
|
noDragClassName,
|
||||||
}: WrapNodeProps) => {
|
}: WrapNodeProps) => {
|
||||||
const {
|
const {
|
||||||
addSelectedElements,
|
addSelectedElements,
|
||||||
@@ -217,6 +219,7 @@ export default (NodeComponent: ComponentType<NodeProps>) => {
|
|||||||
const nodeClasses = cc([
|
const nodeClasses = cc([
|
||||||
'react-flow__node',
|
'react-flow__node',
|
||||||
`react-flow__node-${type}`,
|
`react-flow__node-${type}`,
|
||||||
|
noPanClassName,
|
||||||
className,
|
className,
|
||||||
{
|
{
|
||||||
selected,
|
selected,
|
||||||
@@ -232,7 +235,7 @@ export default (NodeComponent: ComponentType<NodeProps>) => {
|
|||||||
onStop={onDragStop}
|
onStop={onDragStop}
|
||||||
scale={scale}
|
scale={scale}
|
||||||
disabled={!isDraggable}
|
disabled={!isDraggable}
|
||||||
cancel=".nodrag"
|
cancel={`.${noDragClassName}`}
|
||||||
nodeRef={nodeElement}
|
nodeRef={nodeElement}
|
||||||
grid={grid}
|
grid={grid}
|
||||||
enableUserSelectHack={false}
|
enableUserSelectHack={false}
|
||||||
|
|||||||
@@ -59,8 +59,7 @@ const FlowRenderer = ({
|
|||||||
onSelectionDrag,
|
onSelectionDrag,
|
||||||
onSelectionDragStop,
|
onSelectionDragStop,
|
||||||
onSelectionContextMenu,
|
onSelectionContextMenu,
|
||||||
noDragClassName,
|
noWheelClassName,
|
||||||
noZoomClassName,
|
|
||||||
noPanClassName,
|
noPanClassName,
|
||||||
}: FlowRendererProps) => {
|
}: FlowRendererProps) => {
|
||||||
const { unsetNodesSelection, resetSelectedElements, nodesSelectionActive } = useStore(selector, shallow);
|
const { unsetNodesSelection, resetSelectedElements, nodesSelectionActive } = useStore(selector, shallow);
|
||||||
@@ -110,8 +109,7 @@ const FlowRenderer = ({
|
|||||||
defaultZoom={defaultZoom}
|
defaultZoom={defaultZoom}
|
||||||
zoomActivationKeyCode={zoomActivationKeyCode}
|
zoomActivationKeyCode={zoomActivationKeyCode}
|
||||||
preventScrolling={preventScrolling}
|
preventScrolling={preventScrolling}
|
||||||
noDragClassName={noDragClassName}
|
noWheelClassName={noWheelClassName}
|
||||||
noZoomClassName={noZoomClassName}
|
|
||||||
noPanClassName={noPanClassName}
|
noPanClassName={noPanClassName}
|
||||||
>
|
>
|
||||||
{children}
|
{children}
|
||||||
|
|||||||
@@ -20,6 +20,9 @@ export interface GraphViewProps extends Omit<ReactFlowProps, 'onSelectionChange'
|
|||||||
defaultPosition: [number, number];
|
defaultPosition: [number, number];
|
||||||
defaultMarkerColor: string;
|
defaultMarkerColor: string;
|
||||||
selectNodesOnDrag: boolean;
|
selectNodesOnDrag: boolean;
|
||||||
|
noDragClassName: string;
|
||||||
|
noWheelClassName: string;
|
||||||
|
noPanClassName: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
const GraphView = ({
|
const GraphView = ({
|
||||||
@@ -77,7 +80,7 @@ const GraphView = ({
|
|||||||
onEdgeUpdateStart,
|
onEdgeUpdateStart,
|
||||||
onEdgeUpdateEnd,
|
onEdgeUpdateEnd,
|
||||||
noDragClassName,
|
noDragClassName,
|
||||||
noZoomClassName,
|
noWheelClassName,
|
||||||
noPanClassName,
|
noPanClassName,
|
||||||
}: GraphViewProps) => {
|
}: GraphViewProps) => {
|
||||||
useOnLoadHandler(onLoad);
|
useOnLoadHandler(onLoad);
|
||||||
@@ -110,7 +113,7 @@ const GraphView = ({
|
|||||||
onSelectionContextMenu={onSelectionContextMenu}
|
onSelectionContextMenu={onSelectionContextMenu}
|
||||||
preventScrolling={preventScrolling}
|
preventScrolling={preventScrolling}
|
||||||
noDragClassName={noDragClassName}
|
noDragClassName={noDragClassName}
|
||||||
noZoomClassName={noZoomClassName}
|
noWheelClassName={noWheelClassName}
|
||||||
noPanClassName={noPanClassName}
|
noPanClassName={noPanClassName}
|
||||||
>
|
>
|
||||||
<Viewport>
|
<Viewport>
|
||||||
@@ -147,6 +150,7 @@ const GraphView = ({
|
|||||||
selectNodesOnDrag={selectNodesOnDrag}
|
selectNodesOnDrag={selectNodesOnDrag}
|
||||||
onlyRenderVisibleElements={onlyRenderVisibleElements}
|
onlyRenderVisibleElements={onlyRenderVisibleElements}
|
||||||
noPanClassName={noPanClassName}
|
noPanClassName={noPanClassName}
|
||||||
|
noDragClassName={noDragClassName}
|
||||||
/>
|
/>
|
||||||
</Viewport>
|
</Viewport>
|
||||||
</FlowRenderer>
|
</FlowRenderer>
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
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';
|
||||||
@@ -18,7 +17,8 @@ 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;
|
noPanClassName: string;
|
||||||
|
noDragClassName: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
const selector = (s: ReactFlowState) => ({
|
const selector = (s: ReactFlowState) => ({
|
||||||
@@ -83,7 +83,7 @@ const NodeRenderer = (props: NodeRendererProps) => {
|
|||||||
<NodeComponent
|
<NodeComponent
|
||||||
key={node.id}
|
key={node.id}
|
||||||
id={node.id}
|
id={node.id}
|
||||||
className={cc([node.className, props.noPanClassName])}
|
className={node.className}
|
||||||
style={node.style}
|
style={node.style}
|
||||||
type={nodeType}
|
type={nodeType}
|
||||||
data={node.data}
|
data={node.data}
|
||||||
@@ -115,6 +115,8 @@ const NodeRenderer = (props: NodeRendererProps) => {
|
|||||||
dragHandle={node.dragHandle}
|
dragHandle={node.dragHandle}
|
||||||
zIndex={internals?.z || 0}
|
zIndex={internals?.z || 0}
|
||||||
isParent={!!internals?.isParent}
|
isParent={!!internals?.isParent}
|
||||||
|
noDragClassName={props.noDragClassName}
|
||||||
|
noPanClassName={props.noPanClassName}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
})}
|
})}
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import React, {
|
|||||||
MouseEvent as ReactMouseEvent,
|
MouseEvent as ReactMouseEvent,
|
||||||
WheelEvent,
|
WheelEvent,
|
||||||
forwardRef,
|
forwardRef,
|
||||||
|
FunctionComponent,
|
||||||
} from 'react';
|
} from 'react';
|
||||||
import cc from 'classcat';
|
import cc from 'classcat';
|
||||||
|
|
||||||
@@ -130,7 +131,7 @@ export interface ReactFlowProps extends Omit<HTMLAttributes<HTMLDivElement>, 'on
|
|||||||
onEdgeUpdateEnd?: (event: MouseEvent, edge: Edge) => void;
|
onEdgeUpdateEnd?: (event: MouseEvent, edge: Edge) => void;
|
||||||
edgeUpdaterRadius?: number;
|
edgeUpdaterRadius?: number;
|
||||||
noDragClassName?: string;
|
noDragClassName?: string;
|
||||||
noZoomClassName?: string;
|
noWheelClassName?: string;
|
||||||
noPanClassName?: string;
|
noPanClassName?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -139,7 +140,7 @@ export type ReactFlowRefType = HTMLDivElement;
|
|||||||
const initSnapGrid: [number, number] = [15, 15];
|
const initSnapGrid: [number, number] = [15, 15];
|
||||||
const initDefaultPosition: [number, number] = [0, 0];
|
const initDefaultPosition: [number, number] = [0, 0];
|
||||||
|
|
||||||
const ReactFlow = forwardRef<ReactFlowRefType, ReactFlowProps>(
|
const ReactFlow: FunctionComponent<ReactFlowProps> = forwardRef<ReactFlowRefType, ReactFlowProps>(
|
||||||
(
|
(
|
||||||
{
|
{
|
||||||
nodes = [],
|
nodes = [],
|
||||||
@@ -216,7 +217,7 @@ const ReactFlow = forwardRef<ReactFlowRefType, ReactFlowProps>(
|
|||||||
onNodesChange,
|
onNodesChange,
|
||||||
onEdgesChange,
|
onEdgesChange,
|
||||||
noDragClassName = 'nodrag',
|
noDragClassName = 'nodrag',
|
||||||
noZoomClassName = 'nowheel',
|
noWheelClassName = 'nowheel',
|
||||||
noPanClassName = 'nopan',
|
noPanClassName = 'nopan',
|
||||||
...rest
|
...rest
|
||||||
},
|
},
|
||||||
@@ -283,7 +284,7 @@ const ReactFlow = forwardRef<ReactFlowRefType, ReactFlowProps>(
|
|||||||
edgeUpdaterRadius={edgeUpdaterRadius}
|
edgeUpdaterRadius={edgeUpdaterRadius}
|
||||||
defaultMarkerColor={defaultMarkerColor}
|
defaultMarkerColor={defaultMarkerColor}
|
||||||
noDragClassName={noDragClassName}
|
noDragClassName={noDragClassName}
|
||||||
noZoomClassName={noZoomClassName}
|
noWheelClassName={noWheelClassName}
|
||||||
noPanClassName={noPanClassName}
|
noPanClassName={noPanClassName}
|
||||||
/>
|
/>
|
||||||
<StoreUpdater
|
<StoreUpdater
|
||||||
|
|||||||
@@ -27,9 +27,8 @@ interface ZoomPaneProps {
|
|||||||
zoomActivationKeyCode?: KeyCode;
|
zoomActivationKeyCode?: KeyCode;
|
||||||
preventScrolling?: boolean;
|
preventScrolling?: boolean;
|
||||||
children: ReactNode;
|
children: ReactNode;
|
||||||
noDragClassName?: string;
|
noWheelClassName: string;
|
||||||
noZoomClassName?: string;
|
noPanClassName: string;
|
||||||
noPanClassName?: string;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const viewChanged = (prevTransform: FlowTransform, eventTransform: any): boolean =>
|
const viewChanged = (prevTransform: FlowTransform, eventTransform: any): boolean =>
|
||||||
@@ -44,7 +43,6 @@ const eventToFlowTransform = (eventTransform: any): FlowTransform => ({
|
|||||||
});
|
});
|
||||||
|
|
||||||
const isWrappedWithClass = (event: any, className: string | undefined) => event.target.closest(`.${className}`);
|
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,
|
||||||
@@ -73,7 +71,7 @@ const ZoomPane = ({
|
|||||||
zoomActivationKeyCode,
|
zoomActivationKeyCode,
|
||||||
preventScrolling = true,
|
preventScrolling = true,
|
||||||
children,
|
children,
|
||||||
noZoomClassName,
|
noWheelClassName,
|
||||||
noPanClassName,
|
noPanClassName,
|
||||||
}: ZoomPaneProps) => {
|
}: ZoomPaneProps) => {
|
||||||
const store = useStoreApi();
|
const store = useStoreApi();
|
||||||
@@ -112,7 +110,7 @@ const ZoomPane = ({
|
|||||||
if (panOnScroll && !zoomActivationKeyPressed) {
|
if (panOnScroll && !zoomActivationKeyPressed) {
|
||||||
d3Selection
|
d3Selection
|
||||||
.on('wheel', (event: any) => {
|
.on('wheel', (event: any) => {
|
||||||
if (isWrappedWithClass(event, noZoomClassName)) {
|
if (isWrappedWithClass(event, noWheelClassName)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
event.preventDefault();
|
event.preventDefault();
|
||||||
@@ -146,7 +144,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 || isWrappedWithClass(event, noZoomClassName)) {
|
if (!preventScrolling || isWrappedWithClass(event, noWheelClassName)) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -164,7 +162,7 @@ const ZoomPane = ({
|
|||||||
zoomActivationKeyPressed,
|
zoomActivationKeyPressed,
|
||||||
zoomOnPinch,
|
zoomOnPinch,
|
||||||
preventScrolling,
|
preventScrolling,
|
||||||
noZoomClassName,
|
noWheelClassName,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
@@ -238,7 +236,7 @@ const ZoomPane = ({
|
|||||||
}
|
}
|
||||||
|
|
||||||
// if the target element is inside the nowheel class, we prevent zooming
|
// if the target element is inside the nowheel class, we prevent zooming
|
||||||
if (isWrappedWithClass(event, noZoomClassName) && event.type === 'wheel') {
|
if (isWrappedWithClass(event, noWheelClassName) && event.type === 'wheel') {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -82,6 +82,8 @@ export interface WrapNodeProps<T = any> {
|
|||||||
dragHandle?: string;
|
dragHandle?: string;
|
||||||
zIndex: number;
|
zIndex: number;
|
||||||
isParent: boolean;
|
isParent: boolean;
|
||||||
|
noPanClassName: string;
|
||||||
|
noDragClassName: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export type NodeHandleBounds = {
|
export type NodeHandleBounds = {
|
||||||
|
|||||||
Reference in New Issue
Block a user