DEV Community

loading...
Cover image for Create beautiful carousels or Image Sliders on React with this framework

Create beautiful carousels or Image Sliders on React with this framework

Jaagrav
17 - Developing myself to become a better developer
・5 min read

Library used in this article:

GitHub logo Jaagrav / react-pretty-carousel

Easily add beautiful carousels to your website in no time!

React-Pretty-Carousel

Easily add beautiful carousels to your website in no time!

React Pretty Carousel

Check out the Demo on the docs website!

Installation

In order to install react-pretty-carousel, run this command in your terminal.

npm i react-pretty-carousel --save

Or

yarn add react-pretty-carousel

Usage

Usage

Props

Prop DataType Description
items integer Number of items to display at once
mode string Style of the carousel, can be either normal or gallery
showControls boolean Show the dots and navigation buttons if true, and otherwise if false

External Functions and Values

You can summon and move/navigate through the carousel by importing and using the following functions:

import {
  CarouselWrapper,
  prev,
  next,
  moveTo,
  switchTo,
  presentIndex,
} from "react-pretty-carousel";
Enter fullscreen mode Exit fullscreen mode
Function Description Parameters
prev() Move to the previous slide none
next() Move to the next slide none
moveTo(5) Move to a certain index/object with smooth animation integer
switchTo(5) Abruptly move to

Just like I do in my other articles, I am gonna leave the link to what we are about to develop this time, Check this out working live on the docs of the library.

Story

So recently I joined this organization called WebDevGoa where we have to develop this website that includes this interactive carousel that looks pretty awesome and at the same time it also is pretty complex. Now of course there are many other react frameworks that also provide carousels that are very interactive but the thing is there are way too ordinary. And the one that our designers at the organization wanted was pretty complex and none of us found a proper open-source library or framework that we exactly needed. And that's when it came to my mind that instead of wasting time in looking for a framework, why not make one by myself, right? And guess what, I definitely did.

How does it look?

Well too much talkie now let's showie what I made (yeah Idk why I wrote that)

Yeah exactly, so when you move the carousel, the size of the images also changes, just the way we wanted it to be like. Well I hope you're reading this article on your computer, no don't worry it is responsive and it definitely works on mobile phones, but to experience the real effect that is created on movement of the carousel is achieved better when you're using it on a computer. You can actually check it out working on a better scale here on the docs.

Check it out in full screen mode and then continue reading this article.

How to add it to my React Website?

Yep, I've got you covered on that as well, you can either watch this YouTube video to learn how to use this framework,

Or you can continue reading this article to read and learn how you can add it to your website in just 4 steps!

Step 1: Install react-pretty-carousel

Just copy and paste the command, depending on the package installer you use, in your bash or CMD and it will install the package:

npm i react-pretty-carousel --save
Enter fullscreen mode Exit fullscreen mode

OR

yarn add react-pretty-carousel
Enter fullscreen mode Exit fullscreen mode

Step 2: Import the package to your code

If you know react, even if you're a beginner, you probably know how to import a package but anyway just to make it easy for you, I am mentioning the code to import the package down below!

import { CarouselWrapper } from "react-pretty-carousel";
Enter fullscreen mode Exit fullscreen mode

Here's a list of stuff you can import from the package, you might need it once you want to control the carousel from custom buttons or programmatically.

import { CarouselWrapper, prev, next, moveTo, switchTo, presentIndex } from "react-pretty-carousel";
Enter fullscreen mode Exit fullscreen mode

Step 3: Add the Carousel Component to your JSX code

Finally, add this carousel to your react JSX code, if you just want to do this in order to test the framework locally on your machine, you can simply copy and paste all the code that I have written here, although you can check it out working on the docs.

So this is what I wrote in App.js

<CarouselWrapper items={3} mode="gallery">
   <div className="image image1"></div>
   <div className="image image2"></div>
   <div className="image image3"></div>
   <div className="image image4"></div>
   <div className="image image5"></div>
   <div className="image image6"></div>
</CarouselWrapper>
Enter fullscreen mode Exit fullscreen mode

