Search results

Getting started with Angular Carousel component

30 Sep 2022 / 4 minutes to read

This section explains how to create a simple Angular Carousel, and demonstrate the basic usage of the Carousel module in an Angular environment.

Dependencies

The list of dependencies required to use the Carousel module in your application is given below:

Copied to clipboard
|-- @syncfusion/ej2-angular-navigations
    |-- @syncfusion/ej2-angular-base
    |-- @syncfusion/ej2-navigations
        |-- @syncfusion/ej2-base
        |-- @syncfusion/ej2-buttons

Setup Angular environment

You can use Angular CLI to setup your Angular applications. To install Angular CLI use the following command.

Copied to clipboard
npm install -g @angular/cli

Create an Angular application

Start a new Angular application using below Angular CLI command.

Copied to clipboard
ng new my-app
cd my-app

Syncfusion packages are distributed in npm as @syncfusion scoped packages. You can get all the Angular Syncfusion package from npm link.

Currently, Syncfusion provides two types of package structures for Angular components,

  1. Ivy library distribution package format
  2. Angular compatibility compiler(Angular’s legacy compilation and rendering pipeline) package.

Ivy library distribution package

Syncfusion Angular packages(>=20.2.36) has been moved to the Ivy distribution to support the Angular Ivy rendering engine and the package are compatible with Angular version 12 and above. To download the package use the below command.

Add @syncfusion/ej2-angular-navigations package to the application.

Copied to clipboard
npm install @syncfusion/ej2-angular-navigations --save

Angular compatibility compiled package(ngcc)

For Angular version below 12, you can use the legacy (ngcc) package of the Syncfusion Angular components. To download the ngcc package use the below.

Add @syncfusion/ej2-angular-navigations@ngcc package to the application.

Copied to clipboard
npm install @syncfusion/ej2-angular-navigations@ngcc --save

To mention the ngcc package in the package.json file, add the suffix -ngcc with the package version as below.

Copied to clipboard
@syncfusion/ej2-angular-navigations:"20.2.38-ngcc"

Note: If the ngcc tag is not specified while installing the package, the Ivy Library Package will be installed and this package will throw a warning.

Import Carousel module into Angular application(app.module.ts) from the package @syncfusion/ej2-angular-navigations.

Copied to clipboard
import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";
// Imported Syncfusion Carousel module from navigations package.
import { CarouselModule } from "@syncfusion/ej2-angular-navigations";
import { AppComponent } from "./app.component";

@NgModule({
  imports: [BrowserModule, CarouselModule], // Registering EJ2 Carousel Module.
  declarations: [AppComponent],
  bootstrap: [AppComponent],
})
export class AppModule {}

Modify the template in app.component.ts file with ejs-carousel to render the Carousel component.

Copied to clipboard
import { Component } from "@angular/core";

@Component({
  selector: "app-root",
  template: `<!-- To Render Carousel. -->
<div class="control-container">
  <ejs-carousel>
    <e-carousel-items>
      <e-carousel-item>
        <ng-template #template>
          <figure class="img-container">
            <img src="https://ej2.syncfusion.com/products/images/carousel/cardinal.png" alt="cardinal" style="height:100%;width:100%;" />
            <figcaption class="img-caption">Cardinal</figcaption>
          </figure>
        </ng-template>
      </e-carousel-item>
      <e-carousel-item>
        <ng-template #template>
          <figure class="img-container">
            <img src="https://ej2.syncfusion.com/products/images/carousel/hunei.png" alt="kingfisher" style="height:100%;width:100%;" />
            <figcaption class="img-caption">Kingfisher</figcaption>
          </figure>
        </ng-template>
      </e-carousel-item>
      <e-carousel-item>
        <ng-template #template>
          <figure class="img-container">
            <img src="https://ej2.syncfusion.com/products/images/carousel/costa-rica.png" alt="keel-billed-toucan" style="height:100%;width:100%;" />
            <figcaption class="img-caption">Keel-billed-toucan</figcaption>
          </figure>
        </ng-template>
      </e-carousel-item>
      <e-carousel-item>
        <ng-template #template>
          <figure class="img-container">
            <img src="https://ej2.syncfusion.com/products/images/carousel/kaohsiung.png" alt="yellow-warbler" style="height:100%;width:100%;" />
            <figcaption class="img-caption">Yellow-warbler</figcaption>
          </figure>
        </ng-template>
      </e-carousel-item>
      <e-carousel-item>
        <ng-template #template>
          <figure class="img-container">
            <img src="https://ej2.syncfusion.com/products/images/carousel/bee-eater.png" alt="bee-eater" style="height:100%;width:100%;" />
            <figcaption class="img-caption">Bee-eater</figcaption>
          </figure>
        </ng-template>
      </e-carousel-item>
    </e-carousel-items>
  </ejs-carousel>
</div>`,
})
export class AppComponent {}

