Refactor SidePanel #2903
Open
Refactor SidePanel #2903
Conversation
This file contains 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
Size Change: +3.66 kB (+0.54%) Total Size: 676 kB
ℹ️ View Unchanged
|
sirineJ
force-pushed
the
feat/DSYS-878/remove-react-modal
branch
from
bd6ce6a to
762ceb9
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## next #2903 +/- ##
==========================================
+ Coverage 87.98% 88.07% +0.09%
==========================================
Files 227 222 -5
Lines 13088 12911 -177
Branches 1795 1777 -18
==========================================
- Hits 11515 11372 -143
+ Misses 1519 1486 -33
+ Partials 54 53 -1
|
sirineJ
force-pushed
the
feat/DSYS-878/remove-react-modal
branch
from
762ceb9 to
2843340
Compare
sirineJ
force-pushed
the
feat/DSYS-878/remove-react-modal
branch
from
2843340 to
714716c
Compare
connor-baer
requested changes
Jan 22, 2025
| @@ -5,7 +5,7 @@ | |||
| display: flex; | |||
| align-items: center; | |||
| width: 100%; | |||
| background-color: var(--cui-bg-normal); | |||
| background-color: var(--cui-bg-elevated); | |||
| @@ -140,14 +151,14 @@ export const Dialog = forwardRef<HTMLDialogElement, DialogProps>( | |||
| if (open && dialogElement) { | |||
| timeoutId = setTimeout(() => { | |||
| if (initialFocusRef?.current) { | |||
| initialFocusRef?.current?.focus(); | |||
| initialFocusRef?.current?.focus({ preventScroll: true }); | |||
| event.preventDefault(); | ||
| } | ||
| }, | ||
| [preventClose], | ||
| [preventOutsideClickClose], | ||
| ); | ||
|
|
||
| useEffect(() => { |
There was a problem hiding this comment.
I would split this useEffect into multiple, granular effects to improve performance:
- Registering the dialog with the polyfill. This should only happen once, on mount.
- Setting the animation duration as a custom property. This should re-run whenever the animation duration value changes (i.e. it shouldn't use the
animationDurationRef) - Adding the
keydownevent listener... - ...and adding the
closeevent listener. I'd separate the event listener effects since they are added under different conditions
| lastFocusedElementRef.current = null; | ||
| handleDialogClose(); | ||
| }, [handleDialogClose]); | ||
| if (!preventOutsideClickClose) { |
There was a problem hiding this comment.
This check is redundant since useClickOutside is only enabled when preventOutsideClickClose is truthy on line 285.
Comment on lines
+287
to
+290
| useEscapeKey((e: KeyboardEvent) => { | ||
| e.preventDefault(); | ||
| handleDialogClose(); | ||
| }, open && !preventEscapeKeyClose); |
There was a problem hiding this comment.
This inline arrow function changes on every render, which means the event listener inside useEscapeKey will be removed and re-added on every render. Wrap it in useCallback to avoid that.
| @@ -166,42 +166,79 @@ describe('Dialog', () => { | |||
| render(<Dialog {...props} open />); | |||
| vi.runAllTimers(); | |||
| expect(screen.getByText('Dialog content')).toBeVisible(); | |||
| expect(screen.getByRole('button', { name: 'Close' })).toBeInTheDocument(); | |||
There was a problem hiding this comment.
.toBeVisible() is a bit stricter/safer since it also ensures that the button isn't visually hidden.
Suggested change
| expect(screen.getByRole('button', { name: 'Close' })).toBeInTheDocument(); | |
| expect(screen.getByRole('button', { name: 'Close' })).toBeVisible(); |
| /** | ||
| * Prevent users from closing the modal by clicking/tapping the overlay or | ||
| * pressing the escape key, and hides the close button. | ||
| * @default `false`. |
There was a problem hiding this comment.
Suggested change
| * @default `false`. | |
| * @default false |
| @@ -57,6 +66,7 @@ export const Modal = forwardRef<HTMLDialogElement, ModalProps>((props, ref) => { | |||
| hideCloseButton, | |||
| variant = 'contextual', | |||
| className, | |||
| preventClose, | |||
There was a problem hiding this comment.
Let's be explicit about the default value here in case the underlying default values in Dialog change.
Suggested change
| preventClose, | |
| preventClose = false, |
Comment on lines
+65
to
+67
| | 'preventOutsideClickClose' | ||
| | 'preventEscapeKeyClose' | ||
| | 'hideCloseButton' |
There was a problem hiding this comment.
Suggestion: We could export a PublicDialogProps type from the Dialog component to avoid having to omit all these private props in every component that builds on top of it (and potentially forgetting to omit one in the future).
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.
Addresses DSYS-878
Purpose
Refactor the SidePanel component to replace react-modal with the Dialog component. Remove the react-modal dependency.
Approach and changes
backButtonLabelreact-modalpackagepreventCloseprop into :preventOutsideClickClose,preventEscapeKeyCloseandhideCloseButton.Definition of done