@rn-common/toast
v0.1.3
Published
This component provides a simple and customizable toast notification system for React Native applications. It uses `react-native-reanimated` for animations and `react-native-screens` for overlay support.
Downloads
82
Readme
@rn-common/toast
This component provides a simple and customizable toast notification system for React Native applications. It uses react-native-reanimated
for animations and react-native-screens
for overlay support.
Features
- Customizable Toast Styles: Define custom styles for different types of toasts.
- Animation Support: Includes slide-in and slide-out animations using
react-native-reanimated
. - Auto Dismiss: Toasts automatically dismiss after a specified duration.
- Cross-Platform Support: Works on both iOS and Android with platform-specific optimizations.
Installation
Install using:
npx expo install @rn-common/toast react-native-reanimated react-native-safe-area-context react-native-screens
Usage
Importing the Component
import Toast from '@rn-common/toast'
Setting Up the Toast Provider
Place the Toast.Provider
component at the root of your app, preferably at a high level in the component tree.
Make sure to wrap the Toast.Provider
component inside a SafeAreaProvider
from react-native-safe-area-context
to ensure the toast is displayed correctly.
import React from 'react'
import { SafeAreaProvider } from 'react-native-safe-area-context'
import Toast from '@rn-common/toast'
export default function App() {
const toastConfig = {
duration: 4000,
toastMap: {
success: {
indicatorStyle: { backgroundColor: 'green' },
textStyle: { color: 'white' },
},
error: {
indicatorStyle: { backgroundColor: 'red' },
textStyle: { color: 'white' },
},
},
}
return (
<SafeAreaProvider>
{/* Your other app components */}
<Toast.Provider config={toastConfig} />
</SafeAreaProvider>
)
}
Showing a Toast
To show a toast, call the Toast.show
method with the desired type and message:
import Toast from '@rn-common/toast'
// Example usage:
Toast.show('success', 'This is a success message!')
Toast.show('error', 'This is an error message!')
Configuration
The Toast.Provider
accepts a config
prop to customize toast behavior:
duration
(optional): Duration in milliseconds for how long the toast should be visible. Defaults to 3000 ms.toastMap
: An object mapping toast types to their styles. Each entry can haveindicatorStyle
andtextStyle
properties.
Styling
Customize the styles by modifying the toastMap
configuration:
indicatorStyle
: Style for the indicator on the left side of the toast.textStyle
: Style for the toast message text.