Package Exports
- react-semantic-toasts
- react-semantic-toasts/styles/react-semantic-alert.css
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-semantic-toasts) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
React Semantic Toasts
Simple and easy Semantic UI animated toast notifications for React
Installation
$ npm install --save react-semantic-toasts semantic-ui-react semantic-ui-css
Usage
The library does not depend on semantic-ui-css
anymore, make sure to import semantic.min.css
or at the very least, to include the following components:
import 'semantic-ui-css/components/reset.min.css';
import 'semantic-ui-css/components/site.min.css';
import 'semantic-ui-css/components/container.min.css';
import 'semantic-ui-css/components/icon.min.css';
import 'semantic-ui-css/components/message.min.css';
import 'semantic-ui-css/components/header.min.css';
Import the library into your project using ES6 module syntax:
import { SemanticToastContainer, toast } from 'react-semantic-toasts';
import 'react-semantic-toasts/styles/react-semantic-alert.css';
Render the SemanticToastContainer
component:
render() {
return <SemanticToastContainer />;
}
Fire as many notifications as you want
setTimeout(() => {
toast(
{
title: 'Info Toast',
description: <p>This is a Semantic UI toast</p>
},
() => console.log('toast closed'),
() => console.log('toast clicked')
);
}, 1000);
setTimeout(() => {
toast({
type: 'warning',
icon: 'envelope',
title: 'Warning Toast',
description: 'This is a Semantic UI toast wich waits 5 seconds before closing',
animation: 'bounce',
time: 5000,
onClick: () => alert('you click on the toast'),
onClose: () => alert('you close this toast')
});
}, 5000);
API
Toast Container
The <SemanticToastContainer>
receives an optional position
prop, which can be one of top-right
, top-center
, top-left
, bottom-right
, bottom-center
or bottom-left
.
The type of animation can be specifed using an optional animation
prop with any supported SemanticUI animation value. If not present, will be derived from the container position.
<SemanticToastContainer position="top-right" />
Toast
The toast
notification function receives a toast options object and optional close and click callbacks as function arguments:
toast(options, onClose, onClick);
Toast Options
title
- The header of the toastdescription
- The content of the toasttype
- Can be one ofinfo
,success
,warning
, orerror
icon
- Override the default iconcolor
- Override color with semantic valuessize
- Size of toast with semantic valuestime
- Duration to keep the toast open, 0 to wait until closed by the useronClose
- The function that will be called when you click the toast is closedonClick
- The function that will be called when you click on the toastanimation
- Override the default toast container animation
License
Licensed under MIT