Getting started with Angular and Electron

20 Feb 20238 minutes to read

This document helps you to create a simple Angular application with Electron Framework and Syncfusion Angular UI components.


Before getting started with the Angular project, make sure you have the following installed on your machine,

  • Angular version 6 or later
  • TypeScript version 2.6 or later
  • Electron CLI version 6.0.10 or later

If you do not have the Electron CLI installed, refer to the Electron package for instructions on how to install it.

Setup Angular environment

You can use follow the Setting up the local environment and workspace.

Install electron framework using the following command.

npm install -g electron

Note: Here, we are using electron version 6.0.10 to support Angular 6.

Note: Refer to this getting started to install electron framework.

Installing Syncfusion Menu package

Syncfusion packages are distributed on npm under the @syncfusion scope. You can find all of the Angular Syncfusion packages here.

To install the Menu package, run the following command.

npm install @syncfusion/ej2-angular-navigations@ngcc --save
npm i @syncfusion/ej2-angular-navigations@ngcc --save

Adding the Menu module

After installing the package, the component modules will be available for you to configure your application. The Syncfusion Angular package provides two different types of ng-Modules.

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

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

// Imported Syncfusion menu module from navigations package.
import { MenuModule } from '@syncfusion/ej2-angular-navigations';

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

    imports: [BrowserModule, MenuModule], // Registering EJ2 Menu Module.
    declarations: [AppComponent],
    bootstrap: [AppComponent]
export class AppModule { }

Adding Syncfusion Menu component

To add the Syncfusion Menu component to your application, modify the template in the app.component.ts file by adding the ejs-menu element and binding it to the menuItems variable.

import { Component } from '@angular/core';
import { enableRipple } from '@syncfusion/ej2-base';
import { MenuItemModel } from '@syncfusion/ej2-angular-navigations';


    selector: 'app-root',
    template: `<!-- To Render Menu. -->
            <ejs-menu [items]='menuItems'></ejs-menu>`

export class AppComponent {
    public menuItems: MenuItemModel[] = [
            text: 'File',
            items: [
                { text: 'Open',  url: '' },
                { text: 'Save' },
                { text: 'Exit' }
            text: 'Edit',
            items: [
                { text: 'Cut' },
                { text: 'Copy' },
                { text: 'Paste' }
            text: 'View',
            items: [
                { text: 'Toolbar' },
                { text: 'Sidebar' }
            text: 'Tools',
            items: [
                { text: 'Spelling & Grammar' },
                { text: 'Customize' },
                { text: 'Options' }
        { text: 'Go' },
        { text: 'Help' }

Adding CSS reference

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

@import "../node_modules/@syncfusion/ej2-base/styles/material.css";
@import "../node_modules/@syncfusion/ej2-navigations/styles/material.css";

Create main.js file

Create a main.js file in the root folder of the project, and add the following code in main.js file

const { app, BrowserWindow } = require('electron');
let win;
function createWindow () {     
// Create the browser window.
win = new BrowserWindow({ width: 800, height: 600 });
// Load the index.html of the app. 
// Open the DevTools.
// Emitted when the window is closed.
win.on('closed', () => {       
   win = null     
// This method will be called when Electron finish initialization and is ready to create browser windows.   
// Some APIs can only be used after this event occurs.
app.on('ready', createWindow);

// Quit when all windows are closed.
app.on('window-all-closed', () => { 
// On macOS, it is common for applications and their menu bar to stay active until the user quits explicitly with Cmd + Q.
if (process.platform !== 'darwin') {

app.on('activate', () => {
// On macOS, it is common to re-create a Window in an app when the dock icon is clicked and there are no other windows open.
if (win === null) {

Update index.html

In the /src/index.html file, change <base href="/"> as <base href="./">, so that the Electron can able to find the Angular files.

Update package.json

"scripts": { 
    "ng": "ng", 
    "start": "ng serve", 
    "build": "ng build", 
    "test": "ng test", 
    "lint": "ng lint", 
    "e2e": "ng e2e", 
    "electron-build": "ng build --prod", 
    "electron": "electron ." 

Then, include the above code in the package.json file.

Update tsconfig.json

In the tsconfig.json file, change the target as demonstrated in the following code sample.

"target": "es5"

Running the application

Finally, run the following command line to start the application. The Syncfusion Essential JS 2 menu component will be rendered in the Electron framework.

npm  run electron-build 
npm  run electron

Note: For your convenience, we have prepared an Angular sample with electron framework.

See also