feat(Bonus Pagamenti Digitali): [#175253344] Create BottomSheet component with context provider and HOC #2306
Conversation
CrisTofani
requested review from
fabriziofff,
francescopersico and
Undermaken
as code owners
pagopa-github-bot
changed the title
Affected stories
New dependencies added: react-native-reanimatedAuthor: Krzysztof Magiera Description: More powerful alternative to Animated library for React Native. Homepage: https://github.com/software-mansion/react-native-reanimated#readme
reanimated-bottom-sheetAuthor: Michał Osadnik Description: Bottom sheet component Homepage: https://github.com/osdnk/reanimated-bottom-sheet#readme
|
 |
 |
 |
 |
|---|
Installation
Open a Terminal in the project root and run:
yarn add reanimated-bottom-sheetOr if you use npm:
npm install reanimated-bottom-sheetNow we need to install react-native-gesture-handler and react-native-reanimated.
If you are using Expo, to ensure that you get the compatible versions of the libraries, run:
expo install react-native-gesture-handler react-native-reanimatedIf you are not using Expo, run the following:
yarn add react-native-reanimated react-native-gesture-handlerOr if you use npm:
npm install react-native-reanimated react-native-gesture-handlerWe're done! Now you can build and run the app on your device/simulator.
Usage
import * as React from 'react';
import { StyleSheet, Text, View, Button } from 'react-native';
import Animated from 'react-native-reanimated';
import BottomSheet from 'reanimated-bottom-sheet';
export default function App() {
const renderContent = () => (
<View
style={{
backgroundColor: 'white',
padding: 16,
height: 450,
}}
>
<Text>Swipe down to close</Text>
</View>
);
const sheetRef = React.useRef(null);
return (
<>
<View
style={{
flex: 1,
backgroundColor: 'papayawhip',
alignItems: 'center',
justifyContent: 'center',
}}
>
<Button
title="Open Bottom Sheet"
onPress={() => sheetRef.current.snapTo(0)}
/>
</View>
<BottomSheet
ref={sheetRef}
snapPoints={[450, 300, 0]}
borderRadius={10}
renderContent={renderContent}
/>
</>
);
}Props
| name | required | default | description |
|---|---|---|---|
| snapPoints | yes | E.g. [300, 200, 0]. Points for snapping of bottom sheet coomponent. They define distance from bottom of the screen. Might be number or percent (as string e.g. '20%') for points or percents of screen height from bottom. Note: Array values must be in descending order. |
|
| initialSnap | no | 0 | Determines initial snap point of bottom sheet. The value is the index from snapPoints. |
| renderContent | no | Method for rendering scrollable content of bottom sheet. | |
| renderHeader | no | Method for rendering non-scrollable header of bottom sheet. | |
| enabledGestureInteraction | no | true |
Defines if bottom sheet could be scrollable by gesture. |
| enabledHeaderGestureInteraction | no | true |
Defines if bottom sheet header could be scrollable by gesture. |
| enabledContentGestureInteraction | no | true |
Defines if bottom sheet content could be scrollable by gesture. |
| enabledContentTapInteraction | no | true |
Defines whether bottom sheet content could be tapped. Note: If you use Touchable* components inside your renderContent, you'll have to switch this to false to make handlers like onPress work. (See this comment.) |
| enabledManualSnapping | no | true |
If false blocks snapping using snapTo method. |
| enabledBottomClamp | no | false |
If true block movement is clamped from bottom to minimal snapPoint. |
| enabledBottomInitialAnimation | no | false |
If true sheet will grows up from bottom to initial snapPoint. |
| enabledInnerScrolling | no | true |
Defines whether it's possible to scroll inner content of bottom sheet. |
| callbackNode | no | reanimated node which holds position of bottom sheet, where 0 it the highest snap point and 1 is the lowest. |
|
| contentPosition | no | reanimated node which holds position of bottom sheet's content (in dp) |
|
| headerPosition | no | reanimated node which holds position of bottom sheet's header (in dp) |
|
| overdragResistanceFactor | no | 0 | `Defines how violently sheet has to stopped while overdragging. 0 means no overdrag |
| springConfig | no | { } |
Overrides config for spring animation |
| innerGestureHandlerRefs | no | Refs for gesture handlers used for building bottom sheet. The array consists fo three refs. The first for PanGH used for inner content scrolling. The second for PanGH used for header. The third for TapGH used for stopping scrolling the content. | |
| simultaneousHandlers | no | Accepts a react ref object or an array of refs to handler components. | |
| onOpenStart | no | Accepts a function to be called when the bottom sheet starts to open. | |
| onOpenEnd | no | Accepts a function to be called when the bottom sheet is almost fully openned. | |
| onCloseStart | no | Accepts a function to be called when the bottom sheet starts to close. | |
| onCloseEnd | no | Accepts a function to be called when the bottom sheet is almost closing. | |
| callbackThreshold | no | 0.01 | Accepts a float value from 0 to 1 indicating the percentage (of the gesture movement) when the callbacks are gonna be called. |
| borderRadius | no | Border radius of content wrapper (excluding header) |
Methods
snapTo(index)
Imperative method on for snapping to snap point in given index. E.g.
// Snap to the snap point at index 0 (e.g. 450 in [450, 300, 0])
this.bottomSheetRef.current.snapTo(0)Here this.bottomSheetRef refers to the ref passed to the BottomSheet component.
Example
More complex examples can be found in the Example folder. To view the examples in the Expo app, open a Terminal and run:
yarn
yarn prepare
cd Example
yarn
expo startThe example app is also available on Expo.
Todo
It's not finished and some work has to be done yet.
- Play with magic config values
- Horizontal mode
- Deal with GH in inner scrollView
- Cleanup code (e.g. measuring of components)
Contributing
Publishing a release
We use release-it to automate our release. If you have publish access to the NPM package, run the following from the master branch to publish a new release:
yarn releaseNOTE: You must have a GITHUB_TOKEN environment variable available. You can create a GitHub access token with the "repo" access here.
Codecov Report
@@ Coverage Diff @@
## master #2306 +/- ##
==========================================
- Coverage 48.05% 48.00% -0.05%
==========================================
Files 588 591 +3
Lines 16857 16930 +73
Branches 3065 3350 +285
==========================================
+ Hits 8101 8128 +27
- Misses 8714 8760 +46
Partials 42 42
Continue to review full report at Codecov.
|
| )(withLightModalContext(ActiveBonusScreen)); | ||
| )(withBottomSheetContext(withLightModalContext(ActiveBonusScreen))); |
There was a problem hiding this comment.
This lgtm, but being a functional component we could also use:
const context = useContext(BottomSheetContext);
[...]
context.showBS(modalBox, I18n.t("bonus.bonusVacanze.name"), 466);without withBottomSheetContext and BottomSheetContextInterface to inject the context.
I found this out just now and it seemed nice to share!
There was a problem hiding this comment.
@fabriziofff nice suggestion! I noticed the useContext hook, but actually didn't focused on how to use it.
I'm not actually sure if using 2 different approaches may result too chaotic. We may use at the same time useContext hook for LightModal too, but this will create a misalignment with the rest of the codebase.
I, anyway, prefer the usage of the hook.
| class WithBottomSheetContext extends React.Component<P> { | ||
| public render() { | ||
| return ( | ||
| <BottomSheetConsumer> | ||
| {contextProps => ( | ||
| <WrappedComponent {...contextProps} {...this.props} /> | ||
| )} | ||
| </BottomSheetConsumer> | ||
| ); | ||
| } | ||
| } |
There was a problem hiding this comment.
My proposal to avoid a class component.
| class WithBottomSheetContext extends React.Component<P> { | |
| public render() { | |
| return ( | |
| <BottomSheetConsumer> | |
| {contextProps => ( | |
| <WrappedComponent {...contextProps} {...this.props} /> | |
| )} | |
| </BottomSheetConsumer> | |
| ); | |
| } | |
| } | |
| const WithBottomSheetContext: React.FunctionComponent<P> = props => ( | |
| <BottomSheetConsumer> | |
| {contextProps => <WrappedComponent {...contextProps} {...props} />} | |
| </BottomSheetConsumer> | |
| ); |
ts/components/ui/BottomSheet.tsx
Outdated
| showBS: ( | ||
| component: React.ReactNode, | ||
| title: string, | ||
| snapPoint: number | ||
| ) => void; | ||
| hideBS: () => void; |
There was a problem hiding this comment.
What you think about call the two methods showBottomSheet and hideBottomSheet in order to have a self-explanatory name?
There was a problem hiding this comment.
Sure! Will rename both functions
| ) : ( | ||
| <> | ||
| <Animated.View | ||
| pointerEvents={"none"} |
There was a problem hiding this comment.
When the bottomsheet is open is still possible to interact with the background (the "dark area"). Maybe should be "auto" when is opened?
There was a problem hiding this comment.
@fabriziofff Good catch! This actually was my third version of the implementation and I started anytime from the beginning, I forgot to remove the pointerEvents attribute!
| const closeBottomSheet = () => { | ||
| setAccessible(false); | ||
| if (bottomSheetRef && bottomSheetRef.current) { | ||
| bottomSheetRef.current.snapTo(0); | ||
| closeBackdropAnimation(); | ||
| props.handleClose(); | ||
| } | ||
| }; |
There was a problem hiding this comment.
| const closeBottomSheet = () => { | |
| setAccessible(false); | |
| if (bottomSheetRef && bottomSheetRef.current) { | |
| bottomSheetRef.current.snapTo(0); | |
| closeBackdropAnimation(); | |
| props.handleClose(); | |
| } | |
| }; | |
| const closeBottomSheet = () => { | |
| setAccessible(false); | |
| if (bottomSheetRef && bottomSheetRef.current) { | |
| bottomSheetRef.current.snapTo(0); | |
| } | |
| }; |
When the bottomsheet is closed with the X there is a slightly different graphical behavior.
It doesn't do the exit animation and when it is called next time it does not do the entry animation.
Removing these lines works for me, because the backdropanimation is executed by the callback, but I don't know if removing props.handleClose(); generate any others side effects.
| renderContent={() => ( | ||
| <View style={styles.content}>{props.content}</View> | ||
| )} |
There was a problem hiding this comment.
| renderContent={() => ( | |
| <View style={styles.content}>{props.content}</View> | |
| )} | |
| renderContent={() => ( | |
| <View style={styles.content}> | |
| <SafeAreaView style={IOStyles.flex}>{props.content}</SafeAreaView> | |
| </View> | |
| )} |
My proposal to avoid possible overflows (like this) in the safe area:
…ttom-sheet-component
…mponent' into 175253344-create-bottom-sheet-component
Short description
This PR adds a new
BottomSheetcomponent that can be used through any screen with the HOCwithBottomSheetContextHow to test
To test request a new Bonus Vacanze and tap on QR code footer button, the previously implemented modal box is now been converted to Common BottomSheet