Images Slider
A full page slider with images that can be navigated with the keyboard.
Installation
Install dependencies
npm i framer-motion clsx tailwind-merge
Add util file
lib/utils.ts
import { ClassValue, clsx } from "clsx";
import { twMerge } from "tailwind-merge";
export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs));
}
Copy the source code
components/ui/images-slider.tsx
"use client";
import { cn } from "@/lib/utils";
import { motion, AnimatePresence } from "framer-motion";
import React, { useEffect, useState } from "react";
export const ImagesSlider = ({
images,
children,
overlay = true,
overlayClassName,
className,
autoplay = true,
direction = "up",
}: {
images: string[];
children: React.ReactNode;
overlay?: React.ReactNode;
overlayClassName?: string;
className?: string;
autoplay?: boolean;
direction?: "up" | "down";
}) => {
const [currentIndex, setCurrentIndex] = useState(0);
const [loading, setLoading] = useState(false);
const [loadedImages, setLoadedImages] = useState<string[]>([]);
const handleNext = () => {
setCurrentIndex((prevIndex) =>
prevIndex + 1 === images.length ? 0 : prevIndex + 1
);
};
const handlePrevious = () => {
setCurrentIndex((prevIndex) =>
prevIndex - 1 < 0 ? images.length - 1 : prevIndex - 1
);
};
useEffect(() => {
loadImages();
}, []);
const loadImages = () => {
setLoading(true);
const loadPromises = images.map((image) => {
return new Promise((resolve, reject) => {
const img = new Image();
img.src = image;
img.onload = () => resolve(image);
img.onerror = reject;
});
});
Promise.all(loadPromises)
.then((loadedImages) => {
setLoadedImages(loadedImages as string[]);
setLoading(false);
})
.catch((error) => console.error("Failed to load images", error));
};
useEffect(() => {
const handleKeyDown = (event: KeyboardEvent) => {
if (event.key === "ArrowRight") {
handleNext();
} else if (event.key === "ArrowLeft") {
handlePrevious();
}
};
window.addEventListener("keydown", handleKeyDown);
// autoplay
let interval: any;
if (autoplay) {
interval = setInterval(() => {
handleNext();
}, 5000);
}
return () => {
window.removeEventListener("keydown", handleKeyDown);
clearInterval(interval);
};
}, []);
const slideVariants = {
initial: {
scale: 0,
opacity: 0,
rotateX: 45,
},
visible: {
scale: 1,
rotateX: 0,
opacity: 1,
transition: {
duration: 0.5,
ease: [0.645, 0.045, 0.355, 1.0],
},
},
upExit: {
opacity: 1,
y: "-150%",
transition: {
duration: 1,
},
},
downExit: {
opacity: 1,
y: "150%",
transition: {
duration: 1,
},
},
};
const areImagesLoaded = loadedImages.length > 0;
return (
<div
className={cn(
"overflow-hidden h-full w-full relative flex items-center justify-center",
className
)}
style={{
perspective: "1000px",
}}
>
{areImagesLoaded && children}
{areImagesLoaded && overlay && (
<div
className={cn("absolute inset-0 bg-black/60 z-40", overlayClassName)}
/>
)}
{areImagesLoaded && (
<AnimatePresence>
<motion.img
key={currentIndex}
src={loadedImages[currentIndex]}
initial="initial"
animate="visible"
exit={direction === "up" ? "upExit" : "downExit"}
variants={slideVariants}
className="image h-full w-full absolute inset-0 object-cover object-center"
/>
</AnimatePresence>
)}
</div>
);
};
Props
Prop | Type | Default | Description |
---|---|---|---|
images | string[] | - | An array of image URLs to be displayed in the slider. |
children | React.ReactNode | - | Any React nodes that will be rendered inside the slider. |
overlay | React.ReactNode | true | If true, an overlay will be displayed on the images. |
overlayClassName | string | - | The CSS class name to be applied to the overlay. |
className | string | - | The CSS class name to be applied to the slider. |
autoplay | boolean | true | If true, the slider will automatically move to the next image every 5 seconds. |
direction | "up" | "down" | "up" | The direction of the transition when changing images. |