Skip to content

Repository files navigation

react-alert npmBuild Status

A simple react alert (toaster style) component

Demo

You can see a live demo here.

Installation

$ npm install react-alert

It expects external react, react-dom and react-addons-css-transition-group.

Usage

To use it, you have to import the AlertContainer component, like this:

importReactfrom'react';importAlertContainerfrom'react-alert';exportdefaultclassAppextendsReact.Component{constructor(props){super(props);this.alertOptions={offset: 14,position: 'bottom left',theme: 'dark',time: 5000,transition: 'scale'};}showAlert(){this.msg.show('Some text or component',{time: 2000,type: 'success',icon: <imgsrc="path/to/some/img/32x32.png"/>});}render(){return(<div><AlertContainerref={a=>this.msg=a}{...this.alertOptions}/><buttononClick={this.showAlert.bind(this)}>Show Alert</button></div>);}}

Options

The AlertContainer component accepts the following options:

{//defaultsoffset: 14,//the offset of the alert from the page border, can be any numberposition: 'bottom left',//the position of the alert, can be [bottom left, bottom right, top left, top right]theme: 'dark',//the color theme of the alert, can be [dark, light]time: 5000,//the time in miliseconds to the alert close itself, use 0 to prevent auto close (apply to all alerts)transition: 'scale'//the transition animation, can be [scale, fade]}

When you call the show method, you can include the following options as a second parameter:

{time: 0,//the time in miliseconds to the alert close itself, use 0 to prevent auto close (apply to this alert only), default is 5000type: 'info',//the alert type, can be [info, success, error], default is infoicon: <imgsrc="path/to/some/img/32x32.png"/>//the icon to show in the alert, if none is given the default of each type will be showed}

Api

Once you have the reference of the AlertContainer you can call the following methods:

//show an alertthis.msg.show('Some message or component');//show an info alertthis.msg.info('Some info message or component');//show a success alertthis.msg.success('Some success message or component');//show an error alertthis.msg.error('Some error message or component');//removes all alerts from the pagethis.msg.removeAll();

Using React Components as alert content

You can also use a React Component to show a alert message, like this:

//show an alert with a React Component as contentthis.msg.show(<AComponentaProp="some message"/>);

About

A simple react alert (toaster style) component

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages