prscX / react-native-notification-banner

React Native: Native Notification Banner
Apache License 2.0
91 stars 28 forks source link
android ios react-native

PRs Welcome

ReactNative: Native Notification Banner (Android/iOS) If this project has helped you out, please support us with a star 🌟

A simple lightweight dropdown banner library using creates native capabilities

Android

Tapadoo/Alerter

iOS

bryx-inc/BRYXBanner

πŸ“– Getting started

$ yarn add react-native-notification-banner

RN61 >= RNBAS V2 >

$ npm install react-native-image-helper --save

$ npm install react-native-vector-icons --save

Please add below snippet into your app build.gradle

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

RN60 >= RNNB V1 >

$ yarn add react-native-vector-icons

RN60 above please use react-native-notification-banner V1 and above

Please add below snippet into your app build.gradle

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

RN60 < RNNB V1 <

RN60 below please use react-native-notification-banner V.0.*

$ react-native link react-native-notification-banner

$ react-native link react-native-vector-icons

Please add below snippet into your app build.gradle


buildscript {
    repositories {
        jcenter()
        maven { url "https://maven.google.com" }
        ...
    }
    ...
}

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
        maven { url "https://maven.google.com" }
        ...
    }
}

Note: This library is support on Android 27 > above

πŸ’» Usage

import { RNNotificationBanner } from 'react-native-notification-banner';

import Icon from 'react-native-vector-icons/FontAwesome'
let copy = <Icon name="copy" size={24} color="#FFFFFF" family={"FontAwesome"} />;

RNNotificationBanner.Show({
  title: "Message",
  subTitle: "Message",
  withIcon: true,
  icon: copy,
  titleColor: "#FFFFFF",
  subTitleColor: "#FFFFFF",
  isSwipeToDismissEnabled: true,
})

Note:

  • We have added family prop for Icon class, please make sure that you pass the props

πŸ’‘ API's

Success, Error, Info, Warn, Normal, Show

🎨 Props

Prop Type Default Note
title string Specify title of banner
subTitle string Specify subtitle of banner
tintColor HEX-COLOR Specify tint color of banner
withIcon bool Enable/Disable icon
icon RNVectorIcon Specify banner icon
duration int Specify duration to show banner
enableProgress bool false Specify to show progress on banner
onClick func Specify onClick callback
onHide func Specify onHide callback

Icons

    let facebook = <Icon family={'FontAwesome'} name={'facebook'} color={'#000000'} size={30} />

    RNNotificationBanner.Success({ title: "Message", subTitle: "Message", withIcon: true, icon: copy})

Note:

  • We have added family prop for Icon class, please make sure that you pass the props

✨ Credits

πŸ€” How to contribute

Have an idea? Found a bug? Please raise to ISSUES. Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.

πŸ’« Where is this library used?

If you are using this library in one of your projects, add it in this list below. ✨

πŸ“œ License

This library is provided under the Apache 2 License.

RNBottomActionSheet @ prscX

πŸ’– Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it: