From 6bbc15204137eecfa4a77141c27a38206051ef5e Mon Sep 17 00:00:00 2001 From: moklick Date: Tue, 11 Aug 2020 10:36:22 +0200 Subject: [PATCH] feat(edge-options): add labelBgPadding #421 --- README.md | 1 + example/src/Edges/index.js | 3 +- src/components/Edges/BezierEdge.tsx | 2 + src/components/Edges/EdgeText.tsx | 70 ++++++++++++------------- src/components/Edges/SmoothStepEdge.tsx | 2 + src/components/Edges/StraightEdge.tsx | 2 + src/components/Edges/wrapEdge.tsx | 5 +- src/container/EdgeRenderer/index.tsx | 1 + src/hooks/useElementUpdater.ts | 4 ++ src/types/index.ts | 4 ++ 10 files changed, 57 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 7731d35c..e62481f3 100644 --- a/README.md +++ b/README.md @@ -283,6 +283,7 @@ If you wanted to display this edge, you would need a node with id = 1 (source no - `labelStyle`: css properties for the text - `labelShowBg`: boolean - default: `true` - `labelBgStyle`: css properties for the text background +- `labelBgPadding`: [number, number] background rectangle padding - default: `[2, 4]` - `arrowHeadType`: 'arrow' or 'arrowclosed' - defines the arrowhead of the edge - `markerEndId`: custom marker end url - if this is used `arrowHeadType` gets ignored - `isHidden`: if `true`, the edge will not be rendered diff --git a/example/src/Edges/index.js b/example/src/Edges/index.js index cd9e5d01..55a08d47 100644 --- a/example/src/Edges/index.js +++ b/example/src/Edges/index.js @@ -38,8 +38,9 @@ const initialElements = [ source: '5', target: '7', label: 'label with styled bg', - labelBgStyle: { fill: '#eee', fillOpacity: 0.7 }, + labelBgStyle: { fill: '#555', color: '#fff', fillOpacity: 0.7 }, arrowHeadType: 'arrowclosed', + labelBgPadding: [8, 4], }, { id: 'e5-8', source: '5', target: '8', type: 'custom', data: { text: 'custom edge' }, arrowHeadType: 'arrowclosed' }, ]; diff --git a/src/components/Edges/BezierEdge.tsx b/src/components/Edges/BezierEdge.tsx index 09a3cc07..59b93399 100644 --- a/src/components/Edges/BezierEdge.tsx +++ b/src/components/Edges/BezierEdge.tsx @@ -53,6 +53,7 @@ export default memo( style, arrowHeadType, markerEndId, + labelBgPadding, }: EdgeBezierProps) => { const [centerX, centerY] = getCenter({ sourceX, sourceY, targetX, targetY }); const path = getBezierPath({ @@ -72,6 +73,7 @@ export default memo( labelStyle={labelStyle} labelShowBg={labelShowBg} labelBgStyle={labelBgStyle} + labelBgPadding={labelBgPadding} /> ) : null; diff --git a/src/components/Edges/EdgeText.tsx b/src/components/Edges/EdgeText.tsx index 44ac3285..e10e84d2 100644 --- a/src/components/Edges/EdgeText.tsx +++ b/src/components/Edges/EdgeText.tsx @@ -2,44 +2,44 @@ import React, { memo, useRef, useState, useEffect } from 'react'; import { EdgeTextProps, Rect } from '../../types'; -const textBgPadding = 2; +export default memo( + ({ x, y, label, labelStyle = {}, labelShowBg = true, labelBgStyle = {}, labelBgPadding = [2, 4] }: EdgeTextProps) => { + const edgeRef = useRef(null); + const [edgeTextBbox, setEdgeTextBbox] = useState({ x: 0, y: 0, width: 0, height: 0 }); -export default memo(({ x, y, label, labelStyle = {}, labelShowBg = true, labelBgStyle = {} }: EdgeTextProps) => { - const edgeRef = useRef(null); - const [edgeTextBbox, setEdgeTextBbox] = useState({ x: 0, y: 0, width: 0, height: 0 }); + useEffect(() => { + if (edgeRef.current) { + const textBbox = edgeRef.current.getBBox(); - useEffect(() => { - if (edgeRef.current) { - const textBbox = edgeRef.current.getBBox(); + setEdgeTextBbox({ + x: textBbox.x, + y: textBbox.y, + width: textBbox.width, + height: textBbox.height, + }); + } + }, []); - setEdgeTextBbox({ - x: textBbox.x, - y: textBbox.y, - width: textBbox.width, - height: textBbox.height, - }); + if (typeof label === 'undefined' || !label) { + return null; } - }, []); - if (typeof label === 'undefined' || !label) { - return null; + return ( + + {labelShowBg && ( + + )} + + {label} + + + ); } - - return ( - - {labelShowBg && ( - - )} - - {label} - - - ); -}); +); diff --git a/src/components/Edges/SmoothStepEdge.tsx b/src/components/Edges/SmoothStepEdge.tsx index 3ad04d44..989ccaf3 100644 --- a/src/components/Edges/SmoothStepEdge.tsx +++ b/src/components/Edges/SmoothStepEdge.tsx @@ -131,6 +131,7 @@ export default memo( labelStyle, labelShowBg, labelBgStyle, + labelBgPadding, style, sourcePosition = Position.Bottom, targetPosition = Position.Top, @@ -160,6 +161,7 @@ export default memo( labelStyle={labelStyle} labelShowBg={labelShowBg} labelBgStyle={labelBgStyle} + labelBgPadding={labelBgPadding} /> ) : null; diff --git a/src/components/Edges/StraightEdge.tsx b/src/components/Edges/StraightEdge.tsx index 8721cf44..17ebcb8b 100644 --- a/src/components/Edges/StraightEdge.tsx +++ b/src/components/Edges/StraightEdge.tsx @@ -14,6 +14,7 @@ export default memo( labelStyle, labelShowBg, labelBgStyle, + labelBgPadding, style, arrowHeadType, markerEndId, @@ -33,6 +34,7 @@ export default memo( labelStyle={labelStyle} labelShowBg={labelShowBg} labelBgStyle={labelBgStyle} + labelBgPadding={labelBgPadding} /> ) : null; diff --git a/src/components/Edges/wrapEdge.tsx b/src/components/Edges/wrapEdge.tsx index d8c67704..5fd3b728 100644 --- a/src/components/Edges/wrapEdge.tsx +++ b/src/components/Edges/wrapEdge.tsx @@ -12,7 +12,8 @@ interface EdgeWrapperProps { label?: string; labelStyle?: CSSProperties; labelShowBg?: boolean; - labelBgStyle: CSSProperties; + labelBgStyle?: CSSProperties; + labelBgPadding?: [number, number]; className?: string; onClick?: (event: React.MouseEvent, edge: Edge) => void; animated?: boolean; @@ -36,6 +37,7 @@ export default (EdgeComponent: ComponentType) => { labelStyle, labelShowBg, labelBgStyle, + labelBgPadding, className, isHidden, data, @@ -77,6 +79,7 @@ export default (EdgeComponent: ComponentType) => { labelStyle={labelStyle} labelShowBg={labelShowBg} labelBgStyle={labelBgStyle} + labelBgPadding={labelBgPadding} data={data} {...rest} /> diff --git a/src/container/EdgeRenderer/index.tsx b/src/container/EdgeRenderer/index.tsx index 90fa9b25..7b6efe86 100644 --- a/src/container/EdgeRenderer/index.tsx +++ b/src/container/EdgeRenderer/index.tsx @@ -171,6 +171,7 @@ function renderEdge( labelStyle={edge.labelStyle} labelShowBg={edge.labelShowBg} labelBgStyle={edge.labelBgStyle} + labelBgPadding={edge.labelBgPadding} style={edge.style} arrowHeadType={edge.arrowHeadType} source={sourceId} diff --git a/src/hooks/useElementUpdater.ts b/src/hooks/useElementUpdater.ts index 2765ab41..b03c33d5 100644 --- a/src/hooks/useElementUpdater.ts +++ b/src/hooks/useElementUpdater.ts @@ -94,6 +94,10 @@ const useElementUpdater = (propElements: Elements): void => { edgeProps.labelShowBg = propEdge.labelShowBg; } + if (typeof propEdge.labelBgPadding !== 'undefined') { + edgeProps.labelBgPadding = propEdge.labelBgPadding; + } + if (typeof labelBgStyle !== 'undefined') { edgeProps.labelBgStyle = labelBgStyle; } diff --git a/src/types/index.ts b/src/types/index.ts index ad5ab4ad..a84d56fc 100644 --- a/src/types/index.ts +++ b/src/types/index.ts @@ -62,6 +62,7 @@ export interface Edge { labelStyle?: CSSProperties; labelShowBg?: boolean; labelBgStyle?: CSSProperties; + labelBgPadding?: [number, number]; style?: CSSProperties; animated?: boolean; arrowHeadType?: ArrowHeadType; @@ -96,6 +97,7 @@ export interface EdgeProps { labelStyle?: CSSProperties; labelShowBg?: boolean; labelBgStyle?: CSSProperties; + labelBgPadding?: [number, number]; style?: CSSProperties; arrowHeadType?: ArrowHeadType; markerEndId?: string; @@ -235,6 +237,7 @@ export interface EdgeCompProps { labelStyle?: CSSProperties; labelShowBg?: boolean; labelBgStyle?: CSSProperties; + labelBgPadding?: [number, number]; onClick?: (event: ReactMouseEvent, edge: Edge) => void; animated?: boolean; selected?: boolean; @@ -248,6 +251,7 @@ export interface EdgeTextProps { labelStyle?: CSSProperties; labelShowBg?: boolean; labelBgStyle?: CSSProperties; + labelBgPadding?: [number, number]; } export type NodePosUpdate = {