@magloft/material-carousel NPM

Material Carousel

Notice

This is a fork of gbrlsnchs/material2-carousel and has been upgraded for use with Angular 14. All credits go to gbrlsnchs and gabrielbusarello for their great work on creating and maintaining this component, and I have merely updated the repository to work with Angular 14.

About

This package is a carousel component for Angular using Material Design.

Installing

yarn add @magloft/material-carousel

Importing

//...
import { MatCarouselModule } from '@magloft/material-carousel';

@NgModule({
  // ...
  imports: [
    // ...
    MatCarouselModule.forRoot(),
    // ...
  ]
})
export class AppModule {}

Usage

`MatCarouselComponent`

import { MatCarousel, MatCarouselComponent } from '@magloft/material-carousel';

<mat-carousel>
  ...
</mat-carousel>

Attributes

Input	Type	Description	Default value
`timings`	`string`	Timings for slide animation.	`'250ms ease-in'`
`autoplay`	`boolean`	Enable automatic sliding.	`true`
`interval`	`number`	Autoplay's interval in milliseconds.	`5000`
`loop`	`boolean`	Enable loop through arrows.	`true`
`hideArrows`	`boolean`	Hide navigation arrows.	`true`
`hideIndicators`	`boolean`	Hide navigation indicators.	`true`
`color`	`ThemePalette`	Color palette from Material.	`'accent'`
`maxWidth`	`string`	Maximum width.	`'auto'`
`maintainAspectRatio`	`boolean`	If true, use `proportion` to determine height, else `slideHeight` is used.	`true`
`proportion`	`number`	Height proportion compared to width.	`25`
`slideHeight`	`string`	Explicit slide height. Used when maintainAspectRatio is false.	`'100%'`
`slides`	`number`	Maximum amount of displayed slides.
`useKeyboard`	`boolean`	Enable keyboard navigation.	`false`
`useMouseWheel`	`boolean`	Enable navigation through mouse wheeling.	`false`
`orientation`	`Orientation`	Orientation of the sliding panel.	`'ltr'`
`svgIconOverrides`	`SvgIconOverrides`	Override default carousel icons with registered SVG icons.
`pauseOnHover`	`boolean`	Override default pause on hover.	`true`

Output	Type	Description
`animationStart`	`number`	It emits the currentIndex when animation starts
`change`	`number`	It emtis the currentIndex when animation ends

Size Considerations and Recommendations

By default, maintainAspectRatio is true, which means height is controlled through proportion.

If you want to have a carousel with constant height (regardless of width), you must set maintainAspectRatio to false.

By default, slideHeight is set to 100%, which will not work if the parent element height isn't defined (i.e. relative heights do not work if the parent height is auto). In that case you could pass a valid css string for slideHeight. You can use any valid css height string like 100px or 25vh.

Play around with the docs to see how you can use this carousel with or without explicit parent height.

With parent elements that have height:auto

use proportion if you want a carousel that resizes responsively (this is the default configuration).
use maintainAspectRatio="false" and a non-percentage slideHeight if you want a fixed height carousel.
DO NOT use relative (%) values for slideHeight; the carousel will not render.

With parent elements that have a set height

use maintainAspectRatio="false" if you want a fixed height carousel that fills the parent element (slideHeight is 100% by default).
DO NOT use maintainAspectRatio="false" and slideHeight (unless slideHeight="100%"); the carousel will not render correctly because the buttons and indicators will be positioned with respect to the parent.
DO NOT use proportion; this will lead to gaps or unwanted overflow.

`MatCarouselSlideComponent`

import { MatCarouselSlide, MatCarouselSlideComponent } from '@magloft/material-carousel';

<mat-carousel>
  <mat-carousel-slide>
    ...
  </mat-carousel-slide>
</mat-carousel>

Attributes

Input	Type	Description	Default value
`image`	`string`	Image displayed in the slide.
`overlayColor`	`string`	Color of the slide's overlay.	`'#00000040'`
`hideOverlay`	`boolean`	Toggle overlay on/off.	`false`
`disabled`	`boolean`	Skip slide when navigating.	`false`