Props

Bottom Sheet Modal inherits all Bottom Sheet props except for animateOnMount & containerHeight and also it introduces its own props:

Configuration

name

Modal name to help identify the modal for later on.

type	default	required
string	generated unique key	NO

stackBehavior

Available only on v3, for now.

Defines the stack behavior when modal mounts.

• push it will mount the modal on top of the current one.
• switch it will minimize the current modal then mount the new one.
• replace it will dismiss the current modal then mount the new one.

type	default	required
'push' | 'switch' | 'replace'	'switch'	NO

enableDismissOnClose

Dismiss the modal when it is closed, this will unmount the modal.

type	default	required
boolean	true	NO

Callbacks

onDismiss

Callback when the modal dismissed (unmounted).

type onDismiss = () => void;

type	default	required
function	null	NO

Components

containerComponent

Component to be placed as a bottom sheet container, this is to place the bottom sheet at the very top layer of your application when using FullWindowOverlay from React Native Screens. read more

type	default	required
React.ReactNode	undefined	NO