Alert

Launches an alert dialog with the specified title and message.

Optionally provide a list of buttons. Tapping any button will fire the respective onPress callback and dismiss the alert. By default, the only button will be an 'OK' button.

This is an API that works both on Android and iOS and can show static alerts. To show an alert that prompts the user to enter some information, see AlertIOS; entering text in an alert is common on iOS only.

Example

import React, { useState } from "react";
import { View, StyleSheet, Button, Alert } from "tbox/ui";

const App = () => {
  const createTwoButtonAlert = () =>
    Alert.alert("Alert Title", "My Alert Msg", [
      {
        text: "Cancel",
        onPress: () => console.log("Cancel Pressed"),
        style: "cancel",
      },
      { text: "OK", onPress: () => console.log("OK Pressed") },
    ]);

  const createThreeButtonAlert = () =>
    Alert.alert("Alert Title", "My Alert Msg", [
      {
        text: "Ask me later",
        onPress: () => console.log("Ask me later pressed"),
      },
      {
        text: "Cancel",
        onPress: () => console.log("Cancel Pressed"),
        style: "cancel",
      },
      { text: "OK", onPress: () => console.log("OK Pressed") },
    ]);

  return (
    <View style={styles.container}>
      <Button title={"2-Button Alert"} onPress={createTwoButtonAlert} />

      <Button title={"3-Button Alert"} onPress={createThreeButtonAlert} />
    </View>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: "space-around",
    alignItems: "center",
  },
});

export default App;

iOS

On iOS you can specify any number of buttons. Each button can optionally specify a style, which is one of 'default', 'cancel', or 'destructive'.

Android

On Android at most three buttons can be specified. Android has a concept of a neutral, negative and a positive button:

If you specify one button, it will be the 'positive' one (such as 'OK')
Two buttons mean 'negative', 'positive' (such as 'Cancel', 'OK')
Three buttons mean 'neutral', 'negative', 'positive' (such as 'Later', 'Cancel', 'OK')

Alerts on Android can be dismissed by tapping outside of the alert box. It is disabled by default and can be enabled by providing an optional options parameter with the cancelable property set to true i.e. { cancelable: true }.

The cancel event can be handled by providing an onDismiss callback property { onDismiss: () => {} } inside the options parameter.

Example usage:

Alert.alert("Alert Title", "My Alert Msg", [
  {
    text: "Ask me later",
    onPress: () => console.log("Ask me later pressed"),
  },
  {
    text: "Cancel",
    onPress: () => console.log("Cancel Pressed"),
    style: "cancel",
  },
  { text: "OK", onPress: () => console.log("OK Pressed") },
  {
    // cancelable and onDismiss only work on Android.
    cancelable: true,
    onDismiss: () =>
      console.log(
        "This alert was dismissed by tapping outside of the alert dialog."
      ),
  },
]);

Reference

Methods

`alert()`

static alert(title, message?, buttons?, options?)

Example#

iOS#

Android#

Reference#

Methods#

alert()#

Example

iOS

Android

Reference

Methods

`alert()`