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

Fix: Web rendering issues and welcome screen layout issue #2809

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Fix: Web rendering issues and welcome screen layout issue #2809

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5ddef96
Improvements
fpena Oct 17, 2024
3718655
Better comment for hook selection in useHeader
fpena Oct 17, 2024
ed2a520
Make subheading in welcome screen not clash with face
fpena Oct 17, 2024
2f1ecff
Add ScreenWithoutScrolling to ScrollView
fpena Oct 17, 2024
33c93f2
Prettier change
fpena Oct 17, 2024
d2d4d3e
Merge branch 'master' into fp/2807-fix-web-issue
fpena Oct 17, 2024
711f0a5
Add comment for Screen component change
fpena Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 21 additions & 12 deletions boilerplate/app/components/Screen.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,19 +265,28 @@ export function Screen(props: ScreenProps) {
style={statusBarStyle || (themeContext === "dark" ? "light" : "dark")}
{...StatusBarProps}
/>

<KeyboardAvoidingView
behavior={isIos ? "padding" : "height"}
keyboardVerticalOffset={keyboardOffset}
{...KeyboardAvoidingViewProps}
style={[$styles.flex1, KeyboardAvoidingViewProps?.style]}
>
{isNonScrolling(props.preset) ? (
{/**
* KeyboardAvoidingView crashes in web,
* therefore we want to use ScrollView just for web
*/}
{Platform.OS === "web" ? (
<ScrollView>
<ScreenWithoutScrolling {...props} />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also meant to ask: why does web only get ScreeenWithoutScrolling? Shouldn't it have both options?

I think that's why this appeared to fix things, it removes KeyboardAwareScrollView from the document.

) : (
<ScreenWithScrolling {...props} />
)}
</KeyboardAvoidingView>
</ScrollView>
Comment on lines +273 to +275
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that this is a root-cause fix. I'd like to make sure we look into what's going on and why so we know that this is where we want to fix it.

Note that in the original stack trace, the root of the error actually occurs in KeyboardAwareScrollView.
Screenshot 2024-10-18 at 3 23 49 PM

Replacing KeyboardAwareScrollView also stops the issue from occurring:

function ScreenWithScrolling(props: ScreenProps) {
  ...
  useScrollToTop(ref)
  const MyComponent = Platform.OS === "web" ? ScrollView : KeyboardAwareScrollView

  return (
    <MyComponent
      bottomOffset={keyboardBottomOffset}
      {...{ keyboardShouldPersistTaps, scrollEnabled, ref }}

Also note that on the original issue @frankcalise linked this ticket where someone noted that adding import "setimmediate" also appears to fix the issue. I tried this out and it appears to work, as well (setimmediate is apparently brought in by fbjs which is a dependency of react-native-web.

I'm not opposed to an immediate fix to unblock things, but I think we definitely need to dig deeper into this to find and fix root cause.

I looked at the error in the dev console and it gives a clearer stack trace of the issue: that internal.js file is part of react-native-keyboard-controller. its use of setImmediate makes this not compatible with web.
Screenshot 2024-10-18 at 3 39 45 PM

I think the more appropriate fix is to swap out KeyboardAwareScrollView for a regular scrollview, since it wasn't designed for web.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition, I think we should probably use a const to define a new component wrapping KeyboardAwareScrollView ? ScrollView like we did with the useEffect below, and export it from a file like it's a component. that way other components that may want to use this can get a version compatible with web, instead of everyone having to write a platform ternary.

) : (
<KeyboardAvoidingView
Copy link
Contributor

@lindboe lindboe Oct 18, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have KeyboardAvoidingView if we also have KeyboardAwareScrollView nested within it? If we need it for the non-scrolling version, I would think:

  1. We wouldn't want to wrap KeyboardAvoidingView around both cases, only non-scrolling
  2. We wouldn't want to mix RN's KeyboardAvoidingView with RNKC's KeyboardAwareScrollView. It looks like RNKC has its own KeyboardAvoidingView.

behavior={isIos ? "padding" : "height"}
keyboardVerticalOffset={keyboardOffset}
{...KeyboardAvoidingViewProps}
style={[$styles.flex1, KeyboardAvoidingViewProps?.style]}
>
{isNonScrolling(props.preset) ? (
<ScreenWithoutScrolling {...props} />
) : (
<ScreenWithScrolling {...props} />
)}
</KeyboardAvoidingView>
)}
</View>
)
}
Expand Down
11 changes: 8 additions & 3 deletions boilerplate/app/screens/WelcomeScreen.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {
import { isRTL } from "../i18n"
import { useStores } from "../models" // @demo remove-current-line
import { AppStackScreenProps } from "../navigators"
import type { ThemedStyle } from "@/theme"
import { spacing, type ThemedStyle } from "@/theme"
import { useHeader } from "../utils/useHeader" // @demo remove-current-line
import { useSafeAreaInsetsStyle } from "../utils/useSafeAreaInsetsStyle"
import { useAppTheme } from "@/utils/useAppTheme"
Expand Down Expand Up @@ -57,7 +57,7 @@ export const WelcomeScreen: FC<WelcomeScreenProps> = observer(
tx="welcomeScreen:readyForLaunch"
preset="heading"
/>
<Text tx="welcomeScreen:exciting" preset="subheading" />
<Text tx="welcomeScreen:exciting" preset="subheading" style={$subheading} />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes don't seem to render right for me on web:
Screenshot 2024-10-18 at 3 51 56 PM

<Image
style={$welcomeFace}
source={welcomeFace}
Expand Down Expand Up @@ -87,8 +87,9 @@ const $topContainer: ThemedStyle<ViewStyle> = ({ spacing }) => ({
flexShrink: 1,
flexGrow: 1,
flexBasis: "57%",
justifyContent: "center",
justifyContent: "space-around",
paddingHorizontal: spacing.lg,
paddingBottom: spacing.sm,
})

const $bottomContainer: ThemedStyle<ViewStyle> = ({ colors, spacing }) => ({
Expand All @@ -108,6 +109,10 @@ const $welcomeLogo: ThemedStyle<ImageStyle> = ({ spacing }) => ({
marginBottom: spacing.xxl,
})

const $subheading: TextStyle = {
paddingRight: spacing.xxxl,
}

const $welcomeFace: ImageStyle = {
height: 169,
width: 269,
Expand Down
14 changes: 10 additions & 4 deletions boilerplate/app/utils/useHeader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { useLayoutEffect } from "react"
import { useEffect, useLayoutEffect } from "react"
import { useNavigation } from "@react-navigation/native"
import { Header, HeaderProps } from "../components"
import { Platform } from "react-native"

/**
* A hook that can be used to easily set the Header of a react-navigation screen from within the screen's component.
Expand All @@ -13,10 +14,15 @@ export function useHeader(
deps: Parameters<typeof useLayoutEffect>[1] = [],
) {
const navigation = useNavigation()
/**
* We need to have multiple implementations of this hook for web and mobile.
* Web needs to use useEffect to avoid a rendering loop.
* In mobile and also to avoid a visible header jump when navigating between screens, we use
* `useLayoutEffect`, which will apply the settings before the screen renders.
*/
const useAppropriateEffect = Platform.OS === "web" ? useEffect : useLayoutEffect
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit, just to make it clear what the criteria for the effect is:

Suggested change
const useAppropriateEffect = Platform.OS === "web" ? useEffect : useLayoutEffect
const usePlatformEffect = Platform.OS === "web" ? useEffect : useLayoutEffect


// To avoid a visible header jump when navigating between screens, we use
// `useLayoutEffect`, which will apply the settings before the screen renders.
useLayoutEffect(() => {
useAppropriateEffect(() => {
navigation.setOptions({
headerShown: true,
header: () => <Header {...headerProps} />,
Expand Down