feat: Arrow for Diagram Component #6863

g4rry420 · 2023-07-05T01:56:32Z

What does this PR do?

Added arrow prop for the connection of Diagram component
API of arrow: from | to | true
This is the initial design which is coming from my earlier pr - [WIP]: Added Arrow for Diagram Component #5950

Where should the reviewer start?

Diagram.js

What testing has been done on this PR?

Currently, only manually tested using Arrow.js and Animated.js files

How should this be manually tested?

Arrow.js and Animated.js files

Do Jest tests follow these best practices?

screen is used for querying.
The correct query is used. (Refer to this list of queries)
userEvent is used in place of fireEvent.
asFragment() is used for snapshot testing.

Any background context you want to provide?

N/A

What are the relevant issues?

#5882

Screenshots (if appropriate)

Do the grommet docs need to be updated?

Yes, after this pr is merged

Should this PR be mentioned in the release notes?

Yes, please

Is this change backwards compatible or is it a breaking change?

backwards compatible

Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

halocline · 2023-07-06T20:12:32Z

Hi @g4rry420 - Thank you so much for this. This will be very useful. From an API standpoint, I am thinking about the following structure for the connections object type. I think it will allow us the flexibility to extend in the future while aligning with the diagram design tools such as Figma, Adobe, Lucidchart, etc.

{
  type: 'direct' | 'curved' | 'rectilinear',
  endpoint: 'arrow' | { from: 'arrow', to: 'arrow' },  // if string, defaults to both from and to, else use what is specified in object
  ...
}

which in the future could be extended to allow for other endpoint types such as "square", "round", etc.

{
  type: 'direct' | 'curved' | 'rectilinear',
  endpoint: 'arrow' | 'square' | 'round' | { 
    from: 'arrow' | 'square' | 'round', 
    to: 'arrow' | 'square' | 'round' 
  },
  ...
}

…to other endpoint types such as square, round, etc as per Matthew's suggestions Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

…ypes for endpoint object Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

g4rry420 · 2023-07-08T05:19:06Z

Sounds good, I have made changes and also added a snapshot test, please let me if there are any further changes required :)

taysea · 2023-07-17T20:15:26Z

src/js/components/Diagram/Diagram.js

+                markerStart={`url("#openArrowStart-${index}")`}
+                markerEnd={`url("#openArrowEnd-${index}")`}
+              />
+              {endpoint && arrowMarker && <defs>{arrowMarker}</defs>}


Why do we wrap in defs?

The main use case for defs was to holds a set of reusable definitions for the SVG markers. But, it isn't serving it's purpose right now, I will push some change in which we will using arrow based on it's open, close and color.

taysea · 2023-07-17T20:16:57Z

src/js/components/Diagram/Diagram.js

