Skip to content

Latest commit

 

History

History
113 lines (83 loc) · 7.81 KB

README.md

File metadata and controls

113 lines (83 loc) · 7.81 KB
Raw

React Scroll Snap Anime Slider

A simple slider/carousel using css style scroll-snap and Popmotion

Works natively on touchable devices

license ts npm


😀Demo


⭐ Features

Features Comment Status
Multiple slides per view Can adjust multiple slides per step ✔️
Customized DOM structure Construct the slider components by yourself ✔️
Customized slides margin Margin between each slide ✔️
Customized slide tray padding Offset slide tray to see prev/next slide ✔️
Touch scrolling Built-in ✔️
Scroll and snap Snap to slide's edge ✔️
Free scrolling ✔️
Scroll with touch pad Built-in ✔️
Scroll with keyboard < and > Built-in ✔️
Scroll with mouse drag Scroll end with inheria effect ✔️
Scroll with mouse wheel ❌
Navigation Buttons Support multiple clicks ✔️
Dynamic scrollbar ✔️
Dynamic & Customizable dot group Customize using renderDots() callback ✔️
Bounce on boundary Built-in on touchable devices 🔵
Responsive style Built-in ✔️
Customized Style Use class-name or style to override basic style ✔️
Inifinite scrolling ❌
Auto play Can implement it by using Slider ref ❌
Vertical scrolling Pending 🕒

😐 Motivation

The reason to start creating my own JS slider is because I couldn't find a slider that works smoothly on both desktop browser and mobile device. There are a ton of wonderfull sliders out there such as Swiper, Pure React Carousel and a lot, but they are not utilizing the native scrolling feature, and so not work natively on iOS browser (the animation not works smoothly).


🤔 Do I need this slider?

If you are looking for an animation effect of slider that works like those sliders you saw in some native Apps, you can try this one. However this slider has limitions such as it only provides sliding effect (no fade, swiping effects, for example). So, if you are looking for a powerful slider, you should other powerful library such as Swiper.


📌 Geting started

Install:

npm install react-scroll-snap-anime-slider

Create a simple slider:

import { ButtonBack, ButtonNext, Carousel, Slide, Slider, SliderBarLine } from "react-scroll-snap-anime-slider";

export function MySlider() {
    let total = 20;
    let visible = 3;
    let step = 3;

    return (
        <Carousel
            totalSlides={total}
            visibleSlides={visible}
            step={step}
        >
            <Slider>
                {new Array(total).fill(0).map((_, i) => {
                    return <Slide key={i}>
                        <div style={{ height: "100px", border: "1px solid #ccc", textAlign: "center" }}>slider# {i}</div>
                    </Slide>;
                })}
            </Slider>

            <SliderBarLine />

            <div style={{ textAlign: "center" }}>
                <ButtonBack>&lt;</ButtonBack>
                <ButtonNext>&gt;</ButtonNext>
            </div>

        </Carousel>
    );
}

📖 Documentation

You can learn more from here.


🐛 Bugs or 🙇 Requests

You can file an issue under the Issues page.