Giter VIP home page Giter VIP logo

flash-message-redux's Introduction

flash-message-redux

Maintainability Test Coverage

Library defining Redux actions and a reducer to to store a global application level message. This is akin to a toast message or a flash message if you are familiar with Ruby on Rails.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

flash-message-redux is an npm module and can be downloaded from the npm registry.

Using npm:

npm i --save flash-message-redux

Using yarn:

yarn add flash-message-redux

Using it

Using the flash-message-redux library is fairly easy. You first need to add the reducer to your combineReducers call. Something like:

import { flashMessageReducer as flashMessage } from 'flash-message-redux';
const rootReducer = combineReducers({
  flashMessage,
});

Next you simple need to use one of the four actions defined:

  • flashInfo
  • flashWarning
  • flashError
  • clearFlash

Each one will create a flash message with the associated level.

Now the question is where do you use these methods. The methods provided through the module do not prevent you using flash-messages at any level of your application. You could use it in the actions, the reducers or the react components. I would advise you to use it in the React components only. Flash messages are a UI construct and it wouldn't make much sense to put them in the action for example... though it might be tempting to do this as you have contextual information there too.

And coding style tests

If submitting code, please ensure that your code follows the eslint rules we use. Thanks.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Martin Beauvais - Initial work - mbeauv

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

flash-message-redux's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.