1.0.1 • Published 4 years ago

react-native-customized-toast v1.0.1

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

react-native-customized-toast

A react-native framework to render customized toast in both iOS and Android with common behaviour.

Installing

npm install react-native-customized-toast

Example

Toast Example Video

import React, { useState } from 'react';
import {
  TouchableHighlight,
  Text,
  View,
} from 'react-native';
import { Toast, Position, Theme } from 'react-native-customized-toast';

function ToastView(){
  const [message, setMessage] = useState(null);
  
  const showToast = () => {
    setMessage({ text: 'This is a custom Toast' });
  }
  
  const hideToast = () => {
    setMessage(null);
  }
  
  return (
    <View style={{ flex: 1 }}>
      <TouchableHighlight
        onPress={showToast}
      >
        <Text>Show Toast</Text>
      </TouchableHighlight>
      <Toast
        message={message}
        position={Position.TOP}
        theme={Theme.LIGHT}
      >  
      <TouchableHighlight
        onPress={hideToast}
      >
        <Text>Hide Toast</Text>
      </TouchableHighlight>
      </Toast>     
    </View>
  );
};

export default ToastView;

Interfaces

NameType
ThemeLIGHT & DARK
PositionTOP, CENTER & BOTTOM
ToastFontSMALL, MEDIUM, LARGE & XLARGE
Message{ text : string }

API

PropsTypeDefaultRequired
themeThemeTheme.LIGHTfalse
messageMessagenullfalse
childrenReactNode - Any React componentnullfalse
messageColorStringdefaults to redfalse
messageStyleTextStyledefaults to font size 16 and color redfalse
messageFontSizeNumber16false
durationNumber5000false
backgroundColorStringBlack for DARK theme and white for LIGHT themefalse
containerStyleViewStylecontainer with border and corner radiusfalse
borderStyleViewStyleborder width - 1 and radius 10false
positionPositionPosition.TOPfalse
raisedbooleantruefalse
hideOnPressbooleantruefalse

Contributing

Any sort of issues is welcome. Please share the screenshot of the bug. If there are any errors, please share them as well.

Pull requests are also appreciated. If you want to change the API, feel free to connect and discuss first.

License

License