Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/puranjayjain/react-materialui-notifications

Spec compliant notifications for react and material ui users
https://github.com/puranjayjain/react-materialui-notifications

design material material-ui notification notifications react react-materialui-notifications spec-compliant-notifications

Last synced: about 1 month ago
JSON representation

Spec compliant notifications for react and material ui users

Awesome Lists containing this project

README

        

# react-materialui-notifications

[![GitHub version](https://img.shields.io/github/release/puranjayjain/react-materialui-notifications.svg)](https://badge.fury.io/gh/puranjayjain%2Freact-materialui-notifications)
[![npm version](https://badge.fury.io/js/react-materialui-notifications.svg)](https://badge.fury.io/js/react-materialui-notifications)

[![Issues](https://img.shields.io/github/issues/puranjayjain/react-materialui-notifications.svg)](https://github.com/puranjayjain/react-materialui-notifications/issues)
[![Forks](https://img.shields.io/github/forks/puranjayjain/react-materialui-notifications.svg)](https://github.com/puranjayjain/react-materialui-notifications/network)
[![Stars](https://img.shields.io/github/stars/puranjayjain/react-materialui-notifications.svg)](https://github.com/puranjayjain/react-materialui-notifications/stargazers)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/puranjayjain/react-materialui-notifications/master/LICENSE.md)

:heart: the package? Then :star: it!

> Spec compliant notifications for react and material ui users

# Installation

* Use the latest github release
* or Install via `npm i react-materialui-notifications --save`

# Demo

For a demo see the docs site (below), for usage example see `src/app/Main.js`

# Documentation

Consult the website [https://puranjayjain.github.io/react-materialui-notifications](https://puranjayjain.github.io/react-materialui-notifications)

# Versioning

For transparency into our release cycle and in striving to maintain backward
compatibility, the project is maintained under
[the Semantic Versioning guidelines](http://semver.org/). Sometimes we screw up,
but we'll adhere to those rules whenever possible.

# Development

* If developing the project use `gulp run.bat` or the equivalent command written in it.
* To release the project use `gulp run.bat` then run `gulp release.bat` or the equivalent command written in them.

# TODO
- [x] a lot of core functionality
- [x] finish up props of the notification class
- [ ] implement expanding notifications
- [x] show the priority notifications on top
- [ ] implement custom notification element which the user can pass (PR required)
- [x] styles for position
- [ ] swipe to dismiss
- [ ] i18n

# License
The Project is Licensed under the [MIT License](https://github.com/puranjayjain/react-materialui-notifications/blob/master/LICENSE)