Adding CSS reference

Add Carousel component’s styles as given below in style.css.

Copied to clipboard
@import "../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../node_modules/@syncfusion/ej2-buttons/styles/material.css";
@import "../node_modules/@syncfusion/ej2-navigations/styles/material.css";

Running the application

Run the application in the browser using the following command:

Copied to clipboard
ng serve

The following example shows a basic Carousel component.

Source
Preview
app.component.ts
app.module.ts
main.ts
index.css
Copied to clipboard
import { Component } from "@angular/core";

@Component({
  selector: "app-root",
  template: `<!-- To Render Carousel. -->
<div class="control-container">
  <ejs-carousel>
    <e-carousel-items>
      <e-carousel-item>
        <ng-template #template>
          <figure class="img-container">
            <img src="https://ej2.syncfusion.com/products/images/carousel/cardinal.png" alt="cardinal" style="height:100%;width:100%;" />
            <figcaption class="img-caption">Cardinal</figcaption>
          </figure>
        </ng-template>
      </e-carousel-item>
      <e-carousel-item>
        <ng-template #template>
          <figure class="img-container">
            <img src="https://ej2.syncfusion.com/products/images/carousel/hunei.png" alt="kingfisher" style="height:100%;width:100%;" />
            <figcaption class="img-caption">Kingfisher</figcaption>
          </figure>
        </ng-template>
      </e-carousel-item>
      <e-carousel-item>
        <ng-template #template>
          <figure class="img-container">
            <img src="https://ej2.syncfusion.com/products/images/carousel/costa-rica.png" alt="keel-billed-toucan" style="height:100%;width:100%;" />
            <figcaption class="img-caption">Keel-billed-toucan</figcaption>
          </figure>
        </ng-template>
      </e-carousel-item>
      <e-carousel-item>
        <ng-template #template>
          <figure class="img-container">
            <img src="https://ej2.syncfusion.com/products/images/carousel/kaohsiung.png" alt="yellow-warbler" style="height:100%;width:100%;" />
            <figcaption class="img-caption">Yellow-warbler</figcaption>
          </figure>
        </ng-template>
      </e-carousel-item>
      <e-carousel-item>
        <ng-template #template>
          <figure class="img-container">
            <img src="https://ej2.syncfusion.com/products/images/carousel/bee-eater.png" alt="bee-eater" style="height:100%;width:100%;" />
            <figcaption class="img-caption">Bee-eater</figcaption>
          </figure>
        </ng-template>
      </e-carousel-item>
    </e-carousel-items>
  </ejs-carousel>
</div>`,
})
export class AppComponent {}
Copied to clipboard
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { CarouselModule } from '@syncfusion/ej2-angular-navigations';
import { AppComponent } from './app.component';

@NgModule({
    imports: [BrowserModule, CarouselModule],
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }
Copied to clipboard
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { enableProdMode } from '@angular/core';
import { AppModule } from './app.module';

enableProdMode();
platformBrowserDynamic().bootstrapModule(AppModule);
Copied to clipboard
.control-container {
  height: 360px;
  margin: 0 auto;
  width: 600px;
}

.img-container {
  height: 100%;
  margin: 0;
}

.img-caption {
  color: #fff;
  font-size: 1rem;
  position: absolute;
  bottom: 3rem;
  width: 100%;
  text-align: center;
}

N> You can also explore our Angular Carousel example that shows you how to configure the Carousel in Angular.