[TS migration] Migrate Hoverable #30339
Merged
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
MaciejSWM
changed the title
blazejkustra
suggested changes
Nov 7, 2023
src/components/Hoverable/index.tsx
Outdated
Comment on lines
16
to
26
| function mapChildren(children: ((isHovered: boolean) => ReactElement) | ReactElement | ReactElement[], callbackParam: boolean): ReactElement & RefAttributes<HTMLElement> { | ||
| if (Array.isArray(children) && children.length === 1) { | ||
| return children[0]; | ||
| } | ||
|
|
||
| if (typeof children === 'function') { | ||
| return children(callbackParam); | ||
| } | ||
|
|
||
| return children as ReactElement; | ||
| } |
There was a problem hiding this comment.
Either change it to:
function mapChildren(children: ((isHovered: boolean) => ReactElement) | ReactElement | ReactElement[], callbackParam: boolean): ReactElement & RefAttributes<HTMLElement> {
if (Array.isArray(children)) {
return children[0];
}
if (typeof children === 'function') {
return children(callbackParam);
}
return children;
}or
function mapChildren(children: ((isHovered: boolean) => ReactElement) | ReactElement | ReactElement[], callbackParam: boolean): (ReactElement | ReactElement[]) & RefAttributes<HTMLElement> {
if (Array.isArray(children) && children.length === 1) {
return children[0];
}
if (typeof children === 'function') {
return children(callbackParam);
}
return children;
}
src/components/Hoverable/index.tsx
Outdated
| * because nesting Pressables causes issues where the hovered state of the child cannot be easily propagated to the | ||
| * parent. https://github.com/necolas/react-native-web/issues/1875 | ||
| */ | ||
| const Hoverable = React.forwardRef<HTMLElement, HoverableProps>( |
There was a problem hiding this comment.
Improve it stylistically:
function Hoverable(
{disabled = false, onHoverIn = () => {}, onHoverOut = () => {}, onMouseEnter = () => {}, onMouseLeave = () => {}, children, shouldHandleScroll = false}: HoverableProps,
outerRef: ForwardedRef<HTMLElement>,
)and move forwardRef to the export line:
export default forwardRef(Hoverable);This is more accurate with TS guidelines
src/components/Hoverable/index.tsx
Outdated
Comment on lines
33
to
44
| function assignRef(ref: MutableRefObject<HTMLElement> | ((element: HTMLElement) => void), element: HTMLElement) { | ||
| if (!ref) { | ||
| return; | ||
| } | ||
|
|
||
| if (typeof ref === 'function') { | ||
| ref(element); | ||
| } else if (_.has(ref, 'current')) { | ||
| // eslint-disable-next-line no-param-reassign | ||
| ref.current = element; | ||
| } | ||
| } |
There was a problem hiding this comment.
Remove lodash and improve param types:
Suggested change
| function assignRef(ref: MutableRefObject<HTMLElement> | ((element: HTMLElement) => void), element: HTMLElement) { | |
| if (!ref) { | |
| return; | |
| } | |
| if (typeof ref === 'function') { | |
| ref(element); | |
| } else if (_.has(ref, 'current')) { | |
| // eslint-disable-next-line no-param-reassign | |
| ref.current = element; | |
| } | |
| } | |
| function assignRef(ref: ((instance: HTMLElement | null) => void) | MutableRefObject<HTMLElement | null>, element: HTMLElement) { | |
| if (!ref) { | |
| return; | |
| } | |
| if (typeof ref === 'function') { | |
| ref(element); | |
| } else if (ref?.current) { | |
| // eslint-disable-next-line no-param-reassign | |
| ref.current = element; | |
| } | |
| } |
src/components/Hoverable/index.tsx
Outdated
| const hijackRef = (el: HTMLElement) => { | ||
| ref.current = el; | ||
| if (child.ref) { | ||
| assignRef(child.ref as MutableRefObject<HTMLElement>, el); |
There was a problem hiding this comment.
Suggested change
| assignRef(child.ref as MutableRefObject<HTMLElement>, el); | |
| assignRef(child.ref, el); |
|
Thanks @blazejkustra! Suggestions implemented. Looks better now. |
blazejkustra
approved these changes
Nov 7, 2023
melvin-bot
bot
requested review from
allroundexperts
and removed request for
a team
|
@allroundexperts Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button] |
Reviewer Checklist
Screenshots/VideosAndroid: NativeScreen.Recording.2023-11-13.at.2.14.28.PM.movAndroid: mWeb ChromeScreen.Recording.2023-11-13.at.2.13.43.PM.moviOS: NativeUploading Screen Recording 2023-11-13 at 2.12.43 PM.mov… iOS: mWeb SafariScreen.Recording.2023-11-13.at.2.12.07.PM.movMacOS: Chrome / SafariScreen.Recording.2023-11-13.at.2.04.18.PM.movMacOS: DesktopScreen.Recording.2023-11-13.at.2.10.07.PM.mov |
|
We did not find an internal engineer to review this PR, trying to assign a random engineer to #25042 as well as to this PR... Please reach out for help on Slack if no one gets assigned! |
AndrewGable
approved these changes
Nov 13, 2023
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
👋 Hey everyone A little bit more context in https://expensify.slack.com/archives/C049HHMV9SM/p1699908253180059 |
situchan
reviewed
Nov 14, 2023
| if (_.has(ref, 'current')) { | ||
| if (typeof ref === 'function') { | ||
| ref(element); | ||
| } else if (ref?.current) { |
There was a problem hiding this comment.
This was overlooked. if (_.has(ref, 'current')) { is equivalent to:
Suggested change
| } else if (ref?.current) { | |
| } else if ('current' in ref) { |
Fixing here: #31306
|
🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.3.99-0 🚀
|
37 tasks
|
🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.99-0 🚀
|
|
🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.4.0-0 🚀
|
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.
Details
The Hoverable component is used in multiple places:
Fixed Issues
$ #25042
PROPOSAL:
Tests
Offline tests
TestsQA Steps
TestsPR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Screen.Recording.2023-11-07.at.13.09.05.mov
Android: mWeb Chrome
Screen.Recording.2023-11-07.at.12.43.12.mov
iOS: Native
Screen.Recording.2023-11-07.at.13.09.05.mov
iOS: mWeb Safari
Screen.Recording.2023-11-07.at.12.43.12.mov
MacOS: Chrome / Safari
Screen.Recording.2023-11-07.at.12.34.55.mov
MacOS: Desktop
Screen.Recording.2023-11-07.at.12.40.37.mov