Nuxt Marquee

A lightweight Nuxt 3 component that harnesses the power of CSS animations to create silky smooth marquees.

Installation

# if you're using npm
npm i -D nuxt-marquee

# if you're using yarn
yarn add -D nuxt-marquee

# if you're using pnpm
pnpm i -D nuxt-marquee

Usage

To use this module, add it to the modules section of your nuxt.config.ts file.

export default defineNuxtConfig({
  // ..
  modules: ["nuxt-marquee"],
});

Example

<template>
  <NuxtMarquee>
    <MyComponent />
    <MyComponent />
    <MyComponent />
  </NuxtMarquee>
</template>

Props

PropertyTypeDefaultDescriptionstyleCSSProperties{}Inline style for the container divclassany""Name of the css class to style the container divautoFillbooleanfalseWhether to automatically fill blank space in the marquee with copies of the children or notplaybooleantrueWhether to play or pause the marqueepauseOnHoverbooleanfalseWhether to pause the marquee when hoveredpauseOnClickbooleanfalseWhether to pause the marquee when clickeddirection"left" | "right"| "up"| "down""left"The direction the marquee slides Warning: Vertical marquees are currently experimental and may be buggy. Please swap the values of the marquee’s height and width when setting themspeednumber50Speed calculated as pixels/seconddelaynumber0Duration to delay the animation after render, in secondsloopnumber0The number of times the marquee should loop, 0 is equivalent to infinitegradientbooleanfalseWhether to show the gradient or notgradientColorstringwhiteThe color of the gradientgradientWidthnumber | string200The width of the gradient on either side

Events

Event NameDescriptionfinishEmitted when the marquee finishes scrolling and stops. Only calls if loop is non-zero.cycleCompleteEmitted when the marquee finishes a loop. Does not call if maximum loops are reached (use onFinish instead).

GitHub

View Github