Custom Messages in ElectronJS
Last Updated :
12 Jul, 2025
ElectronJS is an Open Source Framework used for building Cross-Platform native desktop applications using web technologies such as HTML, CSS, and JavaScript which are capable of running on Windows, macOS, and Linux operating systems. It combines the Chromium engine and NodeJS into a Single Runtime.
One of the ways how an Electron application interacts with the user is through Message boxes and Alerts. Sometimes during the execution of the application, a condition arises that needs the user’s attention or the code encounters an error and the user needs to be made aware of it. In such cases, the execution flow cannot move forward without user intervention. Electron provides us with a convenient technique by which the user can be made aware of the problem and take necessary action on it. Electron provides us with a built-in dialog module to display Custom Message boxes and Alerts for interacting with the user. This tutorial will use the instance methods of the dialog module to demonstrate Custom Messages in Electron.
We assume that you are familiar with the prerequisites as covered in the above-mentioned link. For Electron to work, node and npm need to be pre-installed in the system.
Custom Messages in Electron: The dialog Module is part of the Main Process. To import and use the dialog Module in the Renderer Process, we will be using Electron remote module.
Project Structure:
Example:
Follow the given steps to build Custom Message boxes in Electron.
Step 1: Navigate to an Empty Directory to setup the project, and run the following command,
npm init
To generate the package.json file. Install Electron using npm if it is not installed. npm install electron --save
This will install the required node_modules dependencies. Copy any Image file of your choosing into the assets folder and name it as image.png. In this tutorial, we will be using the Electron logo as the image.png file. package.json:{
"name": "electron-message",
"version": "1.0.0",
"description": "Custom Messages in Electron",
"main": "main.js",
"scripts": {
"start": "electron ."
},
"keywords": [
"electron"
],
"author": "Radhesh Khanna",
"license": "ISC",
"dependencies": {
"electron": "^8.2.5"
}
}
Step 2: For the Boilerplate code of the main.js file, Refer this link. We have modified the code to suit our project needs. main.js:
javascript
const { app, BrowserWindow } = require('electron')
function createWindow () {
// Create the browser window.
const win = new BrowserWindow({
width: 800,
height: 600,
webPreferences: {
nodeIntegration: true
}
})
// Load the index.html of the app.
win.loadFile('src/index.html')
// Open the DevTools.
win.webContents.openDevTools()
}
// This method will be called when Electron has finished
// initialization and is ready to create browser windows.
// Some APIs can only be used after this event occurs.
/* The 'dialog.showErrorBox()' method can be used before
this event occurs. */
// This method is equivalent to 'app.on('ready', function())'
app.whenReady().then(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.quit()
}
})
app.on('activate', () => {
// On macOS it's common to re-create a window in the
// app when the dock icon is clicked and there are no
// other windows open.
if (BrowserWindow.getAllWindows().length === 0) {
createWindow()
}
})
// In this file, you can include the rest of your
// app's specific main process code. You can also
// Put them in separate files and require them here.
Step 3: Create the index.html file and index.js file within the src directory. We will also copy the boilerplate code for the index.html file from the above-mentioned link. We have modified the code to suit our project needs. index.html:
html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Hello World!</title>
<!-- https://www.electronjs.org/docs/latest/tutorial
/security#csp-meta-tag -->
<meta http-equiv="Content-Security-Policy"
content="script-src 'self' 'unsafe-inline';" />
</head>
<body>
<h1>Hello World!</h1>
We are using node
<script>
document.write(process.versions.node)
</script>, Chrome
<script>
document.write(process.versions.chrome)
</script>, and Electron
<script>
document.write(process.versions.electron)
</script>.
<h3>Custom Messages in Electron</h3>
<button id="show">Show Custom Message Box</button>
<br><br>
<button id="error">Show Error Message Box</button>
<!-- Adding Individual Renderer Process JS File -->
<script src="index.js"></script>
</body>
</html>
npm start
Step 4: The Show Custom Message Box button does not have any functionality associated with it yet. To change this, add the following code in the index.js file. The dialog.showMessageBox(browserWindow, options) is used with all default/basic values for the options Object. Using this Instance method shows the Message box and will block the application execution until the message box is closed successfully with appropriate action from the user. It takes in the following parameters.
- browserWindow: BrowserWindow (Optional) The BrowserWindow Instance. This argument allows the dialog to attach itself to the parent window, making it a modal. A modal window is a child window that disables the parent window. If BrowserWindow is not shown, dialog will not be attached to it. In such case It will be displayed as independent window. In the above code, the BrowserWindow instance is not being passed to the dialog, therefore the dialog opens as an independent window on clicking the Show Custom Message Box button.
- options: Object It takes in the following parameters,
- type: String (Optional) It can hold the following values.
- none
- info
- error
- question
- warning
Each of these values signifify the type of Message Box that you want to display to the user. Default value is none. On Windows, question displays the same icon as info, unless the icon property is explicitly set. On macOS, both warning and error display the same warning icon. Each of these values have a default System OS sound associated with it except for the default value. - buttons: String[] (Optional) It represents an Array for the labels of the Buttons that you wish to display on the Custom Message box. An Empty array will result in one button being displayed, labeled OK.
- defaultId: Integer (Optional) The index of the button in the
buttons array which will be selected by default when the Custom Message box is opened. This property is dependent on the noLink property. This is demonstrated in the following Steps. - title: String (Optional) The title to be displayed on the Message box. Some OS platforms and their respective versions do not support this property.
- message: String The main contents of the Message box.
- detail: String (Optional) Extra Information to be displayed in the Message box below the message property.
- checkboxLabel: String (Optional) Label of the checkbox. This property automatically includes the checkbox with the given label in the custom Message box.
- checkboxChecked: Boolean (Optional) This property represents the initial state of the checkbox. The default value of this property is false.
- icon: NativeImage (Optional) The icon to be displayed on the Message box. If this property is defined, it will override the default system icons for the type property, irrespective of its value. This property takes in a NativeImage instance or the filepath of an image. In this tutorial, we will pass the filepath for the image.png file located in the assets folder using the path module.
- cancelId: Integer (Optional) The index of the button to be returned when the dialog is cancelled, via the Esc key. By default this is assigned to the first button with Cancel or No as the label in the buttons array property. If no such labeled buttons exist and this option is not set, 0 will be used as the return value. This is demonstrated in the following Steps.
- noLink: Boolean (Optional) This property is supported on Windows only. When this property is set, Electron will automatically try to figure out which one of the buttons are common button labels e.g. Cancel, Yes, No, OK etc, and show the other button labels as command links in the dialog. This property is used to make the dialog window appear in style with modern Windows OS apps and themes. By default, this property is set to false. In case all common button labels are used, this property will have no effect. This property is demonstrated in the following Steps.
- normalizeAccessKeys: Boolean (Optional) Normalize the keyboard access keys across platforms. Default value is false. Enabling this property assumes the '&' wildcard is used in the button labels. These labels will be converted so that they work on each platform accordingly. '&' characters are removed altogether on macOS, converted to _ on Linux, and no action is taken on Windows.
The dialog.showMessageBox(browserWindow, options) returns a Promise. It resolves to an Object containing the following parameters, index.js:
javascript
const electron = require('electron');
const path = require('path');
// Importing dialog module using remote
const dialog = electron.remote.dialog;
let showBox = document.getElementById('show');
showBox.addEventListener('click', (event) => {
// Resolves to a Promise<Object>
dialog.showMessageBox({
// option Object
type: 'none',
buttons: [],
defaultId: 0,
icon: '',
title: 'This is the Title',
message: 'This is a Message',
detail: 'This is extra Information',
checkboxLabel: 'Checkbox',
checkboxChecked: false,
cancelId: 0,
noLink: false,
normalizeAccessKeys: false,
}).then(box => {
console.log('Button Clicked Index - ', box.response);
console.log('Checkbox Checked - ', box.checkboxChecked);
}).catch(err => {
console.log(err)
});
});
response: Integer The index of the button clicked as defined in the buttons array property.
checkboxChecked: Boolean The checked state of the checkbox if checkboxLabel property was set. By default, will return false.
Note: If the user tries to continue the execution of the application without successfully closing the Custom Message box, the following message is shown on the console:
Attempting to call a function in a renderer window that
has been closed or released. Function provided here: undefined
Step 5: We will now modify the options Object of the Custom Message Box to see the different outputs,
type: String Defining the different types of Message boxes.
type: 'info'
type: 'warning'
type: 'error'
buttons: String[] We will define Custom labels for the buttons array property and see the respective outputs by changing the noLink property.
buttons: ['Cancel', 'OK', 'Button-1', 'Button-2'], noLink: false, defaultId: 0
Note: In this case the defaultId property should highlight the Cancel button, but instead the Button-1 label is selected. This is due to the behaviour defined by the noLink property.
buttons: ['Cancel', 'OK', 'Button-1', 'Button-2'], noLink: true, defaultId: 0
Note: The Cancel button is selected by default as per expected behaviour.
cancelId: Integer Evaluating the behaviour of the cancelId property. This behaviour is invoked by pressing the Esc key on the keyboard.
buttons: ['Cancel', 'OK', 'Button-1', 'Button-2'], cancelId: 100, noLink: true
We can also assign different behaviours to each button in the Message box by simply comparing the index value of the buttons array property with the response parameter returned by Promise. index.js:
javascript
.then(box => {
console.log('Button Clicked Index - ', box.response);
console.log('Checkbox Checked - ', box.checkboxChecked);
if (box.response === 0) {
console.log('Cancel Button was clicked');
} else if (box.response === 2) {
console.log('Button-1 was clicked');
}
}).catch(err => {
console.log(err)
});
Note: The value returned is 100 as set in the cancelId property.
buttons: ['Cancel', 'OK', 'Button-1', 'Button-2'], cancelId: 100, noLink: false
Note: The value returned is 0 despite setting the cancelId property value to 100.
icon: NativeImage We will be passing the filepath of the image.png file located in the assets folder. Note: Using the icon property disables the default system OS sound for the type property, irrespective of its value.
buttons: ['Cancel', 'OK', 'Button-1', 'Button-2'], icon: path.join(__dirname, '../assets/image.png'), noLink: true
buttons: ['Cancel', 'OK', 'Button-1', 'Button-2'], icon: path.join(__dirname, '../assets/image.png'), noLink: false
Step 6: Electron also provides us with an instance Method specifically designed for Error Messages. In the above code, the Show Error Message Box button does not have any functionality associated with it. To change this add the following code in the index.js file. The dialog.showErrorBox(title, info) takes in the following parameters. It does not have any return value. This method is not customizable like the dialog.showMessageBox() method but this method can be safely called before the ready event of the app module is emitted. Refer to the highlighted code in the main.js file. It is usually used to display errors in the application startup stages. If called before the ready event of the app module on Linux, the message will be emitted to stderr, and no GUI dialog will appear. index.js:
javascript
var error = document.getElementById('error');
error.addEventListener('click', (event) => {
dialog.showErrorBox('This is the Title', 'This is the Content');
});
title: String The title of the Error box.
info: String The text information to display in the Error box below the title property.
Similar Reads
JavaScript Tutorial JavaScript is a programming language used to create dynamic content for websites. It is a lightweight, cross-platform, and single-threaded programming language. It's an interpreted language that executes code line by line, providing more flexibility.Client Side: On the client side, JavaScript works
11 min read
JavaScript Basics
Introduction to JavaScriptJavaScript is a versatile, dynamically typed programming language that brings life to web pages by making them interactive. It is used for building interactive web applications, supports both client-side and server-side development, and integrates seamlessly with HTML, CSS, and a rich standard libra
4 min read
JavaScript VersionsJavaScript is a popular programming language used by developers all over the world. It’s a lightweight and easy-to-learn language that can run on both the client-side (in your browser) and the server-side (on the server). JavaScript was created in 1995 by Brendan Eich.In 1997, JavaScript became a st
2 min read
How to Add JavaScript in HTML Document?To add JavaScript in HTML document, several methods can be used. These methods include embedding JavaScript directly within the HTML file or linking an external JavaScript file.Inline JavaScriptYou can write JavaScript code directly inside the HTML element using the onclick, onmouseover, or other ev
3 min read
JavaScript SyntaxJavaScript syntax refers to the rules and conventions dictating how code is structured and arranged within the JavaScript programming language. This includes statements, expressions, variables, functions, operators, and control flow constructs.Syntaxconsole.log("Basic Print method in JavaScript");Ja
6 min read
JavaScript OutputJavaScript provides different methods to display output, such as console.log(), alert(), document.write(), and manipulating HTML elements directly. Each method has its specific use cases, whether for debugging, user notifications, or dynamically updating web content. Here we will explore various Jav
4 min read
JavaScript CommentsComments help explain code (they are not executed and hence do not have any logic implementation). We can also use them to temporarily disable parts of your code.1. Single Line CommentsA single-line comment in JavaScript is denoted by two forward slashes (//), JavaScript// A single line comment cons
2 min read
JS Variables & Datatypes
Variables and Datatypes in JavaScriptVariables and data types are foundational concepts in programming, serving as the building blocks for storing and manipulating information within a program. In JavaScript, getting a good grasp of these concepts is important for writing code that works well and is easy to understand.Data TypesVariabl
6 min read
Global and Local variables in JavaScriptIn JavaScript, understanding the difference between global and local variables is important for writing clean, maintainable, and error-free code. Variables can be declared with different scopes, affecting where and how they can be accessed. Global VariablesGlobal variables in JavaScript are those de
4 min read
JavaScript LetThe let keyword is a modern way to declare variables in JavaScript and was introduced in ECMAScript 6 (ES6). Unlike var, let provides block-level scoping. This behaviour helps developers avoid unintended issues caused by variable hoisting and scope leakage that are common with var.Syntaxlet variable
6 min read
JavaScript constThe const keyword in JavaScript is a modern way to declare variables, introduced in (ES6). It is used to declare variables whose values need to remain constant throughout the lifetime of the application.const is block-scoped, similar to let, and is useful for ensuring immutability in your code. Unli
5 min read
JavaScript Var StatementThe var keyword is used to declare variables in JavaScript. It has been part of the language since its inception. When a variable is declared using var, it is function-scoped or globally-scoped, depending on where it is declared.Syntaxvar variable = value;It declares a variable using var, assigns it
7 min read
JS Operators
JavaScript OperatorsJavaScript operators are symbols or keywords used to perform operations on values and variables. They are the building blocks of JavaScript expressions and can manipulate data in various ways.There are various operators supported by JavaScript:1. JavaScript Arithmetic OperatorsArithmetic Operators p
5 min read
Operator precedence in JavaScriptOperator precedence refers to the priority given to operators while parsing a statement that has more than one operator performing operations in it. Operators with higher priorities are resolved first. But as one goes down the list, the priority decreases and hence their resolution. ( * ) and ( / )
2 min read
JavaScript Arithmetic OperatorsJavaScript Arithmetic Operators are the operator that operate upon the numerical values and return a numerical value. Addition (+) OperatorThe addition operator takes two numerical operands and gives their numerical sum. It also concatenates two strings or numbers.JavaScript// Number + Number =>
5 min read
JavaScript Assignment OperatorsAssignment operators are used to assign values to variables in JavaScript.JavaScript// Lets take some variables x = 10 y = 20 x = y ; console.log(x); console.log(y); Output20 20 More Assignment OperatorsThere are so many assignment operators as shown in the table with the description.OPERATOR NAMESH
5 min read
JavaScript Comparison OperatorsJavaScript comparison operators are essential tools for checking conditions and making decisions in your code. 1. Equality Operator (==) The Equality operator is used to compare the equality of two operands. JavaScript// Illustration of (==) operator let x = 5; let y = '5'; // Checking of operands c
5 min read
JavaScript Logical OperatorsLogical operators in JavaScript are used to perform logical operations on values and return either true or false. These operators are commonly used in decision-making statements like if or while loops to control the flow of execution based on conditions.In JavaScript, there are basically three types
5 min read
JavaScript Bitwise OperatorsIn JavaScript, a number is stored as a 64-bit floating-point number but bitwise operations are performed on a 32-bit binary number. To perform a bit-operation, JavaScript converts the number into a 32-bit binary number (signed) and performs the operation and converts back the result to a 64-bit numb
5 min read
JavaScript Ternary OperatorThe Ternary Operator in JavaScript is a conditional operator that evaluates a condition and returns one of two values based on whether the condition is true or false. It simplifies decision-making in code, making it more concise and readable. Syntaxcondition ? trueExpression : falseExpressionConditi
4 min read
JavaScript Comma OperatorJavaScript Comma Operator mainly evaluates its operands from left to right sequentially and returns the value of the rightmost operand. JavaScriptlet x = (1, 2, 3); console.log(x); Output3 Here is another example to show that all expressions are actually executed.JavaScriptlet a = 1, b = 2, c = 3; l
2 min read
JavaScript Unary OperatorsJavaScript Unary Operators work on a single operand and perform various operations, like incrementing/decrementing, evaluating data type, negation of a value, etc.Unary Plus (+) OperatorThe unary plus (+) converts an operand into a number, if possible. It is commonly used to ensure numerical operati
4 min read
JavaScript in and instanceof operatorsJavaScript Relational Operators are used to compare their operands and determine the relationship between them. They return a Boolean value (true or false) based on the comparison result.JavaScript in OperatorThe in-operator in JavaScript checks if a specified property exists in an object or if an e
3 min read
JavaScript String OperatorsJavaScript String Operators are used to manipulate and perform operations on strings. There are two operators which are used to modify strings in JavaScript. These operators help us to join one string to another string.1. Concatenate OperatorConcatenate Operator in JavaScript combines strings using
3 min read
JS Statements
JS Loops
JavaScript LoopsLoops in JavaScript are used to reduce repetitive tasks by repeatedly executing a block of code as long as a specified condition is true. This makes code more concise and efficient.Suppose we want to print 'Hello World' five times. Instead of manually writing the print statement repeatedly, we can u
3 min read
JavaScript For LoopJavaScript for loop is a control flow statement that allows code to be executed repeatedly based on a condition. It consists of three parts: initialization, condition, and increment/decrement. Syntaxfor (statement 1 ; statement 2 ; statement 3){ code here...}Statement 1: It is the initialization of
4 min read
JavaScript While LoopThe while loop executes a block of code as long as a specified condition is true. In JavaScript, this loop evaluates the condition before each iteration and continues running as long as the condition remains true.Syntaxwhile (condition) { Code block to be executed}Here's an example that prints from
3 min read
JavaScript For In LoopThe JavaScript for...in loop iterates over the properties of an object. It allows you to access each key or property name of an object.JavaScriptconst car = { make: "Toyota", model: "Corolla", year: 2020 }; for (let key in car) { console.log(`${key}: ${car[key]}`); }Outputmake: Toyota model: Corolla
3 min read
JavaScript for...of LoopThe JavaScript for...of loop is a modern, iteration statement introduced in ECMAScript 2015 (ES6). Works for iterable objects such as arrays, strings, maps, sets, and more. It is better choice for traversing items of iterables compared to traditional for and for in loops, especially when we have bre
3 min read
JavaScript do...while LoopA do...while loop in JavaScript is a control structure where the code executes repeatedly based on a given boolean condition. It's similar to a repeating if statement. One key difference is that a do...while loop guarantees that the code block will execute at least once, regardless of whether the co
4 min read
JS Perfomance & Debugging
JS Object
Objects in JavascriptAn object in JavaScript is a data structure used to store related data collections. It stores data as key-value pairs, where each key is a unique identifier for the associated value. Objects are dynamic, which means the properties can be added, modified, or deleted at runtime.There are two primary w
4 min read
Introduction to Object Oriented Programming in JavaScriptObject Oriented Programming (OOP) is a style of programming that uses classes and objects to model real-world things like data and behavior. A class is a blueprint that defines the properties and methods an object can have, while an object is a specific instance created from that class. OOP focuses
3 min read
JavaScript ObjectsIn our previous article on Introduction to Object Oriented Programming in JavaScript we have seen all the common OOP terminology and got to know how they do or don't exist in JavaScript. In this article, objects are discussed in detail.Creating Objects:In JavaScript, Objects can be created using two
6 min read
Creating objects in JavaScriptAn object in JavaScript is a collection of key-value pairs, where keys are strings (properties) and values can be any data type. Objects can be created using object literals, constructors, or classes. Properties are defined with key-value pairs, and methods are functions defined within the object, e
5 min read
JavaScript JSON ObjectsJSON (JavaScript Object Notation) is a handy way to share data. It's easy for both people and computers to understand. In JavaScript, JSON helps organize data into simple objects. Let's explore how JSON works and why it's so useful for exchanging information.const jsonData = { "key1" : "value1", ...
3 min read
JavaScript Object ReferenceJavaScript Objects are the most important data type and form the building blocks for modern JavaScript. The "Object" class represents the JavaScript data types. Objects are quite different from JavaScript’s primitive data types (Number, String, Boolean, null, undefined, and symbol). It is used to st
4 min read
JS Function
Functions in JavaScriptFunctions in JavaScript are reusable blocks of code designed to perform specific tasks. They allow you to organize, reuse, and modularize code. It can take inputs, perform actions, and return outputs.JavaScriptfunction sum(x, y) { return x + y; } console.log(sum(6, 9)); // output: 15Function Syntax
4 min read
How to write a function in JavaScript ?JavaScript functions serve as reusable blocks of code that can be called from anywhere within your application. They eliminate the need to repeat the same code, promoting code reusability and modularity. By breaking down a large program into smaller, manageable functions, programmers can enhance cod
4 min read
JavaScript Function CallThe call() method is a predefined JavaScript method. It can be used to invoke (call) a method with an owner object as an argument (parameter). This allows borrowing methods from other objects, executing them within a different context, overriding the default value, and passing arguments. Syntax: cal
2 min read
Different ways of writing functions in JavaScriptA JavaScript function is a block of code designed to perform a specific task. Functions are only executed when they are called (or "invoked"). JavaScript provides different ways to define functions, each with its own syntax and use case.Below are the ways of writing functions in JavaScript:Table of
3 min read
Difference between Methods and Functions in JavaScriptGrasping the difference between methods and functions in JavaScript is essential for developers at all levels. While both are fundamental to writing effective code, they serve different purposes and are used in various contexts. This article breaks down the key distinctions between methods and funct
3 min read
Explain the Different Function States in JavaScriptIn JavaScript, we can create functions in many different ways according to the need for the specific operation. For example, sometimes we need asynchronous functions or synchronous functions. Â In this article, we will discuss the difference between the function Person( ) { }, let person = Person ( )
3 min read
JavaScript Function Complete ReferenceA JavaScript function is a set of statements that takes inputs, performs specific computations, and produces outputs. Essentially, a function performs tasks or computations and then returns the result to the user.Syntax:function functionName(Parameter1, Parameter2, ..) { // Function body}Example: Be
3 min read
JS Array
JavaScript ArraysIn JavaScript, an array is an ordered list of values. Each value, known as an element, is assigned a numeric position in the array called its index. The indexing starts at 0, so the first element is at position 0, the second at position 1, and so on. Arrays can hold any type of data—such as numbers,
7 min read
JavaScript Array MethodsTo help you perform common tasks efficiently, JavaScript provides a wide variety of array methods. These methods allow you to add, remove, find, and transform array elements with ease.Javascript Arrays Methods1. JavaScript Array length The length property of an array returns the number of elements i
7 min read
Best-Known JavaScript Array MethodsAn array is a special variable in all programming languages used to store multiple elements. JavaScript array come with built-in methods that every developer should know how to use. These methods help in adding, removing, iterating, or manipulating data as per requirements.There are some Basic JavaS
6 min read
Important Array Methods of JavaScriptJavaScript arrays are powerful tools for managing collections of data. They come with a wide range of built-in methods that allow developers to manipulate, transform, and interact with array elements.Some of the most important array methods in JavaScript areTable of Content1. JavaScript push() Metho
7 min read
JavaScript Array ReferenceJavaScript Array is used to store multiple elements in a single variable. It can hold various data types, including numbers, strings, objects, and even other arrays. It is often used when we want to store a list of elements and access them by a single variable.Syntax:const arr = ["Item1", "Item2", "
4 min read