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: add a higher order component for storing camera state to URL #3682

Merged
merged 10 commits into from
Sep 7, 2023

Conversation

christjt
Copy link
Contributor

@christjt christjt commented Sep 6, 2023

Type of change

Feat

Jira ticket 📘

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

Description 📝

Adds a HOC which can be mounted to any component. As long as the component is mounted, camera state will be stored in the URL when the camera stop event triggers.

How has this been tested? 🔍

POC is implemented in FDM.

Test instructions ℹ️

In the toolbar story, append:

&cameraPosition=%5B13.54764613001787%2C18.554701782663916%2C9.87398745289454%5D&cameraTarget=%5B12.65278161163936%2C4.1501122422409775%2C-4.756918093283632%5D

to the URL. Notice that the starting camera position is now defined by this state.

To test the setting of the URL open the canvas of the story in a new window (see image). This is needed because the content of the story is in an iFrame, so updates in the URL are happening in the iFrame.

image

Once opened, move the camera and confirm that the state changes.

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.

@christjt christjt added 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 labels Sep 6, 2023
@christjt christjt requested a review from a team as a code owner September 6, 2023 20:30
Copy link
Contributor

@pramodcog pramodcog left a comment

Choose a reason for hiding this comment

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

Works well! minor comment

@christjt christjt merged commit 143f24f into master Sep 7, 2023
14 checks passed
@christjt christjt deleted the christjt/camera-state-url branch September 7, 2023 13:42
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