A universal marquee component for react, just plug in some props and play

A universal marquee component for react, just plug in some props and play

A Globally Designed Marquee Component For React

marquee-react-dwyer

Downloads Downloads npm version License

UPDATE: This package is NOT being deprecated (as originally announced, warranted due to growing use)*

A horizontal marquee component for React.js. All you do is install, require, and plug in your props and you have a full fledged marquee!

Alert

You must add these lines to your CSS or the marquee will NOT work:

@keyframes marquee {
    0%   { transform: translate(0, 0); animation-timing-function: ease-in;}
    100% { transform: translate(-100%, 0); animation-timing-function: ease-out;}
}
  • Live Example: http://null-yard.surge.sh/

Getting Started

Install it via npm:

npm i --save marquee-react-dwyer

Example

import React, { Component } from 'react';
import Marquee from 'marquee-react-dwyer';
import './App.css';

class App extends Component {
  render() {
    return (
      <div className="App">
        <Marquee
		  Size={"h1"}
		  NumberOfOptions={"9"}
		  Index0={"Hey There ..."}
		  Index1={"I was ..."}
		  Index2={"looking for a marquee ..."}
		  Index3={"to use in a ..."}
		  Index4={"react application."}
		  Index5={"I never ..."}
		  Index6={"found one."}
		  Index7={"So I made one for all to use."}
		  Index8={"Your contributions are encouraged!"}
		  TimeToCross={"10000"}
		  TimeToChange={"2000"}
		  IsRandom={"true"}
		  Color={"red"}
		/>
      </div>
    );
  }
}

Props

Size

The HTML element you want your marquee displayed as, h1, h2..., h6, p.

  • Type: string
  • Required

NumberOfOptions

How many text options. Will always be one more than the biggest index supplied, due to zero being the first index. i.e If your last string is Index3, your NumberOfOptions will be 4.

  • Type: String
  • Required

Index#

Since you can have various strings appear in your marquee, you can assign them here. If you only want one string, simply provide Index0. The maximum number of different string you can provide is 11, thus Index10 will be the last input.

  • Type: String
  • Minimum 1: Index0, Maximum 11: Index10

TimeToCross

The time in milliseconds that it takes the text to go from the right side of the screen to the left side of the screen.

  • Type: Number in Milliseconds
  • Required

TimeToChange

The time in milliseconds that it takes for the sting being displayed in the marquee to rotate to the next string. If this time is equal to TimeToCross the marquee will display one unique string per one pass of the screen.

  • Type: Number
  • Default: 0

IsRandom

If true, the strings you provided for the marquee will be randomly rotated and displayed. If set to false or an empty string, the strings will appear in order of index, zero first.

  • Type: Boolean String
  • Required

Color

The color of the text in the marquee.

  • Type: CSS Color or hexadecimal color code
  • Required

License

MIT

Copyright 2018 Daniel P. Dwyer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Github Repository