https://github.com/ryanhefner/react-marquease

🐛 HTML <marquee>s, the React way (with some handy control features).
https://github.com/ryanhefner/react-marquease

marquee react react-component reactjs

Last synced: about 1 month ago
JSON representation

🐛 HTML <marquee>s, the React way (with some handy control features).

• Host: GitHub
• URL: https://github.com/ryanhefner/react-marquease
• Owner: ryanhefner
• License: mit
• Created: 2022-11-29T15:54:56.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-27T18:12:03.000Z (9 months ago)
• Last Synced: 2024-10-11T07:01:46.332Z (about 1 month ago)
• Topics: marquee, react, react-component, reactjs
• Language: JavaScript
• Homepage: https://pkgstats.com/pkg:react-marquease
• Size: 271 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🐛 react-marquease

[![npm](https://img.shields.io/npm/v/react-marquease?style=flat-square)](https://www.pkgstats.com/pkg:react-marquease)

[![NPM](https://img.shields.io/npm/l/react-marquease?style=flat-square)](LICENSE)

[![npm](https://img.shields.io/npm/dt/react-marquease?style=flat-square)](https://www.pkgstats.com/pkg:react-marquease)

[![Coveralls github](https://img.shields.io/coveralls/github/ryanhefner/react-marquease?style=flat-square)](https://coveralls.io/github/ryanhefner/react-marquease)

[![codecov](https://codecov.io/gh/ryanhefner/react-marquease/branch/main/graph/badge.svg)](https://codecov.io/gh/ryanhefner/react-marquease)

[![CircleCI](https://img.shields.io/circleci/build/github/ryanhefner/react-marquease?style=flat-square)](https://circleci.com/gh/ryanhefner/react-marquease)

![Known Vulnerabilities](https://snyk.io/test/github/ryanhefner/react-marquease/badge.svg)

![Twitter Follow](https://img.shields.io/twitter/follow/ryanhefner)

HTML ``s, the React way (with some handy control features).

## Install

Via [npm](https://npmjs.com/package/react-marquease)

```sh

npm install -S react-marquease

```

Via [Yarn](https://yarn.pm/react-marquease)

```sh

yarn add react-marquease

```

## How to use

```js

import Marquee from 'react-marquease'

const ExampleComponent = () => (

  

    
Scrolly text, moving through, my browser window, moving smooth.


  

)

```


### Props

- `reverse` - Reverse the direction of the `Marquee`. (Scroll left to right)

- `pause` - Pause `Marquee` scrolling

- `speed` - Modifies the `duration` of the web animation as `Marquee` scrolls through the viewport. (Default: `1`)

- `ref` - References the outermost `div` of the component.

- `...rest` - Applied to outermost `div` of the component.

## License

[MIT](LICENSE) © [RyanHefner](https://www.ryanhefner.com)