pietile-carousel
TypeScript icon, indicating that this package has built-in type declarations

3.2.0 • Public • Published

Pietile Carousel

npm version minzipped bundle size

React carousel based on Framer Motion without repaints and simple in use.

Features

  • Doesn't require to specify items dimensions (pure css solution)
  • Relies on translates for movements (zero paints)
  • Arbitrary number of visible items
  • Сyclicality

Installation

Using yarn

yarn add pietile-carousel

or using npm

npm install -S pietile-carousel

Pietile Carousel depends on Framer Motion which is a peer dependency so be sure that it's installed in you project (if not then install it using yarn add framer-motion or npm install -S framer-motion)

Usage

Every item is wrapped in container where it can layout it's content. The size of container depends on the size of carousel and amount of visible items. You can use any styling system you want to set styles. Get ref and use moveLeft/moveRight/moveTo methods for scroll.

Example

import React from 'react';

import { PietileCarousel } from 'pietile-carousel';

function App() {
  const carouselStyle = {
    width: 150,
    height: 100,
  };

  const itemStyle = {
    width: '100%',
    height: '100%',
  };

  return (
    <PietileCarousel style={carouselStyle}>
      <div style={{ ...itemStyle, backgroundColor: 'red' }} />
      <div style={{ ...itemStyle, backgroundColor: 'orange' }} />
      <div style={{ ...itemStyle, backgroundColor: 'yellow' }} />
    </PietileCarousel>
  );
}

API

Properties

name description type default
autoplayInterval How often autoplay happens (0 to disable) number 0
children Components rendered in carousel (required) Node -
className CSS class string -
count Amount of visible items number 1
draggable Allow drag boolean true
margin Margin between items number 0
style Style object Object -
onChange Callback when index changes Function -

Methods

name description
slideNext() Scroll to next slide
slidePrev() Scroll to previous slide
slideTo(index) Scroll to index

Note

Carousel protects nesting links (a-tag's) from undesirable behavior (link click is being processed when the user starts dragging and release the mouse outside of the carousel) by calling preventDefault for the correspondent click event. If you are handling clicks manually you can check defaultPrevented when processing your event.

License

Pietile Carousel is MIT License.

Readme

Keywords

Package Sidebar

Install

npm i pietile-carousel

Weekly Downloads

282

Version

3.2.0

License

MIT

Unpacked Size

49.8 kB

Total Files

17

Last publish

Collaborators

  • vshab