Search results

Getting started with Angular Breadcrumb component

03 Dec 2021 / 4 minutes to read

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

Dependencies

The list of dependencies required to use the Breadcrumb 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-data
        |-- @syncfusion/ej2-lists
        |-- @syncfusion/ej2-inputs
        |-- @syncfusion/ej2-splitbuttons
        |-- @syncfusion/ej2-popups
            |-- @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

Installing Syncfusion Breadcrumb package

To install Breadcrumb package, use the following command.

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

The above package installs Breadcrumb dependencies which are required to render the component in the Angular environment.

Adding Breadcrumb module

Import Breadcrumb 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 Breadcrumb module from navigations package.
import { BreadcrumbModule } from '@syncfusion/ej2-angular-navigations';

import { AppComponent } from './app.component';

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

Adding Syncfusion Breadcrumb component

Modify the template in app.component.ts file with ejs-breadcrumb to render the Breadcrumb component.

Copied to clipboard
import { Component } from '@angular/core';
import { enableRipple } from '@syncfusion/ej2-base';

enableRipple(true);

@Component({
    selector: 'app-root',
    template: `<!-- To Render Breadcrumb. -->
            <ejs-breadcrumb [enableNavigation]="false"></ejs-breadcrumb>`
})

export class AppComponent {}

Adding CSS reference

Add Breadcrumb 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-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 Breadcrumb component.

Source
Preview
app.component.ts
app.module.ts
main.ts
Copied to clipboard
import { Component } from '@angular/core';
import { enableRipple } from '@syncfusion/ej2-base';

enableRipple(true);

@Component({
    selector: 'app-root',
    template: `<!-- To Render Breadcrumb. -->
            <ejs-breadcrumb [enableNavigation]="false"></ejs-breadcrumb>`
})

export class AppComponent {}
Copied to clipboard
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { BreadcrumbModule } from '@syncfusion/ej2-angular-navigations';

import { AppComponent } from './app.component';

@NgModule({
    imports: [BrowserModule, BreadcrumbModule],
    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);

This sample is hosted in different location, so the Breadcrumb Component is rendered with different location instead of the actual location.

Add Items to the Breadcrumb Component

Use BreadcrumbItemsDirective tag to bind items for Breadcrumb component. The below example demonstrates the basic rendering of Breadcrumb with items support.

Source
Preview
app.component.ts
app.module.ts
main.ts
Copied to clipboard
import { Component } from '@angular/core';
import { enableRipple } from '@syncfusion/ej2-base';

enableRipple(true);

@Component({
    selector: 'app-root',
    template: `<!-- To Render Breadcrumb with items. -->
            <ejs-breadcrumb [enableNavigation]="false">
                <e-breadcrumb-items>
                    <e-breadcrumb-item iconCss="e-icons e-home" url="https://ej2.syncfusion.com/home/angular.html"></e-breadcrumb-item>
                    <e-breadcrumb-item text="Components" url="https://ej2.syncfusion.com/angular/demos/#/material/grid/over-view"></e-breadcrumb-item>
                    <e-breadcrumb-item text="Navigations" url="https://ej2.syncfusion.com/angular/demos/#/material/breadcrumb/default"></e-breadcrumb-item>
                    <e-breadcrumb-item text="Breadcrumb" url="./breadcrumb/default"></e-breadcrumb-item>
                </e-breadcrumb-items>
            </ejs-breadcrumb>`
})

export class AppComponent {}
Copied to clipboard
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { BreadcrumbModule } from '@syncfusion/ej2-angular-navigations';

import { AppComponent } from './app.component';

@NgModule({
    imports: [BrowserModule, BreadcrumbModule],
    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);

Enable or Disable Navigation

This feature enables or disables the item navigation. By default, the navigation will be enabled when setting Url property. To prevent breadcrumb item navigation, set enableNavigation property as false in Breadcrumb. The below example shows enabling and disabling the navigation of Breadcrumb items.

Source
Preview
app.component.ts
app.module.ts
main.ts
index.css
Copied to clipboard
import { Component } from '@angular/core';
import { enableRipple } from '@syncfusion/ej2-base';

enableRipple(true);

@Component({
    selector: 'app-root',
    template: `<!-- To Render Breadcrumb with items. -->
        <div id="breadcrumb-control">
            <div class="header"><b>EnableNavigation - false</b></div><br />
            <ejs-breadcrumb [enableNavigation]='false'>
                <e-breadcrumb-items>
                    <e-breadcrumb-item iconCss= 'e-icons e-home' url= 'https://ej2.syncfusion.com/angular/demos/'>
                    </e-breadcrumb-item>
                    <e-breadcrumb-item text= 'Components' url= 'https://ej2.syncfusion.com/angular/demos/datagrid/overview'>
                    </e-breadcrumb-item>
                    <e-breadcrumb-item text= 'Navigations' url= 'https://ej2.syncfusion.com/angular/demos/menu/default'>
                    </e-breadcrumb-item>
                    <e-breadcrumb-item text= 'Breadcrumb' url= 'https://ej2.syncfusion.com/angular/demos/breadcrumb/default'>
                    </e-breadcrumb-item>
                </e-breadcrumb-items>
            </ejs-breadcrumb>
            <br />
            <br/>
            <div class="header"><b>EnableNavigation - true</b></div><br />
            <ejs-breadcrumb [enableNavigation]='true'>
                <e-breadcrumb-items>
                    <e-breadcrumb-item iconCss= 'e-icons e-home' url= 'https://ej2.syncfusion.com/angular/demos/'>
                    </e-breadcrumb-item>
                    <e-breadcrumb-item text= 'Components' url= 'https://ej2.syncfusion.com/angular/demos/datagrid/overview'>
                    </e-breadcrumb-item>
                    <e-breadcrumb-item text= 'Navigations' url= 'https://ej2.syncfusion.com/angular/demos/menu/default'>
                    </e-breadcrumb-item>
                    <e-breadcrumb-item text= 'Breadcrumb' url= 'https://ej2.syncfusion.com/angular/demos/breadcrumb/default'>
                    </e-breadcrumb-item>
                </e-breadcrumb-items>
            </ejs-breadcrumb>
        </div>`
})

export class AppComponent {}
Copied to clipboard
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { BreadcrumbModule } from '@syncfusion/ej2-angular-navigations';

import { AppComponent } from './app.component';

@NgModule({
    imports: [BrowserModule, BreadcrumbModule],
    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
#loader {
  color: #008cff;
  height: 40px;
  left: 45%;
  position: absolute;
  top: 45%;
}

body {
  margin-top: 100px;
  text-align: center;
}

#breadcrumb-control {
	margin-left: auto;
	margin-right: auto;
	width: 60%;
}

#breadcrumb-control .header {
	text-align: left;
	padding-left: 10px;
}

#breadcrumb-control .e-control.e-breadcrumb {
	text-align: left;
}