react-native-bottom-sheet: [v4] enableDynamicSizing prop does not work when BottomSheetView contains a single View wrapping children

Bug

The enableDynamicSize prop does not work when BottomSheetView contains a single View component with multiple children. I am seeing inconsistent behavior where most of the time, the bottom sheet has no height and no content. Very rarely it renders correctly (maybe 1 in 50 attempts?).

I was able to reproduce this using the example app on both Android & iOS (see repro steps below).

https://github.com/gorhom/react-native-bottom-sheet/assets/2507829/739ccb21-4bd4-4af7-9044-f27b46fe2b59

Environment info

Reproduced on latest master (65b5dc0).

Library Version
@gorhom/bottom-sheet 4.5.1
react-native 0.62.2
react-native-reanimated 2.8.0
react-native-gesture-handler 1.10.3

Steps To Reproduce

  1. Run example app
  2. Scroll down and click Dynamic Sizing

Describe what you expected to happen:

  1. Bottom sheet should render with content

Reproducible sample code

Modify the render of example/app/src/screens/advanced/DynamicSnapPointExample.tsx to add a View that wraps all children of BottomSheetView

Here is a patch file to apply with the changes: repro.patch

diff --git a/example/app/src/screens/advanced/DynamicSnapPointExample.tsx b/example/app/src/screens/advanced/DynamicSnapPointExample.tsx
index 8c3e63e..a91855e 100644
--- a/example/app/src/screens/advanced/DynamicSnapPointExample.tsx
+++ b/example/app/src/screens/advanced/DynamicSnapPointExample.tsx
@@ -54,6 +54,7 @@ const DynamicSnapPointExample = () => {
         animateOnMount={true}
       >
         <BottomSheetView style={contentContainerStyle}>
+          <View>
           <Text style={styles.message}>
             Could this sheet resize to its content height ?
           </Text>
@@ -62,6 +63,7 @@ const DynamicSnapPointExample = () => {
           </View>
           <Button label="Yes" onPress={handleIncreaseContentPress} />
           <Button label="Maybe" onPress={handleDecreaseContentPress} />
+          </View>
         </BottomSheetView>
       </BottomSheet>
     </View>

About this issue

  • Original URL
  • State: closed
  • Created 3 years ago
  • Reactions: 27
  • Comments: 46

Most upvoted comments

Has anyone a solution for this?

Good workaround is using BottomShitScrollView with scroll false prop

Having the same issue with BottomSheetView, replacing it with BottomSheetScrollView seems to work

As others mentioned, disabling flex and adding a min height worked for me:

        <BottomSheetView style={{ flex: 0, minHeight: 100 }}>{children}</BottomSheetView>

BottomSheetScrollView maybe does this too but I did not want the contents to be scrollable in my case.

Not sure how related is this, but this worked for me.

      <BottomSheetModal
        index={1}
        ref={ref}
        snapPoints={[1]} // ********* HERE, Add a default snapPoint 1
        enableDynamicSizing // ********* HERE Enable to dynamic sizing
      >
        <BottomSheetView style={styles.container}> // ********* HERE { flex: 0, minHeight: 100 }
          ...dynmic content
            
        </BottomSheetView>
      </BottomSheetModal>

deleting flex: 1 from BottomSheetView fixed same problem don’t forget r console

This isn’t stale

Same here, the only solution that works is using BottomSheetScrollView. The docs are wrong ATM. Thx for the tip guys!

As of today, the most reasonable workaround seems to be the BottomSheetScrollView:

export default function BottomSheetModalWithDynamicSizing() {
  const { bottom } = useSafeAreaInsets();
  
  // ...
  
  return (
    <BottomSheetModal enableDynamicSizing={true} ... >
      <BottomSheetScrollView contentContainerStyle={{ paddingBottom: bottom }} scrollEnabled={false}>
        {children}
      </BottomSheetScrollView>
    </BottomSheetModal>
  );
}

Having the same issue with BottomSheetView, replacing it with BottomSheetScrollView seems to work

This seems to be a workaround but I can’t get paddingBottom to work with it. How are you styling on devices with safe area bottom? I was giving paddingBottom as bottom from useSafeAreaInsets and giving a backgroundColor to BottomSheetView. That doesn’t work anymore using enableDynamicSizing.

@gorhom Any idea on how to fix this?

Adding code below

const { top, bottom } = useSafeAreaInsets();

return (
  <BottomSheetModal
    ref={ref}
    index={0}
    enableDynamicSizing
    enablePanDownToClose
    backdropComponent={RenderBackdrop}
    onDismiss={onDismiss}
    onChange={setCurrentIndex}
    name={name}
    topInset={top}
    keyboardBehavior={Platform.OS === 'android' ? 'extend' : 'interactive'}
    keyboardBlurBehavior="restore"
    handleComponent={handleComponent}
    backgroundStyle={{
      backgroundColor: colors.background[100],
    }}>
    <BottomSheetView
      style={[themeStyle.contentContainer, { paddingBottom: bottom }]}>
      {children}
    </BottomSheetView>
  </BottomSheetModal>
);

@rorycaseyap in v5 this worked for me

<BottomSheet
        ref={bottomSheetRef}
        enableDynamicSizing={true}
        enablePanDownToClose={true}
        index={-1}
        backdropComponent={(props) => (
          <BottomSheetBackdrop {...props} disappearsOnIndex={-1} appearsOnIndex={0} opacity={0.5} />
        )}
        style={{
          paddingHorizontal: 24,
          backgroundColor: THEME.COLORS.WHITE,
          borderRadius: 24,
          shadowColor: '#000000',
          shadowOffset: {
            width: 0,
            height: 8,
          },
          shadowOpacity: 0.1,
          shadowRadius: 24,
          elevation: 20,
        }}
        handleIndicatorStyle={{
          backgroundColor: THEME.COLORS.GRAY_40,
          marginTop: 8,
        }}
      >
        <BottomSheetScrollView style={{ flex: 1 }} showsVerticalScrollIndicator={false}>
          <S.Title>{item.benefit?.title}</S.Title>
          <S.Content>
            <S.Description>{item.benefit?.description}</S.Description>
          </S.Content>
          <S.ButtonWrapper>
            {!item.benefit?.isSelected ? (
              <Button text="Selecionar beneficio" onPress={() => handleSelectBenefit(item)} />
            ) : (
              <Button
                text="Desselecionar beneficio"
                variant="tertiary"
                onPress={() => handleRemoveBenefit(item.benefit.id)}
              />
            )}
            <Button
              text="Voltar"
              variant="secondary"
              onPress={() => bottomSheetRef.current.close()}
            />
        </S.ButtonWrapper>
    </BottomSheetScrollView>
</BottomSheet>

For anyone who is struggling with the issue. I’m using version 4.6.3 and getting the dynamic sizing is working properly. Here is my code:

import { useCallback, useRef, useState } from 'react'
import { createContext } from 'react'
import {
  BottomSheetBackdrop,
  BottomSheetBackdropProps,
  BottomSheetModal,
  BottomSheetModalProvider,
  BottomSheetProps,
  BottomSheetView,
} from '@gorhom/bottom-sheet'

type BottomSheetOptions = {
  children: React.ReactNode
} & Omit<BottomSheetProps, 'children'>

const DEFAULT_OPTIONS: BottomSheetOptions = {
  index: -1,
  children: null,
}

type BottomSheetProviderContext = {
  children: React.ReactNode
}

export type BottomSheetContextValue = {
  expand: (options: BottomSheetOptions) => void
  collapse: () => void
}

export const BottomSheetContext = createContext<BottomSheetContextValue | undefined>(undefined)

export function BottomSheetProvider({ children }: BottomSheetProviderContext) {
  const bottomSheetModalRef = useRef<BottomSheetModal>(null)

  const [options, setOptions] = useState<BottomSheetOptions | null>(DEFAULT_OPTIONS)

  const bottomSheetContext: BottomSheetContextValue = {
    expand: (opts: BottomSheetOptions) => {
      bottomSheetModalRef.current?.present()
      setOptions({ ...DEFAULT_OPTIONS, ...opts })
    },
    collapse: () => {
      bottomSheetModalRef.current?.dismiss()
    },
  }

  const renderBackdrop = useCallback(
    (props: BottomSheetBackdropProps) => <BottomSheetBackdrop {...props} appearsOnIndex={0} disappearsOnIndex={-1} />,
    [],
  )

  return (
    <BottomSheetContext.Provider value={bottomSheetContext}>
      {children}
      <BottomSheetModalProvider>
        <BottomSheetModal
          ref={bottomSheetModalRef}
          snapPoints={options?.snapPoints}
          enableDynamicSizing={options?.enableDynamicSizing}
          backdropComponent={renderBackdrop}>
          <BottomSheetView style={{ flex: 0, minHeight: 10 }}>{options?.children}</BottomSheetView>
        </BottomSheetModal>
      </BottomSheetModalProvider>
    </BottomSheetContext.Provider>
  )
}

Usage in a component:

const handleOpen = () => {
  bottomSheet.expand({
    enableDynamicSizing: true,
    children: (
      // bottom sheet content
    ),
  })
}

https://github.com/gorhom/react-native-bottom-sheet/assets/72242664/c6e4d07c-c0f2-4066-ad1c-4053dab606db

enableDynamicSizing does not work if using BottomSheetFlatList inside

<BottomSheetModal
      enableDynamicSizing
      index={0}
      onChange={handleSheetChanges}
      ref={filterModalRef}
      snapPoints={filterSnaps}
      style={modalStyle.modal}
    >
    <BottomSheetFlatList />
</BottomSheetModal>

Dynamic sizing is working for me in version “4.6.1”

<BottomSheetModalProvider>
      <View style={styles.container}>
        <Button onPress={handlePresentModalPress} variant="outline" />
        <BottomSheetModal enableDynamicSizing ref={bottomSheetModalRef}>
          <BottomSheetView>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
            <Text>Awesome 🎉</Text>
          </BottomSheetView>
        </BottomSheetModal>
      </View>
    </BottomSheetModalProvider>
  );
};

const styles = StyleSheet.create({
  header: {
    fontSize: styling.spacing.lg,
  },
  container: {
    flex: 1,
    padding: 24,
    justifyContent: 'center',
    backgroundColor: 'grey',
  },
});

https://github.com/gorhom/react-native-bottom-sheet/assets/79057289/83a08db4-1c61-4b0a-8124-8c858219f4e9

AFAIK not stale still

I had to go back to the deprecated dynamic snap points with the bottomsheetview hook as a workaround

@gorhom Hey man. Thanks for all your hard work. Tagging you here as this is stopping me from upgrading. It would be amazing if you could look into it.