ToastAndroid
React Native's ToastAndroid API exposes the Android platform's ToastAndroid module as a JS module. It provides the method show(message, duration) which takes the following parameters:
- message A string with the text to toast
- duration The duration of the toast—either
ToastAndroid.SHORTorToastAndroid.LONG
You can alternatively use showWithGravity(message, duration, gravity) to specify where the toast appears in the screen's layout. May be ToastAndroid.TOP, ToastAndroid.BOTTOM or ToastAndroid.CENTER.
The showWithGravityAndOffset(message, duration, gravity, xOffset, yOffset) method adds the ability to specify an offset with in pixels.
Example
import React from 'react';
import {StyleSheet, ToastAndroid, Button, StatusBar} from 'react-native';
import {SafeAreaView, SafeAreaProvider} from 'react-native-safe-area-context';
const App = () => {
const showToast = () => {
ToastAndroid.show('A pikachu appeared nearby !', ToastAndroid.SHORT);
};
const showToastWithGravity = () => {
ToastAndroid.showWithGravity(
'All Your Base Are Belong To Us',
ToastAndroid.SHORT,
ToastAndroid.CENTER,
);
};
const showToastWithGravityAndOffset = () => {
ToastAndroid.showWithGravityAndOffset(
'A wild toast appeared!',
ToastAndroid.LONG,
ToastAndroid.BOTTOM,
25,
50,
);
};
return (
<SafeAreaProvider>
<SafeAreaView style={styles.container}>
<Button title="Toggle Toast" onPress={() => showToast()} />
<Button
title="Toggle Toast With Gravity"
onPress={() => showToastWithGravity()}
/>
<Button
title="Toggle Toast With Gravity & Offset"
onPress={() => showToastWithGravityAndOffset()}
/>
</SafeAreaView>
</SafeAreaProvider>
);
};
const styles = StyleSheet.create({
container: {
flex: 1,
justifyContent: 'center',
paddingTop: StatusBar.currentHeight,
backgroundColor: '#888888',
padding: 8,
},
});
export default App;
Reference
Methods
show()
static show(message: string, duration: number);
showWithGravity() Vega Not Available
This property will only work on Android API 29 and below. For similar functionality on higher Android APIs, consider using snackbar or notification.
static showWithGravity(message: string, duration: number, gravity: number);
showWithGravityAndOffset() Vega Not Available
This property will only work on Android API 29 and below. For similar functionality on higher Android APIs, consider using snackbar or notification.
static showWithGravityAndOffset(
message: string,
duration: number,
gravity: number,
xOffset: number,
yOffset: number,
);
Properties
SHORT
Indicates the duration on the screen.
static SHORT: number;
LONG
Indicates the duration on the screen.
static LONG: number;
TOP Vega Not Available
Indicates the position on the screen.
static TOP: number;
BOTTOM Vega Not Available
Indicates the position on the screen.
static BOTTOM: number;
CENTER Vega Not Available
Indicates the position on the screen.
static CENTER: number;
Last updated: Jul 07, 2026
