Giter Club home page Giter Club logo

react-native-styled-dialogs's Introduction

PRs Welcome

React Native: Native Styled Dialogs

React Native Library that shows a beautiful and customizable designed dialog with header. This library is a bridge around Android: MaterialStyledDialogs & iOS: PMAlertController

Getting started

$ npm install react-native-styled-dialogs --save

$ react-native link react-native-styled-dialogs

  • Android

Library id supported SDK 25 > above

Please add below snippet into your app build.gradle

allprojects {
    repositories {
        mavenLocal()
        jcenter()
        maven {
            url "https://jitpack.io"
        }
    }
}
  • iOS

    • Run Command: cd ../node_modules/react-native-styled-dialogs/ios && pod install. If it has error => try pod repo update then pod install

    • Add PMAlertController in your app Embedded Binaries & Linked Frameworks and Libraries. Please follow below video in order to achieve the same:

    • Now build your iOS app through Xcode

    • If you receive below error, please check video below in order to resolve the same:

      SOLUTION

Usage

import RNStyledDialogs from 'react-native-styled-dialogs';

RNStyledDialogs.Show({
  title: "Awesome!",
  description:
    "Glad to you like RNStyledDialogs! If you are up for it, we would like to appreciate you receiving us.",
  positiveText: "Go",
  neutralText: "Close",
  negativeText: "Later",
  onPositive: () => { },
  onNeutral: () => { },
  onNegative: () => { },
  onCancellable: () => { }
});

Props

  • Props: Generic
Prop Type Default Note
title string Specify title on dialogs
description string Specify description on dialog
positiveText string Specify positive button text
neutralText string Specify neutral button text
negativeText string Specify positive negative button text
headerBackgroundColor string - HEX COLOR #FFFFFF Specify header background color
headerIcon string Specify header icon
dialogAnimation bool true Specify dialog animation (enable/disable)
darkerOverlay bool false Specify dialog overlay (enable/disable)
cancelable bool Specify cancelable of dialog behaviour (enable/disable)
autoDismiss bool false Specify dialog should get automatically dismiss or not (enable/disable)
onPositive func Specify positive click callback function
onNeutral bool Specify netural click callback function
onNegative bool Specify negative click callback function
onCancellation bool true Specify cancellation callback function
  • Props: Android
Prop Type Default Note
headerBackgroundImage string Specify header background image
headerTitle string Specify header title
headerIconAnimation bool true Specify header icon animation (enable/disable)
scrollable bool false Specify description scrollable (enable/disable)
maxLines number 5 Specify description max number of lines
  • Props: iOS
Prop Type Default Note
positiveTextColor string - HEX COLOR Specify positive button text color
positiveBackgroundColor string - HEX COLOR #FFFFFF Specify positive button background color
neutralTextColor string - HEX COLOR Specify neutral button text color
neutralBackgroundColor string - HEX COLOR #FFFFFF Specify neutral button background color
negativeTextColor string - HEX COLOR Specify negative button text color
negativeBackgroundColor string - HEX COLOR #FFFFFF Specify negative button background color

Providing Images

Note: Since we are using native libraries, we have not found a solution in order to render RN Images in production, therefore please copy all your image assets in platform specific folders:

  • Android: Please copy your image assets in app resource drawable folder
  • iOS: Please copy your image assets in app resources folder

Please refer example application for the image usage.

Credits

Contribution

Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.

License

This library is provided under the Apache 2 License.

RNStyledDialogs @ Pranav Raj Singh Chauhan

react-native-styled-dialogs's People

Contributors

prscms avatar prscx avatar

Watchers

James Cloos avatar Kong avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.