Gathering detailed insights and metrics for @itsramiel/react-native-toast-notifications
Gathering detailed insights and metrics for @itsramiel/react-native-toast-notifications
Installations
npm install @itsramiel/react-native-toast-notificationsDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
18.17.1
NPM Version
9.6.7
Releases
Unable to fetch releases
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
Maintainers
1
Package Meta Information
Latest Version
3.5.2
Package Id
@itsramiel/react-native-toast-notifications@3.5.2
Unpacked Size
144.51 kB
Size
27.78 kB
File Count
52
NPM Version
9.6.7
Node Version
18.17.1
Published on
Aug 25, 2023
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
2
Dev Dependencies
4
react-native-toast-notifications
Toast component for React Native, supports Android, IOS and Web
Features
- Fully Customizable
- Swipe to close support
- Smooth animation
- Fully typed with TypeScript
Demo
Install
Open a Terminal in the project root and run:
1yarn add react-native-toast-notifications
Usage
Wrap your app in the ToastProvider, which provides context for the Toast hook.
1import { ToastProvider } from 'react-native-toast-notifications' 2 3export default function App() { 4 return ( 5 <ToastProvider> 6 <RestOfYourApp /> 7 <ToastProvider/> 8 ); 9}
Then use hook like this everywhere in your app:
1import { useToast } from "react-native-toast-notifications"; 2 3const Component = () => { 4 const toast = useToast(); 5 6 useEffect(() => { 7 toast.show("Hello World"); 8 }, []); 9};
Methods
show()
1toast.show("Task finished successfully", { 2 type: "normal | success | warning | danger | custom", 3 placement: "top | bottom", 4 duration: 4000, 5 offset: 30, 6 animationType: "slide-in | zoom-in", 7});
update()
1let id = toast.show("Loading..."); 2toast.update(id, "Loading completed", {type: "success"});
hide()
1let id = toast.show("Loading..."); 2toast.hide(id); 3// or 4toast.hideAll();
Customization
ToastProvider props
There are lots of props to customize your toast or your can use renderToast to implement your own component.
1<ToastProvider 2 placement="bottom | top" 3 duration={5000} 4 animationType='slide-in | zoom-in' 5 animationDuration={250} 6 successColor="green" 7 dangerColor="red" 8 dangerColor="red" 9 warningColor="orange" 10 normalColor="gray" 11 icon={<Icon />} 12 successIcon={<SuccessIcon />} 13 dangerIcon={<DangerIcon />} 14 warningIcon={<WarningIcon />} 15 textStyle={{ fontSize: 20 }} 16 offset={50} // offset for both top and bottom toasts 17 offsetTop={30} 18 offsetBottom={40} 19 swipeEnabled={true} 20 renderToast={(toastOptions) => JSX.Element} implement custom toast component. 21> 22... 23</>
Custom toast types
You can implement your own custom types or overwrite the existing ones
1<ToastProvider 2 renderType={{ 3 custom_type: (toast) => ( 4 <View style={{padding: 15, backgroundColor: 'grey'}}> 5 <Text>{toast.message}</Text> 6 </View> 7 ) 8 }} 9> 10... 11</> 12 13// You can pass other data to your custom toast using data property in show method. 14toast.show("Show custom toast", {data: { title: 'Toast title' }})
FAQ
- How to call toast outside React components?
To call toasts everywhere (even outside of React components like in redux actions), After you wrapped your app in ToastProvider, You can use the Toast import to call toasts everywhre.
1import {Toast} from "react-native-toast-notifications"; 2 3// you can call this everywhere 4Toast.show('toast message')
- How to show toast inside a Modal?
The Modal component is a native view that sits on top of the rest of react-native application. The only way to put something above it is to put something in the modal itself, or alternately to use a JS only implementation of a Modal.
As a workaround you can put toast inside modal like this:
import Toast from "react-native-toast-notifications";
export Component = () => {
const toastRef = useRef();
return (
<Modal>
.....
<Toast ref={toastRef} />
</Modal>
}
Contributing
Pull request are welcome.
While developing, you can run the example app to test your changes.
Donation
If this project helped you reduce time to develop, you can buy me a cup of coffee :)
Hire
Looking for a React/React-Native Expert? Email at alirezarzna@gmail.com
License
MIT
No vulnerabilities found.
No security vulnerabilities found.