Skip to content

ahmadaIanazi/bottoms

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bottoms - React Native Module

Version License Downloads Size

A versatile and interactive React Native module for creating performant bottom sheets with customizable options 🚀

Features

  • Modal presentation view and bottom sheet modal.
  • Smooth gesture interactions with snapping animations.
  • Seamless keyboard handling for iOS and Android.
  • Support for pull-to-refresh in scrollable views.
  • Compatible with FlatList, SectionList, ScrollView, and View scrolling interactions.
  • Integration with React Navigation for enhanced navigation support.
  • Works with Reanimated v1 and v2.
  • Compatible with Expo.
  • Accessibility support.
  • Written in TypeScript for type safety.

Installation

To install "bottoms," use the following command:

1

npm install bottoms

or

yarn add bottoms

2

Please make sure to install the following dependencies in your project:

npm install react-native-reanimated react-native-gesture-handler @gorhom/bottom-sheet zustand

or if you're using Expo:

npx expo install react-native-reanimated react-native-gesture-handler @gorhom/bottom-sheet zustand

Note: React Native Gesture Handler and Reanimated may require additional configuration steps, so follow their installation instructions for compatibility.

Usage

  1. Import the "bottoms" module in your React Native project.
  2. Use the provided hooks or methods to create and customize bottom sheets in your app.
  3. Wrap your entire app with this provider and pass the Layout component to it.
  4. Call 'bottom' to perform functions such as bottom.open('sheet')

For detailed usage examples and API documentation, refer to the documentation.

Support and Contributions

If you find this module helpful, consider supporting its maintenance by sponsoring it on GitHub. For personalized support or customizations, feel free to reach out to us on X @ahmad_alshbeeb.

License

This project is licensed under the MIT License.


Built with ❤️ by Ahmad Alshbeeb (x.com/ahmad_aslhbeeb)

About

Bottom Sheet for React Native and Expo Router

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published