0.4.5 • Published 6 years ago

react-native-snackbar-length v0.4.5

Weekly downloads
4
License
MIT
Repository
github
Last release
6 years ago

React Native Snackbar

Build status npm downloads npm version Latest GitHub tag

Material-design "Snackbar" component for Android and iOS:

Snackbar screenshot

Snackbars are used for displaying a brief message to the user, along with an optional action. They animate up from the bottom of the screen and then disappear shortly afterward.

See Google's Material Design guidelines for more info on Snackbars and when to use them.

How it works

Snackbar.show({
    title: 'Hello world',
    duration: Snackbar.LENGTH_SHORT,
});

Or, to include an action button:

Snackbar.show({
    title: 'Hello world',
    duration: Snackbar.LENGTH_INDEFINITE,
    action: {
        title: 'UNDO',
        color: 'green',
        onPress: () => { /* Do something. */ },
    },
});

Installation

  1. Install:

    • Using npm: npm install react-native-snackbar --save
    • Using Yarn: yarn add react-native-snackbar
  2. Link:

    • react-native link react-native-snackbar
    • Or if that fails, link manually using these steps
  3. Import it in your JS:

    import Snackbar from 'react-native-snackbar';

Customization

Snackbar.show() accepts the following options:

KeyData typeDefault value?Description
titlestringRequired.The message to show.
durationSee belowSnackbar.LENGTH_SHORTHow long to display the Snackbar.
actionobject (described below)undefined (no button)Optional config for the action button (described below).
backgroundColorstring or styleundefined (natively renders as black)The background color for the whole Snackbar.

Where duration can be one of the following (timing may vary based on device):

  • Snackbar.LENGTH_SHORT (just over a second)
  • Snackbar.LENGTH_LONG (about three seconds)
  • Snackbar.LENGTH_INDEFINITE (stays on screen until the button is pressed)

And the optional action object can contain the following options:

KeyData typeDefault value?Description
titlestringRequired.The text to show on the button.
onPressfunctionundefined (Snackbar is simply dismissed)A callback for when the user taps the button.
colorstring or styleundefined (natively renders as white)The text color for the button.

Notes

A few people have suggested that the default Gradle configs created by react-native init are too outdated. If you have issues compiling for Android after linking this library, please try upgrading Gradle to the latest version! For example:

In your android/build.gradle:

  • com.android.tools.build:gradle:2.2.2

In your android/app/build.gradle:

  • compileSdkVersion 25
  • buildToolsVersion "25.0.2"