bicabenedicto / carousel-circle-animation

This library create carousel animation with circle effect.

Carousel Circle Animation

This library create carousel animation with circle effect.

Tech Stack

Front-end: React, Sass

Installation

Install carousel-circle-animation with npm

  npm install carousel-circle-animation
  cd carousel-circle-animation

To use this library, needs config in root folder the sizes and quantify.

1. Create in root the file carousel-animation.config.scss.

// carousel-animation.config.scss

$length: 28; // Length of array used is very recommended
$quantity-small: 10; // Quantity go be show in small screen
$size-small: 0.1; // Size of items in small screen

$quantity-medium: 10; // Quantity go be show in medium screen
$size-medium: 0.3; // Size of items in medium screen

$quantity-big: 30; // Quantity go be show in big screen
$size-big: 0.03; // Size of items in big screen

$screen-medium: 'min-width: 600px'; // Config of start medium screen
$screen-big: 'min-width: 1000px'; // Config of start big screen

$height: 100px; // Recommended height of your items

Now you can copy this config in file and edit! :D

Usage/Examples

// Import component
import CarouselAnimation from 'carousel-circle-animation'

const data = [<div>Item 1</div>, <div>Item 2</div>];

function App() {
  return <CarouselAnimation data={ data } />
}

Feedback

If you have any feedback, please reach out to us at [email protected]

Contributing

Contributions are always welcome!

Fork the project, do with you wanne upgrade, change or refactor, open PR with the description the changes ^^

License

MIT

Authors

Gabriel Benedicto