jcgertig / react-text-marquee

A <marquee> component for react.
MIT License
8 stars 5 forks source link

react-text-marquee

Downloads Downloads npm version dependencies dev dependencies License

A component for react.

Getting Started

Install it via npm or yarn:

npm install --save react-text-marquee
yarn add react-text-marquee

Example

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

class App extends Component {
  render() {
    return (
      <div className="App">
        <Marquee text="Wow this is really quite a long message but it can be handled by this component just fine" />
      </div>
    );
  }
}

Props

text

The text displayed in marquee.

  • Type: String
  • Default: ""

hoverToStop

By default, only hover makes the marquee move.

  • Type: Bool
  • Default: false

loop

Whether or not loop the marquee.

  • Type: Bool
  • Default: false

leading

The leading waiting time for the marquee to move.

  • Type: Number
  • Default: 0

trailing

The trailing waiting time for the marquee to start over.

  • Type: Number
  • Default: 0

License

MIT