Installation

npm install react-native-actions-sheet

The library depends on react-native-reanimated, react-native-worklets, react-native-gesture-handler and react-native-safe-area-context, so make sure these are installed too:

npm install react-native-reanimated react-native-worklets react-native-gesture-handler react-native-safe-area-context

[!IMPORTANT] v11 requires React Native's New Architecture. If your app is still on the legacy architecture, stay on react-native-actions-sheet@10.

Check out the installation section of our docs for the detailed installation instructions.

Documentation

Check out our dedicated documentation page for info about this library, it's features, API reference and more: https://rnas.vercel.app

What's new in v11

• Gestures, scroll handling and animations now run on the UI thread, so a busy JS thread no longer stutters the sheet.
• Flick to snap: the sheet carries to the next snap point (or dismisses) based on release velocity.
• Multiple scrollables in one sheet, and useSheetScrollable for custom Animated lists.
• SheetGestureBlocker to keep the sheet still while interacting with sliders, maps, WebViews and other gesture-heavy views.
• useSheetPosition and onChangeWorklet to drive animations from the sheet's live position.
• The backdrop dims as you drag the sheet down (dimBackdropOnDrag).
• Accessibility improvements: modal semantics for screen readers, escape gesture support and an adjustable grabber.
• An official Jest mock, see Testing.

Migrating from v10

v11 requires the New Architecture and makes react-native-worklets a peer dependency. For most apps nothing else changes. Please read through the migration guide and take the necessary steps.

Examples

The source code for the example (showcase) app is under the example/ directory. If you want to play with the ActionSheet but don't feel like trying it on a real app, you can run the example snack.

Consider supporting with a ⭐️ star on GitHub

If you are using the library in one of your projects, consider supporting with a star. It takes a lot of time and effort to keep this maintained and address issues and bugs. Thank you.

MIT Licensed