Yeah don't be confused by the code I wrote, I just want to add the image as background to these divs, I know it would make our work more complicated but just to resize the images properly, I am using this method.

And then I wrote this in index.css

body {
  background: rgb(15, 34, 68);
}

.App {
  font-family: sans-serif;
  text-align: center;
}

.image {
  height: 20pc;
  width: 100%;
  border-radius: 10px;
}

.image.image1 {
  background: url("https://react-pretty-carousel.herokuapp.com/static/media/photo-1.da31d5ae.jfif");
  background-size: cover;
}
.image.image2 {
  background: url("https://react-pretty-carousel.herokuapp.com/static/media/photo-2.6932e41c.jfif");
  background-size: cover;
}
.image.image3 {
  background: url("https://react-pretty-carousel.herokuapp.com/static/media/photo-3.3cf50746.jfif");
  background-size: cover;
}
.image.image4 {
  background: url("https://react-pretty-carousel.herokuapp.com/static/media/photo-4.e7eeb637.jfif");
  background-size: cover;
}
.image.image5 {
  background: url("https://react-pretty-carousel.herokuapp.com/static/media/photo-5.903bd4b4.jfif");
  background-size: cover;
}
.image.image6 {
  background: url("https://react-pretty-carousel.herokuapp.com/static/media/photo-6.402110ff.jfif");
  background-size: cover;
}
Enter fullscreen mode Exit fullscreen mode

Here I am just assigning a specific image to each div and then setting it's background-size to cover so that the image's width would be set to the div's width automatically.

If you need the whole code, with the files and everything literally then visit this sandbox on CodeSandbox

Step 4: Voila!

That's it, yeah literally, that's how easy it was to add this beautiful carousel to your website! You can now simply run the code using npm run start or yarn start and see the carousel added to your website. You can use this framework to show image sliders and testimonials that most portfolios have these days, it will look epic on your website!

Now again the whole code of whatever I taught you until now is available right here.

How do I contribute?

Oh so you're one of those people who love contributing huh? Well you can simply then contribute by visiting the Github repo!

GitHub logo Jaagrav / react-pretty-carousel

Easily add beautiful carousels to your website in no time!

React-Pretty-Carousel

Easily add beautiful carousels to your website in no time!

React Pretty Carousel

Check out the Demo on the docs website!

Installation

In order to install react-pretty-carousel, run this command in your terminal.

npm i react-pretty-carousel --save

Or

yarn add react-pretty-carousel

Usage

Usage

Props

Prop DataType Description
items integer Number of items to display at once
mode string Style of the carousel, can be either normal or gallery
showControls boolean Show the dots and navigation buttons if true, and otherwise if false

External Functions and Values

You can summon and move/navigate through the carousel by importing and using the following functions:

import {
  CarouselWrapper,
  prev,
  next,
  moveTo,
  switchTo,
  presentIndex,
} from "react-pretty-carousel";
Enter fullscreen mode Exit fullscreen mode
Function Description Parameters
prev() Move to the previous slide none
next() Move to the next slide none
moveTo(5) Move to a certain index/object with smooth animation integer
switchTo(5) Abruptly move to

You can star the repo of course and if you face any issues or problems, you can simply create an issue or make a PR in order to contribute.

Is there a video tutorial?

Yeah definitely there is, I always make video tutorials so users and developers both understand how to use what I made,

Do check it out and let me know if you liked the carousel or not! If you did, did you end up adding it to your project?

Conclusion

Now to be honest, creating react-pretty-carousel wasn't actually as easy as I anticipated before finally starting to work on it, it took me about two hours to get to the point where I could make the normal carousel by dragging it with the help of my pointer, I also tried my best to not break any React rules which thankfully I didn't but in the end it all works! And that's what matters the most, right? 😂

I really look forward to what you create with this carousel and how you implement it to your website, I am actually pretty curious to find out, feel frr to DM me on Twitter in case of any issues that you might face, I am there to help you, 87% of the time.

Stay tuned because in my next article I'll be creating something with an arduino, with which you'll be able to control your TV with your feet, here's a sneak peek!

Discussion (0)

Forem Open with the Forem app