@@ -222,20 +273,49 @@ const Diagram = forwardRef(({ connections, ...rest }, ref) => {
            colorName = colors[index % colors.length];
          }

+          let arrowMarker = null;


This is a smaller comment but to be more flexible for future, should we name this variable endpoint? If needed we can alias the prop as endpointProp.

Since, endpoint is already a prop we are adding in Diagram component, naming the arrowMarker variable to endpointProp will create a confusion as it's expected type to be 'arrow' | { from?: 'arrow'; to?: 'arrow' }. How about if we name this variable as endpointMarker ?
The reason, I have choosed this name - endpointMarker variable is because we are storing the marker tag with the openArrow in it and in future I believe for other endpoints we will be using marker for it. Please, let me know your thoughts

taysea · 2023-07-17T20:17:46Z

src/js/components/Diagram/Diagram.js

+            arrowMarker = openArrow(
+              normalizeColor(colorName, theme),
+              index,
+              'openArrowStart',


also to be more flexible for future, should we name this endpointStart since it might not always be an arrow?

taysea · 2023-07-17T20:21:01Z

Screen.Recording.2023-07-17.at.1.18.59.PM.mov

@jcfilben @halocline I'm curious your thoughts from a design perspective. Do you think the arrow endpoints should already appear when the line isn't drawn? Or appear only once the line has met the end? Or something else?

taysea · 2023-07-17T20:21:39Z

src/js/components/Diagram/Diagram.js

@@ -145,16 +159,52 @@ const Diagram = forwardRef(({ connections, ...rest }, ref) => {
            toPoint[0] += toRect.width / 2;
            if (fromRect.top < toRect.top) {
              fromPoint[1] += fromRect.height;
+
+              if (typeof endpoint === 'object' && endpoint?.from) {
+                fromPoint[1] += 10;


How was 10 determined? It might be helpful to add a code comment for future.

I haven't used a definitive approach to calculate the 10. I just check the Animated story and 10 seems good which isn't closely aligned with the start and end of the main diamond diagram

taysea · 2023-07-17T20:24:22Z

src/js/components/Diagram/Diagram.js

+                strokeLinejoin={round ? 'round' : 'miter'}
+                fill="none"
+                d={d}
+                markerStart={`url("#openArrowStart-${index}")`}


Is there any downside to having the markerStart/markerEnd here if the path doesn't have an arrow?

Also, if multiple diagrams are rendered on a page, will this index id approach work still?

Yes, there is, I will fix that.
Yes, currently, if multiple diagrams are rendered on page, the index approach will not work. I am working on new approach.

jcfilben · 2023-07-17T20:43:19Z

Screen.Recording.2023-07-17.at.1.18.59.PM.mov
@jcfilben @halocline I'm curious your thoughts from a design perspective. Do you think the arrow endpoints should already appear when the line isn't drawn? Or appear only once the line has met the end? Or something else?

I think my expectation would be that if the arrows are at the endpoints they should only appear once the line has been drawn to the end.

…row marker by utilizing the defs tag Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

jcfilben · 2023-08-17T20:17:12Z

src/js/components/Diagram/Diagram.js

@@ -251,6 +415,14 @@ const Diagram = forwardRef(({ connections, ...rest }, ref) => {
      connections={paths}
      {...rest}
    >
+      {markerElements.length > 0 && (
+        <defs>


Do we need defs here?

jcfilben · 2023-08-17T20:17:45Z

src/js/components/Diagram/__tests__/__snapshots__/Diagram-test.tsx.snap

+        preserveAspectRatio="xMinYMin meet"
+        viewBox="0 0 0 0"
+      >
+        <defs>


Do we need defs here?

taysea · 2023-08-17T20:18:08Z

Screen.Recording.2023-07-17.at.1.18.59.PM.mov
@jcfilben @halocline I'm curious your thoughts from a design perspective. Do you think the arrow endpoints should already appear when the line isn't drawn? Or appear only once the line has met the end? Or something else?

I think my expectation would be that if the arrows are at the endpoints they should only appear once the line has been drawn to the end.

@g4rry420 I'm still noticing the arrow appearing before the animation is finished. Can you update so the end point arrows only appear once the animation is done?

taysea · 2023-08-17T20:30:08Z

src/js/components/Diagram/Diagram.js

+              markerElements.push(
+                openArrow(
+                  normalizeColor(colorName, theme),
+                  `__grommet__openArrowStart__${normalizeColor(


Is there any value to building this id up based on the id the caller has passed for the from/to of their diagram?

Still wondering if this will cause issues if multiple diagrams are presented on the same screen where we might have clashing id with this current approach.

Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

… if multiple connections of arrows are present in different color for a Diagram Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

g4rry420 · 2023-11-29T01:58:55Z

I'm still noticing the arrow appearing before the animation is finished. Can you update so the end point arrows only appear once the animation is done?

@taysea I am unable to figure out the animation part over here. Can you please help me ?
I have tried using animateMotion tag with mpath but it doesn't seems to work. Please, let me know if I am missing something

taysea · 2024-02-15T20:45:06Z

I'm still noticing the arrow appearing before the animation is finished. Can you update so the end point arrows only appear once the animation is done?

@taysea I am unable to figure out the animation part over here. Can you please help me ? I have tried using animateMotion tag with mpath but it doesn't seems to work. Please, let me know if I am missing something

I haven't tried this locally, but is there a way to conditionally render the arrows based on the animation duration/etc. So, don't have it rendered (or have it visibly hidden) until the animation completes?

feat: Arrow for Diagram Component

9f64ad0

Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

jcfilben added the PRty Biweekly PR reviews by grommet team with hoping of closing such PRs label Jul 6, 2023

g4rry420 added 4 commits July 8, 2023 00:25

chore: Changed the API for arrow to endpoint prop with extensibility …

fd2b6c5

…to other endpoint types such as square, round, etc as per Matthew's suggestions Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

Added a snapshot test for endpoint - arrow prop and resolves the ts t…

3c624d7

…ypes for endpoint object Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

lint: Added comma in propTypes

6e30aca

Merge branch 'master' into issue_5882

f871fda

taysea reviewed Jul 17, 2023

View reviewed changes

jcfilben removed the PRty Biweekly PR reviews by grommet team with hoping of closing such PRs label Jul 20, 2023

g4rry420 added 3 commits July 20, 2023 21:08

Merge branch 'master' into issue_5882

85f1c68

changed the id name for the marker, fixed the duplicate issue with ar…

4337791

…row marker by utilizing the defs tag Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

fix: arrow appearing in another line if they have same color

2bd7bee

Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

g4rry420 requested a review from taysea July 22, 2023 02:09

fix: linting issue

0bd64e0

Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

jcfilben added the PRty Biweekly PR reviews by grommet team with hoping of closing such PRs label Aug 3, 2023

jcfilben reviewed Aug 17, 2023

View reviewed changes

taysea reviewed Aug 17, 2023

View reviewed changes

Merge branch 'master' into issue_5882

8974d44

jcfilben added waiting Awaiting response to latest comments and removed PRty Biweekly PR reviews by grommet team with hoping of closing such PRs labels Aug 23, 2023

chore: added fromTarget and toTarget in id name of the marker

5d4129d

Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

g4rry420 and others added 5 commits October 24, 2023 21:45

chore: changed the id of start and end open arrow

dfbf756

Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

chore: updated snapshot"

f86aa56

Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

Merge branch 'master' into issue_5882

54ffa1d

chore: Added colorName in the id of the arrow as it was causing error…

50fc9da

… if multiple connections of arrows are present in different color for a Diagram Signed-off-by: GurkiranSingh <gurkiransinghk@gmail.com>

Merge branch 'master' into issue_5882

717a177

jcfilben added PRty Biweekly PR reviews by grommet team with hoping of closing such PRs and removed waiting Awaiting response to latest comments labels Feb 1, 2024

taysea added the waiting Awaiting response to latest comments label Feb 15, 2024

jcfilben removed the PRty Biweekly PR reviews by grommet team with hoping of closing such PRs label Feb 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Arrow for Diagram Component #6863

feat: Arrow for Diagram Component #6863

g4rry420 commented Jul 5, 2023

halocline commented Jul 6, 2023 •

edited

g4rry420 commented Jul 8, 2023

taysea Jul 17, 2023

g4rry420 Jul 21, 2023

taysea Jul 17, 2023

g4rry420 Jul 21, 2023

taysea Jul 17, 2023

taysea commented Jul 17, 2023

taysea Jul 17, 2023

g4rry420 Jul 21, 2023 •

edited

taysea Jul 17, 2023

taysea Jul 17, 2023

g4rry420 Jul 21, 2023 •

edited

jcfilben commented Jul 17, 2023 •

edited

jcfilben Aug 17, 2023

jcfilben Aug 17, 2023

taysea commented Aug 17, 2023

taysea Aug 17, 2023

g4rry420 commented Nov 29, 2023

taysea commented Feb 15, 2024

feat: Arrow for Diagram Component #6863

Are you sure you want to change the base?

feat: Arrow for Diagram Component #6863

Conversation

g4rry420 commented Jul 5, 2023

What does this PR do?

Where should the reviewer start?

What testing has been done on this PR?

How should this be manually tested?

Do Jest tests follow these best practices?

Any background context you want to provide?

What are the relevant issues?

Screenshots (if appropriate)

Do the grommet docs need to be updated?

Should this PR be mentioned in the release notes?

Is this change backwards compatible or is it a breaking change?

halocline commented Jul 6, 2023 • edited

g4rry420 commented Jul 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

taysea commented Jul 17, 2023

Choose a reason for hiding this comment

g4rry420 Jul 21, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

g4rry420 Jul 21, 2023 • edited

Choose a reason for hiding this comment

jcfilben commented Jul 17, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

taysea commented Aug 17, 2023

Choose a reason for hiding this comment

g4rry420 commented Nov 29, 2023

taysea commented Feb 15, 2024

halocline commented Jul 6, 2023 •

edited

g4rry420 Jul 21, 2023 •

edited

g4rry420 Jul 21, 2023 •

edited

jcfilben commented Jul 17, 2023 •

edited