Code Monkey home page Code Monkey logo

rn-custom-toast's Introduction

rn-custom-toast

Module for react-native to show android like toast messages on both Android and iOS with customisations. NPM Version Repo Size Downloads roundCube Labs

 rn-custom-toast Demo

Setup

This package is available on npm, install it with: npm install --save rn-custom-toast

Usage

  1. Import rn-custom-toast to your project: import { Toast } from 'rn-custom-toast'

  2. Create a toast and add reference to it: <Toast ref="toast" />

  3. Whenever you want to open toast call the function like this:

this.refs.toast.show(Message to display, Options Object)

Example Code: this.refs.toast.show("This is a toast", {theme: "dark"});

  1. Close the toast (Optional ,since by default it closes automatically): this.refs.toast.hide()

Complete Example

import React, { Component } from "react";
import { View, Text, TouchableOpacity } from "react-native";
import { Toast } from "rn-custom-toast";
export default class App extends Component {
  render() {
    return (
      <View>
        <TouchableOpacity
          onPress={() => {
            this.refs.toast.show("I am a toast", {
              shadow: false,
              theme: "dark",
              position: "bottom",
              animation: "slide",
              showCloseButton: false,
              duration: "short",
              animationDuration: 500
            });
          }}
        >
          <Text>Display Toast</Text>
        </TouchableOpacity>
        <TouchableOpacity
          onPress={() => {
            this.refs.toast.hide();
          }}
        >
          <Text>Hide Toast</Text>
        </TouchableOpacity>
        <Toast ref="toast" />
      </View>
    );
  }
}

For a much detailed example take a look at the /examples directory.

Available Options

Name Type Default Possible Values
theme String light ["light","dark","success","danger","warning","info"]
position String bottom ["top","bottom"]
animation String fade ["fade","slide"]
duration String or Integer short ["short","long"] or Milliseconds
showCloseButton bool true [true,false]
animationDuration Integer 300 Milliseconds
shadow bool true [true,false]
customTheme object null
customTheme.container styles object null {backgroundColor: 'red'}
customTheme.closeContainer styles object null {backgroundColor: 'red'}
customTheme.text styles object null {color: 'blue'}
customTheme.closeText styles object null {color: 'blue'}

Feedback

Pull requests, suggestions and feedbacks are welcome!

Links

Our Website Our Facebook Our Linkedin Our Instagram

rn-custom-toast's People

Contributors

dependabot[bot] avatar usamamoinakhter avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

usamamoinakhter

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.