feat: WorkspaceSection action #1623
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR is a squash of refactors and improvements in our Workspace and WorkspaceSection components. An action prop is added to WorkspaceSection and along the way, I refactored things that were not meeting conventions or were hard to read. With this addition, I am further unblocked in making auto-start/off editable in the UI, as I intend to use the Action prop to trigger a modal (or routed page view) with the form. Squashed commits: * refactor: spaces for readability It's hard to read HTMl markup without spaces on adjacent nodes * refactor: props Our components had unused props and arbitrary ordering.
Closed
greyscaled
commented
May 20, 2022
Comment on lines
-12
to
+16
| organization?: TypesGen.Organization | ||
| workspace: TypesGen.Workspace | ||
| template?: TypesGen.Template | ||
| handleStart: () => void | ||
| handleStop: () => void | ||
| handleRetry: () => void | ||
| handleUpdate: () => void | ||
| workspace: TypesGen.Workspace |
There was a problem hiding this comment.
Review:
oraganizationandtemplatewere unused (note this is one caveat when a prop is optional, we don't really know if we're even using it. I wonder if there's a lint rule that can help with that, but suffice it to say I just checked which of these the component was de-structuring. Also this is why de-structuringpropsis superior to theproparg...it's helpful to see where everything is being used with a simple find/replace).- Furthermore, the grouping was odd. I'll add a note about organizing props in our FE V, but essentially, I think what I see in most codebases is alphabetical but mandatory props are grouped in front of optional props. We can also use a different convention, what matters to me is "at a glance" behaviors. Mix-n-match requires more brain power to read.
| <WorkspaceSection title="Resources"> | ||
| <Placeholder /> | ||
| </WorkspaceSection> | ||
| </div> | ||
|
|
There was a problem hiding this comment.
Review: Will add this to FE V and search for lint rule. zero spaces in HTML markup makes me dizzy!
| </IconButton> | ||
| ), | ||
| title: "Action Section", | ||
| } |
There was a problem hiding this comment.
Review: We forgot to add this story additionally, but now it's here and with two examples. I couldn't think of an example for contentProps because it's mostly used to inject styles or classes.
jsjoeio
approved these changes
May 20, 2022
|
I guess this doesn't matter as much anymore because of #1450 |
kylecarbs
pushed a commit
that referenced
this pull request
Jun 10, 2022
This PR is a squash of refactors and improvements in our Workspace and WorkspaceSection components. An action prop is added to WorkspaceSection and along the way, I refactored things that were not meeting conventions or were hard to read. With this addition, I am further unblocked in making auto-start/off editable in the UI, as I intend to use the Action prop to trigger a modal (or routed page view) with the form. Squashed commits: * refactor: spaces for readability It's hard to read HTMl markup without spaces on adjacent nodes * refactor: props Our components had unused props and arbitrary ordering.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This prepares the WorkspacesSection component (via props & Storybook) for the
changes needed in #1455.
Details
This PR is a squash of refactors and improvements in our Workspace and
WorkspaceSection components. An action prop is added to WorkspaceSection
and along the way, I refactored things that were not meeting conventions
or were hard to read. With this addition, I am further unblocked in
making auto-start/off editable in the UI, as I intend to use the Action
prop to trigger a modal (or routed page view) with the form.
Squashed commits:
refactor: spaces for readability
It's hard to read HTMl markup without spaces on adjacent nodes
refactor: props
Our components had unused props and arbitrary ordering.
Impact of Change