erikalmaraz / angular-carousel

A simple solution for horizontal scrolling images with lazy loading

Carousel for Angular

A simple solution for horizontal scrolling images with lazy loading.

Live demo can be found on home page.

🔬️ Help make IvyCarousel better by answering a few questions.

Installation

Install the npm package.

  npm i angular-responsive-carousel

Import module:

  import {IvyCarouselModule} from 'angular-responsive-carousel';

  @NgModule({
      imports: [IvyCarouselModule]
  })

Usage

Put the contents of your cells in containers with the carousel-cell class.

<carousel>
    <div class="carousel-cell">
        <img src="path_to_image">
    </div>
    <div class="carousel-cell">
        ...
</carousel>

Or prepare an image array for the carousel. If necessary, specify in the settings the sizes of the cells and the carousel container. And also select the method of arranging images inside the cells using the objectFit property.

<carousel
    [images]="images">
</carousel>

images = [
    {path: 'PATH_TO_IMAGE'},
    ...
]

Lazy loading

To use lazy loading, pass the carousel an array of images, as shown in the example above. Images will be uploaded only as needed, this will save you traffic. Using the overflowCellsLimit property, you can specify the number of images that will be loaded outside the visible area, which will allow the images to be loaded before they are displayed.

Properties

name	type	default	description
height	number		Carousel height.
width	number		Carousel Width.
cellWidth	number, '100%'	200	Cell width.
loop	boolean	false	Infinite loop.
autoplay	boolean	false	Automatically start the carousel after initialization.
autoplayInterval	number	5000	The interval between scrolling the carousel. Used together with autoplay.
pauseOnHover	boolean	true	Stops autoplay if the cursor is over the carousel area.
dots	boolean	false	Carousel progress bar.
overflowCellsLimit	number	3	The number of carousel cells that will be stored for in the DOM tree outside the scope.
margin	number	10	Cell spacing.
minSwipeDistance	number	50	Minimum distance for swipe.
transitionDuration	number	200	Animation duration.
transitionTimingFunction	'ease', 'ease-in', 'ease-out', 'ease-in-out', 'linear'	'ease'	Smooth animation function.
counter	boolean	false	Counter.
counterSeparator	string	" / "	Counter separator.
borderRadius	number	0	Border radius for carousel cells.
arrows	boolean	true	Arrows for image navigation.
arrowsOutside	boolean	false	Arrows on the outside of the carousel container.
arrowsTheme	'light', 'dark'	'light'	Arrow color theme.

The IvyCarousel also has a Pro version, with an extended API.

Browser support

IvyCarousel supports the most recent two versions of all major browsers: Chrome (including Android 4.4-10), Firefox, Safari (including iOS 9-13), and Edge.

Roadmap

slidesToShow - the number of cells to display, regardless of the width of the container.

centerMode - center the cells inside the container (Pro version).

fade - fade in and fade out animation.

adaptiveHeight - the height of the container is set based on the height of the tallest cell currently visible.

groupCells - the cells will behave as grouped, the group will include the number of visible cells that fit into the container area.