Skip to content

darkroomengineering/tempus

Repository files navigation

Tempus

TEMPUS

A lightweight, high-performance animation frame manager for JavaScript applications.

Features

  • 🚀 Merge multiple requestAnimationFrame loops for better performance
  • 🎯 Control execution priority of different animations
  • ⚡ Support for custom frame rates (FPS)
  • 🔄 Compatible with popular animation libraries
  • 🪶 Zero dependencies
  • 📦 ~1KB gzipped

Installation

npm install tempus

Basic Usage

import Tempus from tempus

// Simple animation at maximum FPS
const animate = (time, deltaTime) => {
  // Animation code here
}

Tempus.add(animate)

Cleanup

const unsubscribe = Tempus.add(animate)

unsubscribe()

Advanced Usage

Custom Frame Rates

// Run at specific FPS
Tempus.add(animate, { 
  fps: 30 // Will run at 30 FPS
})

Priority System

// Higher priority (runs first)
Tempus.add(criticalAnimation, { priority: -1 })

// Lower priority (runs after)
Tempus.add(secondaryAnimation)

Global RAF Patching

// Patch native requestAnimationFrame
Tempus.patch()

// Now regular requestAnimationFrame calls will use Tempus
requestAnimationFrame(animate, { 
  priority: 0,
  fps: 60 
})

Integration Examples

With Lenis Smooth Scroll

Tempus.add((time) => {
  lenis.raf(time)
})

With GSAP

// Remove GSAP's internal RAF
gsap.ticker.remove(gsap.updateRoot)

// Add to Tempus
Tempus.add((time) => {
  gsap.updateRoot(time / 1000)
})

With Three.js

Tempus.add((time) => {
  renderer.render(scene, camera)
}, { priority: 1 })

API Reference

Tempus.add(callback, options)

Adds an animation callback to the loop.

  • callback: (time: number, deltaTime: number) => void
  • options:
    • priority: number (default: 0) - Lower numbers run first
    • fps: number (default: Infinity) - Target frame rate
  • Returns: () => void - Unsubscribe function

Tempus.patch()

Patches the native requestAnimationFrame to use Tempus.

Best Practices

  • Use priorities wisely: critical animations (like scroll) should have higher priority
  • Clean up animations when they're no longer needed
  • Consider using specific FPS for non-critical animations to improve performance
  • Always handle cleanup in component unmount/destroy methods

License

MIT © Darkroom Engineering

Shoutout

Thank you to Keith Cirkel for having transfered us the npm package name 🙏.

About

Use only one requestAnimationFrame for your whole app

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •