Sonner React Native Toasts
An opinionated toast component for React Native. A port of @emilkowalski's sonner.
Forked from gunnartorfis/rn-sonner
Features
- API fully matches Sonner's
- Multiple variants, including
success, error, warning, custom, promise
- Promise variant with built-in loading state
- Custom JSX with the custom variant
- Top or bottom positions
- Title and description
- Action button with a callback
- Custom icons
- Optionally dismissable with swipe, configurable left or up
- Dismissable with toast.dismiss(), one or all toasts
- Highly performant using Reanimated 3, 60 FPS
- Dark mode built-in
- Works with Expo
- NativeWind supported
- Customizable, styles & className props
- Works outside of React components
Showcase
Installation
npx expo install rn-sonner
Requirements
To use this package, you also need to install its peer dependencies. Check out their documentation for more information:
Usage
In your App.tsx/entry point
import { Toaster } from 'rn-sonner';
function App() {
return (
<View>
<NavigationContainer>...</NavigationContainer>
<Toaster />
</View>
);
}
Show a toast
import { toast } from 'rn-sonner';
function SomeComponent() {
return (
<Button
title="Show Toast"
onPress={() => toast('Hello, World!')}
/>
);
}
Web support
Even though Sonner Native works on the web, it is not recommended to use it there. Instead, use the original Sonner.
The following setup is recommended. Add a sonner.ts and sonner.web.ts file to your project and import from there instead of from this library directly. That way, sonner will be used on the web and rn-sonner on native.
// sonner.ts
export * from 'rn-sonner';
// sonner.web.ts
export * from 'sonner';
Documentation
For more advanced usage, check out the documentation
Recording
https://github.com/user-attachments/assets/ccc428ca-37c3-4589-9e8c-f414c40d764c
Contributing
See the contributing guide to learn how to contribute to the repository and the development workflow.
License
MIT
Made with create-react-native-library
