@magic-spells/scrolling-content v0.1.1

Scrolling Content Web Component

A lightweight, performant Web Component for creating smooth infinite scrolling content. Perfect for displaying logos, announcements, testimonials, or any content that needs to scroll continuously across the screen.

Live Demo

Features

• No dependencies
• Lightweight and performant
• Smooth animations that adapt to device refresh rates
• Infinite loop with automatic content duplication
• Interactive hover-to-pause and drag-to-scroll
• Responsive speed settings for mobile and desktop
• Customizable gap spacing with CSS variables
• Touch-friendly on mobile devices

Installation

npm install @magic-spells/scrolling-content

// Add to your JavaScript file
import '@magic-spells/scrolling-content';

Or include directly in your HTML:

<script src="https://unpkg.com/@magic-spells/scrolling-content"></script>

Usage

<scrolling-content data-mobile-speed="40" data-desktop-speed="60">
  <scrolling-track>
    <div>🚀 Web Components</div>
    <div>⚡ Lightning Fast</div>
    <div>🎨 Fully Customizable</div>
    <div>📱 Mobile Friendly</div>
    <!-- Component automatically wraps content and duplicates it -->
  </scrolling-track>
</scrolling-content>

<!-- Control gap with CSS -->
<style>
  scrolling-content {
    --scrolling-content-gap: 1rem;
  }
</style>

How It Works

• Content is wrapped in <scrolling-item> and is duplicated until it fills at least 200% of the container width.
• The component automatically starts scrolling when loaded.
• The track smoothly scrolls left, creating an infinite loop by resetting position when one full cycle completes.
• Hovering over the content pauses the animation.
• You can drag the content to manually scroll (touch-friendly on mobile).
• Different speeds can be set for mobile and desktop devices with a customizable breakpoint.

Configuration

The scrolling content can be configured using the following attributes:

Track Configuration

Example:

<!-- Fast scrolling with custom breakpoint -->
<scrolling-content data-mobile-speed="60" data-desktop-speed="100" data-breakpoint="1024">
  <scrolling-track data-gap="30">
    <div>Fast scrolling content</div>
  </scrolling-track>
</scrolling-content>

<!-- Slow, gentle scrolling -->
<scrolling-content data-mobile-speed="20" data-desktop-speed="30">
  <scrolling-track>
    <div>Slow scrolling content</div>
  </scrolling-track>
</scrolling-content>

Customization

Styling

The component provides full styling flexibility. Style the content elements however you like:

/* Control gap between items */
scrolling-content {
  --scrolling-content-gap: 2rem;
}

/* Style your content items */
scrolling-track div {
  background: #667eea;
  color: white;
  padding: 1rem 2rem;
  border-radius: 8px;
  font-weight: 500;
}

/* Different themes for different instances */
.logo-carousel {
  --scrolling-content-gap: 3rem;
}

.logo-carousel scrolling-track div {
  background: white;
  border: 2px solid #e0e0e0;
  color: #333;
  font-weight: 600;
}

CSS Variables

Example:

/* Global gap setting */
:root {
  --scrolling-content-gap: 1.5rem;
}

/* Per-instance gap setting */
.tight-spacing {
  --scrolling-content-gap: 0.5rem;
}

.wide-spacing {
  --scrolling-content-gap: 3rem;
}

JavaScript API

Methods

• start(): Starts the scrolling animation (automatically called on load).
• stop(): Stops the scrolling animation.

Interaction Events

The component automatically handles:

• Hover: Pauses animation when mouse enters, resumes when mouse leaves
• Drag: Click and drag to manually scroll the content
• Touch: Touch-friendly dragging on mobile devices
• Resize: Automatically recalculates content duplication on window resize

Programmatic Control

const scrollingContent = document.querySelector('scrolling-content');

// Stop the animation
scrollingContent.stop();

// Start the animation
scrollingContent.start();

// Change speed dynamically
scrollingContent.setAttribute('data-desktop-speed', '80');

Performance

The component uses:

• requestAnimationFrame for smooth animations that adapt to device refresh rates
• CSS transform for hardware-accelerated scrolling
• Efficient content duplication that only runs when needed
• Automatic cleanup of event listeners

Browser Support

This component works in all modern browsers that support Web Components.

License

MIT