Skip to main content
Version: 0.71

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.SHORT or ToastAndroid.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.

Reference

Methods​

show()​

tsx
static show(message: string, duration: number);

showWithGravity()​

tsx
static showWithGravity(message: string, duration: number, gravity: number);

showWithGravityAndOffset()​

tsx
static showWithGravityAndOffset(
  message: string,
  duration: number,
  gravity: number,
  xOffset: number,
  yOffset: number,
);

Properties​

SHORT​

Indicates the duration on the screen.

tsx
static SHORT: number;

LONG​

Indicates the duration on the screen.

tsx
static LONG: number;

TOP​

Indicates the position on the screen.

tsx
static TOP: number;

BOTTOM​

Indicates the position on the screen.

tsx
static BOTTOM: number;

CENTER​

Indicates the position on the screen.

tsx
static CENTER: number;