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.

Sign up for GitHub

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

Jump to bottom

feat: React Toolbar scaffolding #3446

Merged
merged 12 commits into from
Jul 5, 2023
Merged

feat: React Toolbar scaffolding #3446

merged 12 commits into from
Jul 5, 2023

Conversation

haakonflatval-cognite
Copy link
Contributor

@haakonflatval-cognite haakonflatval-cognite commented Jun 30, 2023 •
edited
Loading

Type of change

Feat

Jira ticket 📘

Partially https://cognitedata.atlassian.net/browse/UX-844

Description 📝

Creates a React toolbar component, based on Figma sketch: https://www.figma.com/file/RSZN6BS8VqQgWRFQ7pIXC9/FDX?type=design&node-id=7377-203072&mode=design&t=LSYkn4qH62PeOmuW-0

The toolbar is meant to be used inside a RevealContext.

Architecturally, the toolbar is just a container with a list of buttons and dividers which may be provided as children to the toolbar component. If no children are provided, a default set of buttons are used instead.

A set of default buttons are also exposed to the user, which they may choose to provide to the toolbar. This would include e.g. a slicing UI, a fit-camera-to-models-button and a measurements-button.

Each button is a wrapper around the (also exposed) ToolbarButton, which may be used by the user to create their own buttons. ToolbarButton is a thin wrapper around cogs.js button, essentially just ensuring it is of the ghost type.

Note: The button set we want to use in FDX will probably include some FDX-specific buttons, while the "default" buttons returned with the toolbar should be Reveal-specific only.

How has this been tested? 🔍

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 changed the title feat: initial work on React Toolbar feat: React Toolbar Jun 30, 2023
@haakonflatval-cognite haakonflatval-cognite changed the title feat: React Toolbar feat: React Toolbar scaffolding Jun 30, 2023
@haakonflatval-cognite haakonflatval-cognite marked this pull request as ready for review June 30, 2023 14:16
@haakonflatval-cognite haakonflatval-cognite requested a review from a team as a code owner June 30, 2023 14:16
@haakonflatval-cognite haakonflatval-cognite added the slack PRs and issues with this label will be pushed to Slack label Jun 30, 2023
christjt
christjt previously approved these changes Jul 5, 2023
View reviewed changes
@christjt christjt added the auto-update Makes bulldozer automatically update this PR when there are changes to the target branch label Jul 5, 2023
@christjt christjt enabled auto-merge (squash) July 5, 2023 12:56
Savokr
Savokr previously approved these changes Jul 5, 2023
View reviewed changes
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! Only one tiny comment.

react-components/src/components/RevealToolbar/FitModelsButton.tsx Show resolved Hide resolved
@christjt christjt dismissed stale reviews from Savokr and themself via 0741cb5 July 5, 2023 13:13
Savokr
Savokr approved these changes Jul 5, 2023
View reviewed changes
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

@christjt christjt merged commit cb946e0 into master Jul 5, 2023
13 checks passed
@christjt christjt deleted the hflatval/react-toolbar branch July 5, 2023 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Savokr Savokr Savokr approved these changes

@christjt christjt christjt left review comments

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@haakonflatval-cognite @christjt @Savokr