rfm
5.0/51
react-fast-marquee
npm i react-fast-marquee
rfm

react-fast-marquee

A lightweight React component that utilizes the power of CSS animations to create silky smooth marquees.

by justin-chu

1.3.5 (see all)License:MITTypeScript:Built-In
Categories:React Marquee
npm i react-fast-marquee
Readme

React Fast Marquee

React Fast Marquee is a lightweight React component that utilizes the power of CSS animations to create silky smooth marquees.

npm npm downloads justin-chu codecov npm license npm bundle size npm type definitions

demogif

Demo

Check out the demo here and play around with some sample marquees.

Installation

If you're using npm, in the command prompt run:

npm install react-fast-marquee --save

If you're using yarn, run:

yarn add react-fast-marquee

Usage

To use the component, first import Marquee into your file:

import Marquee from "react-fast-marquee";

Then wrap the <Marquee> tags around any component or text you'd like to slide.

<Marquee>
  I can be a React component, multiple React components, or just some text.
</Marquee>

A sample file might look like this:

import React from "react";
import MyComponent from "../components/MyComponent";
import Marquee from "react-fast-marquee";

const App = () => (
  <Marquee>
    <MyComponent />
    <MyComponent />
    <MyComponent />
  </Marquee>
);

export default App;

Props

PropertyTypeDefaultDescription
styleobject{}Inline style for the container div
classNamestring""Name of the css class to style the container div
playbooleantrueWhether to play or pause the marquee
pauseOnHoverbooleanfalseWhether to pause the marquee when hovered
pauseOnClickbooleanfalseWhether to pause the marquee when clicked
direction"left" or "right""left"The direction the marquee is sliding
speednumber20Speed calculated as pixels/second
delaynumber0Duration to delay the animation after render, in seconds
loopnumber0The number of times the marquee should loop, 0 is equivalent to infinite
gradientbooleantrueWhether to show the gradient or not
gradientColorArray<number> of length 3[255, 255, 255]The rgb color of the gradient as an array of length 3
gradientWidthnumber or string200The width of the gradient on either side
onFinishFunctionnullA callback for when the marquee finishes scrolling and stops. Only calls if loop is non-zero.
onCycleCompleteFunctionnullA callback for when the marquee finishes a loop. Does not call if maximum loops are reached (use onFinish instead).
childrenReactNodenullThe children rendered inside the marquee

Downloads/wk

55.1K

GitHub Stars

361

LAST COMMIT

7mos ago

MAINTAINERS

1

CONTRIBUTORS

7

OPEN ISSUES

19

OPEN PRs

1
VersionTagPublished
1.3.5
latest
4mos ago
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100