Git Product home page Git Product logo

react-demiguise's Introduction

react-demiguise

Demiguise pelts are highly valued as the hair may be spun into Invisibility Cloaks. ― Fantastic Beasts and Where to Find Them

React component for showing messages in a row with fade transition

Demo & Examples

Live demo: splact.github.io/react-demiguise

To build the examples locally, run:

npm install
npm start

Then open localhost:8000 in a browser.

Installation

The easiest way to use react-demiguise is to install through NPM and include it in your own React build process (using Browserify, Webpack, etc).

You can also use the standalone build by including dist/react-demiguise.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

npm install react-demiguise --save

Usage

import Demiguise from 'react-demiguise';

<Demiguise
  messages={[
    'Lorem ipsum',
    'Macaroni pepperoni',
    'Shazam!',
    'Nerd Jedi'
  ]}
  delay={1500}
  loop
/>

Properties

  • messages – Array of string to show (default [])
  • delay – Can be both a number representing delay among messages in millis and an array of numbers defining a different delay per message (default 3000)
  • loop – messages are played in loop if true (default false)

Events

  • onLoopEnd – callback executed on loop end

Development (src, lib and the build process)

NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run npm start. If you just want to watch changes to src and rebuild lib, run npm run watch (this is useful if you are working with npm link).

License

MIT

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.