Socket
Socket
Sign inDemoInstall

angular-responsive-carousel

Package Overview
Dependencies
5
Maintainers
1
Versions
22
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

angular-responsive-carousel

Carousel for Angular. A simple solution for horizontal scrolling images with lazy loading.


Version published
Maintainers
1
Weekly downloads
6,735
decreased by-6.94%

Weekly downloads

Readme

Source

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

nametypedefaultdescription
heightnumberCarousel height.
widthnumberCarousel Width.
cellWidthnumber, '100%'200Cell width.
cellsToShownumberThe number of cells to display, regardless of the width of the container.
cellsToScrollnumber1The number of carousel cells to scroll per arrow click.
loopbooleanfalseInfinite loop.
lightDOMbooleanfalseKeep a limited number of cells in the DOM tree for an unlimited number of images. As the carousel scrolls, the images will be lazy loaded. This allows you not to overload the browser memory. This mode works only with images passed as an array.
overflowCellsLimitnumber3The number of carousel cells that will be stored for in the DOM tree outside the scope.
freeScrollbooleanfalseThe carousel will stop where the touch ended and will not automatically align.
autoplaybooleanfalseAutomatically start the carousel after initialization.
autoplayIntervalnumber5000The interval between scrolling the carousel. Used together with autoplay.
pauseOnHoverbooleantrueStops autoplay if the cursor is over the carousel area.
dotsbooleanfalseCarousel progress bar.
marginnumber10Cell spacing.
minSwipeDistancenumber10Minimum distance for swipe.
transitionDurationnumber300Animation duration.
transitionTimingFunction'ease', 'ease-in', 'ease-out', 'ease-in-out', 'linear''ease-in-out'Smooth animation function.
counterbooleanfalseCounter.
counterSeparatorstring" / "Counter separator.
borderRadiusnumber0Border radius for carousel cells.
arrowsbooleantrueArrows for image navigation.
arrowsOutsidebooleanfalseArrows 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.

Author services

Are you interested in this library but lacks features? Write to the author, he can do it for you.

Roadmap

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.

Keywords

FAQs

Last updated on 06 Jul 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc