motion-swiper
TypeScript icon, indicating that this package has built-in type declarations

1.0.5 • Public • Published

MotionSwiper

Introducing MotionSwiper – a minimal draggable slider with a seamless and fluid bending motion effect like seen in this pen by Jesper Landberg.

It's built with GSAP and does not rely on WebGL/ThreeJs or Canvas, ensuring there are no drawbacks in terms of accessibility or performance.

Demo

View a live demo here: https://motion-swiper.vercel.app/

MotionSwiper in the wilds:

Getting started

MotionSwiper is created with GSAP so its installed with MotionSwiper if needed.

npm i motion-swiper

Import

// MotionSwiper functionality
import MotionSwiper from "motion-swiper";

// MotionSwiper styles
import "motion-swiper/css"; // or "motion-swiper/scss"

Initialize

Initialze the MotionSwiper class with a selector or an element as first parameter and a optional option object as second parameter.

The values in this example are the default values.

const motionSwiper = new MotionSwiper('.motion-swiper', {
    loop: true, // loop throug slides
    lerp: 0.1, // amout of lerp
    speed: 2.5, // speed of the swiper when sliding
    centered: true, // first slide is centered
    teasing: true, // move on scroll (needs "gsap/ScrollTrigger") 
    normalizingSpeed: 0.8, // how fast the slides go back to normal
    swipeOnClick: false, // swipe to slide when clicking it
});

Markup

<div class="motion-swiper">
    <div class="motion-swiper__wrapper">
        <div class="motion-swiper__slide">
            <div class="motion-swiper__inner">
                <!-- Content like images -->
            </div>
        </div>
        ...
    </div>
</div>

Styling

The .motion-swiper class comes with some css custom properties you can override to customize MotionSwiper.

.motion-swiper {
    --swiper-slide-spacing: 1.5vw;
    --swiper-height: 35vh;
    --swiper-slide-width: 40vw;
}

License

MIT License

Copyright (c) 2023 Joost Ramke

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Package Sidebar

Install

npm i motion-swiper

Weekly Downloads

3

Version

1.0.5

License

MIT

Unpacked Size

18.2 kB

Total Files

10

Last publish

Collaborators

  • jramke