Skip to content

devbabs/react-native-toast-alert

Repository files navigation

react-native-toast-alert

An awesome package for cool toast alerts in react-native πŸš€

Toast.success("Welcome. you will definitely love this toast package.πŸ˜‰")

Installation

npm install react-native-toast-alert

Usage

πŸ‘‰πŸ½ Step 1

Import ToastManager and Toast.

// ...
import ToastManager { Toast } from 'react-native-toast-alert'

πŸ‘‰πŸ½ Step 2

Add ToastManager component to the top of your app component structure.

const App = () => {
  return (
    <View>
      <ToastManager />
      <App>
        // Other parts of your application content can go here
      </App>
    </View>
  )
})

πŸ‘‰πŸ½ Step 3 (Final Step)

Call any of the Toast methods directly

const App = () => {
  // ...

  const showSuccessToast = () => {
    Toast.success("Yaay!!! You made it here...πŸš€πŸš€πŸš€")
  }

  const showErrorToast = () => {
    Toast.error("Error, looks like something went wrong.πŸ™")
  }

  const showInfoToast = () => {
    Toast.info("Hi, you're still online.")
  }

  const showWarningToast = () => {
    Toast.warning("Your wallet balance is running low.")
  }

  return (
    <View>
      <ToastManager />
      <Touchable
        onPress={() => showSuccessToast()}
      >
        Show
      </Touchable>
    </View>
  )
})

// ...

Note:

Each of the methods on the toast take 2 parameters: The toast message and an optional list of configuration options.

Options for Configuraton

Option Description Type Default Value
duration How long the toast will be visible for (milliseconds) number 2000
progress Show progress bar boolean false
bounce Add bounce effect while showing toast boolean false
autoDismiss Dismiss toast automatically boolean true
centerText Align the text in the toast centrally boolean false
dismissMode How to dismiss the toast manually. (This is useful if you set autoDismiss to false) 'tap' or 'swipe' tap

Happy Coding πŸ₯‚

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT