Skip to main content

Create Custom Element Angular 6 - Step by Step with Example

Step by Step for Creating First Angular Element with Example -

What's Angular Elements?
Angular Element is a package which is part of the Angular framework- @angular/elements and it was introduced in Angular 6 and hopefully, this will improve with Angular 7 or higher versions.

Angular Elements was the brainchild of Angular’s and it one of the most anticipated features of Angular 6 release.  Explore in detail about Angular Elements …

Now come to – “How to Create a Custom Angular Elements?”

There are following steps involving to Creating Custom Elements.
1.       Install Angular 6 platforms and Angular CLI, if not installed.
2.      Create a new project using Angular CLI.
3.      Once successfully created your new project, change the directory of your created.
4.      Install Angular elements.
5.      Install web components custom elements.
6.      Create your reusable component and it will be used as an Angular Element.
7.      Register your comments which are required like reusable components, Injector, and createCustomElement.
8.      Use the created custom element in your app.
9.      Result

Steps 1 - Install Angular 6, if not install.
Steps 2 – Create a new project using Angular CLI

ng new ngprod
In the above command, the “ngprod” is the name of my project which I used to create this demo.

Steps 3 - Once successfully created your new project, change the directory of your created project just like - ngprod.

Steps 4 - Now install Angular elements using the below CLI command.
npm install @angular/elements



Steps 5 - Once done the web components custom elements, install
npm install @webcomponents/custom-elements




This will work for older browsers and also we will need to open and add below two lines in your project file - polyfills.ts.

* APPLICATION IMPORTS */
import '@webcomponents/custom-elements/src/native-shim';
import '@webcomponents/custom-elements/custom-elements.min';


Steps 6 - Create your reusable component and it will be used as an Angular Element.

In this example, I have created a custom element for displays the list of active users (active-user.component.ts and active-user.component.html) and my created component contains the list of activeUsers, applications access user name, and title.

active-user.component.ts -
import { Component, OnInit, Input } from '@angular/core';

@Component({
  selector: 'app-activeuser',
  templateUrl: './active-user.component.html',
  styleUrls: ['./active-user.component.css']
})
export class ActiveUserComponent implements OnInit {
  public activeUsers :any;
  public title :any;
  @Input() user: string;
    
  constructor() {
       this.title ='Angular - Create Custom Elements';
   }

  ngOnInit() { 
    this.activeUsers = [
          {"name" :"Anil Singh"},
          {"name" :"Alok Singh"},
          {"name" :"Dilip Singh"},
          {"name" :"Sunil Singh"},
          {"name" :"Aradhya Singh"},
          {"name" :"Reena Singh"}
    ];
  }
}


And active-user.component.html -
<h1>{{title}}</h1>
 <h2>You are welcome, {{user}}!</h2>
 <h4>Active Users - </h4>
 <div>
    <table *ngFor="let user of activeUsers; let i = index;" width="40%">
      <tr><td width="5%">#{{i +1}}</td><td width="30%">{{user.name}}</td></tr>
    </table>
 </div>

Steps 7 - Register the active-user.component in the app.module.ts.
import { ActiveUserComponent } from './active-user/active-user.component';

And comment the line - bootstrap ( //bootstrap: [AppComponent]) from the NgModule class.

And also added the line - entryComponents (entryComponents: [ActiveUserComponent]) in the NgModule.

See in the below code.
import { BrowserModule } from '@angular/platform-browser';
import { NgModule, Injector } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { RouterModule, Routes } from '@angular/router';

import { AppComponent } from './app.component';
import { UserComponent } from './user/user.component';
import { UserListComponent } from './user-list/user-list.component';

import {DataTableModule} from "angular-6-datatable";
import { ActiveUserComponent } from './active-user/active-user.component';

import { createCustomElement } from '@angular/elements';

@NgModule({
  declarations: [
    AppComponent,
    UserComponent,
    UserListComponent,
    ActiveUserComponent
  ],
  imports: [
    BrowserModule,
    DataTableModule,
    FormsModule,
    RouterModule.forRoot([
      { path: 'user-link', component: UserComponent },
      { path: 'user-list', component: UserListComponent }
    ])
  ],
  providers: [],
  // bootstrap: [AppComponent],
  bootstrap: [],
  entryComponents: [ActiveUserComponent]
})
export class AppModule {

}

Steps 8 - Register the Injector and createCustomElement in the app.module.ts.
import { NgModule, Injector } from '@angular/core';
import { createCustomElement } from '@angular/elements';

After register the required modules in the app.module.ts, we will need to create custom element in the AppModule.

See in the below code.
export class AppModule {
    //An instance of the element is created or upgraded.
  constructor(private injector: Injector) {    
    //The customElements is used for defining a custom element globaly.
    const customElement = createCustomElement(ActiveUserComponent, { injector });
    //Defining a new element
    customElements.define('app-activeuser', customElement);
  }

  ngDoBootstrap() {}
}


And the app.module.ts looks like –
import { BrowserModule } from '@angular/platform-browser';
import { NgModule, Injector } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { RouterModule, Routes } from '@angular/router';

import { AppComponent } from './app.component';
import { UserComponent } from './user/user.component';
import { UserListComponent } from './user-list/user-list.component';

import {DataTableModule} from "angular-6-datatable";
import { ActiveUserComponent } from './active-user/active-user.component';

import { createCustomElement } from '@angular/elements';

@NgModule({
  declarations: [
    AppComponent,
    UserComponent,
    UserListComponent,
    ActiveUserComponent
  ],
  imports: [
    BrowserModule,
    DataTableModule,
    FormsModule,
    RouterModule.forRoot([
      { path: 'user-link', component: UserComponent },
      { path: 'user-list', component: UserListComponent }
    ])
  ],
  providers: [],
  // bootstrap: [AppComponent],
  bootstrap: [],
  entryComponents: [ActiveUserComponent]
})
export class AppModule {
    //An instance of the element is created or upgraded.
  constructor(private injector: Injector) {    
    //The customElements is used for defining a custom element globaly.
    const customElement = createCustomElement(ActiveUserComponent, { injector });
    //Defining a new element
    customElements.define('app-activeuser', customElement);
  }

  ngDoBootstrap() {}
}

Steps 9 - Use the created custom element in your app.
<body>
  <!-- <app-root></app-root> -->
  <app-activeuser user="Anil Singh"></app-activeuser>
</body>

Note - I am using created custom element in the - index.html page.

Result looks like -

Conclusion
An Angular Custom element gives you a new tool for defining new HTML tags in the browsers and creating reusable components.

By Anil Singh | Rating of this article (*****)

Popular posts from this blog

nullinjectorerror no provider for httpclient angular 17

In Angular 17 where the standalone true option is set by default, the app.config.ts file is generated in src/app/ and provideHttpClient(). We can be added to the list of providers in app.config.ts Step 1:   To provide HttpClient in a standalone app we could do this in the app.config.ts file, app.config.ts: import { ApplicationConfig } from '@angular/core'; import { provideRouter } from '@angular/router'; import { routes } from './app.routes'; import { provideClientHydration } from '@angular/platform-browser'; //This (provideHttpClient) will help us to resolve the issue  import {provideHttpClient} from '@angular/common/http'; export const appConfig: ApplicationConfig = {   providers: [ provideRouter(routes),  provideClientHydration(), provideHttpClient ()      ] }; The appConfig const is used in the main.ts file, see the code, main.ts : import { bootstrapApplication } from '@angular/platform-browser'; import { appConfig } from ...

How To Optimizing Database Performance: Tips and Techniques for Developers

Best Practices for Optimizing Database Performance: Tips and Techniques for Developers Navigating the labyrinth of database performance optimization can often seem like a daunting task for many professionals. Especially for database developers, mastering this critical skill has immense value, as it enhances both the efficiency and responsiveness of their applications.  Effective database performance optimization leads to faster data retrieval and smoother transactions.  A key challenge, however, lies in knowing  how to hire database developers who are well-versed in optimization techniques. The market is flooded with many professionals, but finding the right expert who understands the intricacies of database performance can be like looking for a needle in a haystack. Employers need to seek those who are not only proficient in their craft but also updated with the latest optimization practices. This guide, therefore, not only aims to provide developers with a compre...

Top 15+ Angular 17 Interview Questions Answers | For Experienced Professionals as well

G Google team released the latest version of Angular – Angular 17 on November 6, 2023, creating a significant milestone for the super fast front-end development. What Are the New Features in Angular 17? 1.       Angular 17 is the highly anticipated release for the community, bringing many new exciting features, updates, and improvements. 2.       New Syntax for Control Flow in Templates - new @if, @switch, @for, @case, @empty @end control flow syntax 3.       Deferred Loading - @defer partial template 4.       The Angular signals API 5.       Angular SSR and client hydration 6.       Automatic Migration to Build-in Control Flow 7.       Build Performance with ESBuild 8.       By default, set this newly generated component as a standalone, and now we don't have an app module file. To use (ng...

25 Best Vue.js 2 Interview Questions and Answers

What Is Vue.js? The Vue.js is a progressive JavaScript framework and used to building the interactive user interfaces and also it’s focused on the view layer only (front end). The Vue.js is easy to integrate with other libraries and others existing projects. Vue.js is very popular for Single Page Applications developments. The Vue.js is lighter, smaller in size and so faster. It also supports the MVVM ( Model-View-ViewModel ) pattern. The Vue.js is supporting to multiple Components and libraries like - ü   Tables and data grids ü   Notifications ü   Loader ü   Calendar ü   Display time, date and age ü   Progress Bar ü   Tooltip ü   Overlay ü   Icons ü   Menu ü   Charts ü   Map ü   Pdf viewer ü   And so on The Vue.js was developed by “ Evan You ”, an Ex Google software engineer. The latest version is Vue.js 2. The Vue.js 2 is very similar to Angular because Evan ...

39 Best Object Oriented JavaScript Interview Questions and Answers

Most Popular 37 Key Questions for JavaScript Interviews. What is Object in JavaScript? What is the Prototype object in JavaScript and how it is used? What is "this"? What is its value? Explain why "self" is needed instead of "this". What is a Closure and why are they so useful to us? Explain how to write class methods vs. instance methods. Can you explain the difference between == and ===? Can you explain the difference between call and apply? Explain why Asynchronous code is important in JavaScript? Can you please tell me a story about JavaScript performance problems? Tell me your JavaScript Naming Convention? How do you define a class and its constructor? What is Hoisted in JavaScript? What is function overloadin...