Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(react-components): clicked node hook #3557

Merged
merged 27 commits into from
Aug 16, 2023

Conversation

haakonflatval-cognite
Copy link
Contributor

@haakonflatval-cognite haakonflatval-cognite commented Aug 7, 2023

Type of change

Feat

Jira ticket 📘

https://cognitedata.atlassian.net/browse/UX-1147

Description 📝

Adds a useClickedNode hook which uses react-query under the hood to listen to and fetch data related to Cad Node clicking.

Known issues:

  • On clicking the second node after one is already clicked, the hook will spurt out three updates:
    • The first result once again
    • undefined
    • The result belonging to the second node

This may just be alright, but feels unnecessary

How has this been tested? 🔍

In the story.

Test instructions ℹ️

Checklist ☑️

  • I am proud of this feature.
  • I have performed a self-review of my own code.
  • I have added PR type (Feat, Bug, Chore, Test, Docs, Style, Refactor) to the PR title.
  • I have manually tested this for different scenarios (different models, formats, devices, browsers).
  • I have commented my code in hard-to-understand areas.
  • I have made corresponding changes to the public documentation.
  • I have added unit and visuals tests to prove that my feature works to the best of my ability.
  • I have refactored the code for readability to the best of my ability.
  • I have checked that my changes do not introduce regressions in the public documentation.
  • I have outlined any known defects / lacking capabilities in the contents of this PR.
  • I have listed any remaining work that should follow this PR in the description or jira/miro/etc.
  • I have added TSDoc to any public facing changes.
  • I have added "developer documentation" in any package README.md that is related / applicable to this PR.
  • I have noted down and am currently tracking any technical debt introduced in this PR.
  • I have thoroughly thought about the architecture of this implementation.
  • I have asked peers to test this feature.

@haakonflatval-cognite haakonflatval-cognite requested a review from a team as a code owner August 7, 2023 14:28
@haakonflatval-cognite haakonflatval-cognite marked this pull request as draft August 7, 2023 14:28
@haakonflatval-cognite haakonflatval-cognite changed the title Hflatval/clicked node hook WIP feat(react-components): clicked node hook Aug 7, 2023
@haakonflatval-cognite haakonflatval-cognite added the slack PRs and issues with this label will be pushed to Slack label Aug 8, 2023
@haakonflatval-cognite haakonflatval-cognite marked this pull request as ready for review August 8, 2023 11:27
@haakonflatval-cognite haakonflatval-cognite changed the title WIP feat(react-components): clicked node hook feat(react-components): clicked node hook Aug 8, 2023
Copy link
Contributor

@Savokr Savokr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really good but a few things to consider.

react-components/src/hooks/useClickedNode.tsx Outdated Show resolved Hide resolved
react-components/src/hooks/useClickedNode.tsx Show resolved Hide resolved
react-components/stories/HighlightNode.stories.tsx Outdated Show resolved Hide resolved
react-components/src/hooks/useNodeMappedData.tsx Outdated Show resolved Hide resolved
react-components/stories/ClickedNode.stories.tsx Outdated Show resolved Hide resolved
Savokr
Savokr previously approved these changes Aug 14, 2023
Copy link
Contributor

@Savokr Savokr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Copy link
Contributor

@Savokr Savokr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@haakonflatval-cognite haakonflatval-cognite added the auto-update Makes bulldozer automatically update this PR when there are changes to the target branch label Aug 16, 2023
@haakonflatval-cognite haakonflatval-cognite merged commit 71177b6 into master Aug 16, 2023
13 checks passed
@haakonflatval-cognite haakonflatval-cognite deleted the hflatval/clicked-node-hook branch August 16, 2023 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-update Makes bulldozer automatically update this PR when there are changes to the target branch slack PRs and issues with this label will be pushed to Slack
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants