@wethegit/react-marquee

• Getting set up
  • Install
  • Import the CSS
• Usage
• Props
• Styling
• Reduced motion

Getting set up

Install

npm install @wethegit/react-marquee

Import the CSS

Import this wherever it makes sense to, based on your project structure:

import "@wethegit/react-marquee/style.css"

Usage

const YourComponent = () => {
  const prefersReducedMotion = window.matchMedia(
    "(prefers-reduced-motion: reduce)"
  ).matches

  return (
    <Marquee
      className="marquee--modifier-class"
      prefersReducedMotion={prefersReducedMotion}
      reducedMotionSpeed={20}
    >
      {/* Good practice to add size of image to avoid stutter */}
      <img src="image-1.png" alt="" width="500" height="500" />
      <img src="image-2.png" alt="" width="500" height="500" />
      <img src="image-3.png" alt="" width="500" height="500" />
    </Marquee>
  )
}

Props

| Prop | Type | Default value | Description | | -------------------- | ------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | speed | Number | 50 | Controls the speed of the marquee animation. If prefersReducedMotion is true, speed defaults to reducedMotionSpeed. | | reducedMotionSpeed | Number | 20 | A customisable value used to set the speed of the component if prefersReducedMotion is true. | | prefersReducedMotion | Boolean | false | Whether the user prefers reduced motion. If true, the component will default to a much slower speed, unless a custom speed is specified using: reducedMotionSpeed. | | playing | Boolean | true | Whether the marquee animation is playing or paused. | | className | String | | Optional class added to the parent element. | | children | Node | | The child elements rendered within the component. In the example above these are images, however they can be any type of element. |

Styling

This component uses the BEM methodology for CSS classNames — the block here being .marquee.

Reduced motion

Use the prefersReducedMotion prop to serve up a reduced motion experience for your users who have that option enabled on their systems. The boolean prefersReducedMotion prop can be derived via the browser's matchMedia API, if true the marquee defaults to a much slower speed, unless reducedMotionSpeed is passed. This workflow is demonstrated in the Usage section above.