feat: Add logic for new requireScroll prop for Snap Footer component
#29863
+1,556
−822
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
|
CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes. |
Builds ready [fb1ef7c]
Page Load Metrics (1814 ± 116 ms)
Bundle size diffs
|
Builds ready [22be388]
Page Load Metrics (1687 ± 87 ms)
Bundle size diffs
|
FrederikBolding
requested changes
Jan 30, 2025
ui/components/app/snaps/snap-ui-renderer/components/avatar-icon.ts
Outdated
Show resolved
Hide resolved
| }, [rawContent, scrollState, scrollArrow, requireScroll]); | ||
| }; | ||
|
|
||
| const LoadingSpinner = memo(function LoadingSpinner() { |
There was a problem hiding this comment.
and memoizing because it's static no need to re-create on every render
Builds ready [995774c]
Page Load Metrics (1716 ± 89 ms)
Bundle size diffs
|
Builds ready [f7bac01]
Page Load Metrics (1708 ± 47 ms)
Bundle size diffs
|
…r performance, updated useScrollRequired with callback option, added requireScroll tests
Builds ready [1697674]
Page Load Metrics (1613 ± 66 ms)
Bundle size diffs
|
Mrtenz
requested changes
Feb 27, 2025
| @@ -82,7 +83,7 @@ export const SnapUIFooterButton: FunctionComponent< | |||
| {...props} | |||
| size={ButtonSize.Lg} | |||
| block | |||
| disabled={disabled} | |||
| disabled={requireScroll ? !buttonsEnabled : disabled} | |||
There was a problem hiding this comment.
Shouldn't the disabled prop always take priority here?
Suggested change
| disabled={requireScroll ? !buttonsEnabled : disabled} | |
| disabled={disabled || (requireScroll && !buttonsEnabled)} |
| let hasReachedBottom; | ||
| switch (action.type) { | ||
| case 'MANUAL_SCROLL': | ||
| hasReachedBottom = state.hasReachedBottom || action.isAtBottom; |
There was a problem hiding this comment.
I don't think this needs to be a mutable variable.
| }, [interfaceState?.content]); | ||
|
|
||
| const requireScroll = useMemo( | ||
| () => Boolean(content?.props?.children?.[1]?.props?.requireScroll), |
There was a problem hiding this comment.
Is this guaranteed to be the correct component?
| ? rawContent | ||
| : Container({ children: rawContent }); | ||
| }, [interfaceState?.content]); | ||
|
|
||
| const requireScroll = useMemo( |
There was a problem hiding this comment.
I don't think this needs to be memoised.
| return; | ||
| } | ||
|
|
||
| const isActuallyAtBottom = |
There was a problem hiding this comment.
Is this different from useScrollRequired's hasScrolledToBottomState? Can we deduplicate?
Comment on lines
+165
to
+169
| // Prevent multiple clicks | ||
| if (isProgrammaticScrollRef.current) { | ||
| return; | ||
| } | ||
| isProgrammaticScrollRef.current = true; |
There was a problem hiding this comment.
Why is this a ref? Is this necessary in the first place?
| contentBackgroundColor ?? | ||
| mapToExtensionCompatibleColor(content?.props?.backgroundColor) ?? | ||
| BackgroundColor.backgroundAlternative; | ||
| const backgroundColor = useMemo( |
There was a problem hiding this comment.
Again doesn't feel like this needs to be memoised.
|
|
||
| // The renderer should only have a footer if there is a default cancel action | ||
| // or if the footer component has been used. | ||
| const hasFooter = useMemo( |
There was a problem hiding this comment.
Same here regarding memoisation.
| expect(getByText('Foo')).toBeDefined(); | ||
| expect(container).toMatchSnapshot(); | ||
| }); | ||
| describe('Basic Rendering', () => { |
There was a problem hiding this comment.
The change in nesting makes this diff very difficult to read. Maybe move it to a separate PR, and only add the required changes here?
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.
Description
Write a short description of the changes included in this pull request, also include relevant motivation and context. Have in mind the following questions:
requireScroll.requireScrollprop in their footers. The prop ensures that the footer buttons are disabled until the snap ui content has been viewed. This prop also means that a scroll arrow is displayed based on theisScrolledToBottomprop.Related issues
Fixes: MetaMask/snaps#3021
Manual testing steps
Screenshots/Recordings
After
Screen.Recording.2025-02-05.at.12.46.34.PM.mov
Pre-merge author checklist
Pre-merge reviewer checklist