♻️ Rename 'MiniMapNode' prop to 'nodeComponent' for greater consistency.

This commit is contained in:
Hayleigh Thompson
2023-03-09 14:46:46 +00:00
parent 1415ed003e
commit 2acc5b7706
2 changed files with 5 additions and 5 deletions
+4 -4
View File
@@ -55,6 +55,9 @@ function MiniMap({
nodeClassName = '',
nodeBorderRadius = 5,
nodeStrokeWidth = 2,
// We need to rename the prop to be `CapitalCase` so that JSX will render it as
// a component properly.
nodeComponent: NodeComponent = MiniMapNode,
maskColor = 'rgb(240, 240, 240, 0.6)',
maskStrokeColor = 'none',
maskStrokeWidth = 1,
@@ -64,9 +67,6 @@ function MiniMap({
pannable = false,
zoomable = false,
ariaLabel = 'React Flow mini map',
// Rename the field to avoid clashes with the default `MiniMapNode` component.
// Fallback to that component if none is provided.
MiniMapNode: CustomMiniMapNode = MiniMapNode,
}: MiniMapProps) {
const store = useStoreApi();
const svg = useRef<SVGSVGElement>(null);
@@ -179,7 +179,7 @@ function MiniMap({
const { x, y } = getNodePositionWithOrigin(node, nodeOrigin).positionAbsolute;
return (
<CustomMiniMapNode
<NodeComponent
key={node.id}
x={x}
y={y}
+1 -1
View File
@@ -10,6 +10,7 @@ export type MiniMapProps<NodeData = any> = Omit<HTMLAttributes<SVGSVGElement>, '
nodeClassName?: string | GetMiniMapNodeAttribute<NodeData>;
nodeBorderRadius?: number;
nodeStrokeWidth?: number;
nodeComponent?: ComponentType<MiniMapNodeProps>;
maskColor?: string;
maskStrokeColor?: string;
maskStrokeWidth?: number;
@@ -19,7 +20,6 @@ export type MiniMapProps<NodeData = any> = Omit<HTMLAttributes<SVGSVGElement>, '
pannable?: boolean;
zoomable?: boolean;
ariaLabel?: string | null;
MiniMapNode?: ComponentType<MiniMapNodeProps>;
};
export interface MiniMapNodeProps {