JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2396
  • Score
    100M100P100Q118744F
  • License MIT

React Semantic UI alerts library

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

Toasts

Installation

$ npm install --save react-semantic-toasts semantic-ui-react semantic-ui-css

Usage

Import the library into your project using ES6 module syntax

import { SemanticToastContainer, toast } from 'react-semantic-toasts';

Render the SemanticToastContainer component:

render() {
    return <SemanticToastContainer />;
}

Fire as many notifications as you want

setTimeout(() => {
    toast(
        {
            title: 'Info Toast',
            description: 'This is a Semantic UI toast'
        },
        () => console.log('toast closed'),
        () => console.log('toast clicked')
    );
}, 2000);

setTimeout(() => {
    toast({
        type: 'warning',
        icon: 'envelope',
        title: 'Warning Toast',
        description: 'This is a Semantic UI toast wich waits 5 seconds before closing',
        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. 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 toast
  • description - The content of the toast
  • type - Can be one of info, success, warning, or error
  • icon - Override the default icon
  • time - Duration to keep the toast open, 0 to wait until closed by the user
  • onClose - The function that will be called when you click the toast is closed
  • onClick - The function that will be called when you click on the toast

License

Licensed under MIT