GitHub - felixrieseberg/electron-windows-notifications: :zap: Send native Windows WinRT notifications from Electron · GitHub Skip to content Navigation Menu Sign in Appearance settings * Platform * AI CODE CREATION * GitHub Copilot Write better code with AI * GitHub Copilot app Direct agents from issue to merge * MCP Registry Integrate external tools * DEVELOPER WORKFLOWS * Actions Automate any workflow * Codespaces Instant dev environments * Issues Plan and track work * Code Review Manage code changes * Code Quality Enforce quality at merge * APPLICATION SECURITY * GitHub Advanced Security Find and fix vulnerabilities * Code security Secure your code as you build * Secret protection Stop leaks before they start * EXPLORE * Why GitHub * Documentation * Blog * Changelog * Marketplace View all features * Solutions * BY COMPANY SIZE * Enterprises * Small and medium teams * Startups * Nonprofits * BY USE CASE * App Modernization * DevSecOps * DevOps * CI/CD * View all use cases * BY INDUSTRY * Healthcare * Financial services * Manufacturing * Government * View all industries View all solutions * Resources * EXPLORE BY TOPIC * AI * Software Development * DevOps * Security * View all topics * EXPLORE BY TYPE * Customer stories * Events & webinars * Ebooks & reports * Business insights * GitHub Skills * SUPPORT & SERVICES * Documentation * Customer support * Community forum * Trust center * Partners View all resources * Open Source * COMMUNITY * GitHub Sponsors Fund open source developers * PROGRAMS * Security Lab * Maintainer Community * GitHub Stars * Archive Program * REPOSITORIES * Topics * Trending * Collections * Enterprise * ENTERPRISE SOLUTIONS * Enterprise platform AI-powered developer platform * AVAILABLE ADD-ONS * GitHub Advanced Security Enterprise-grade security features * Copilot for Business Enterprise-grade AI features * Premium Support Enterprise-grade 24/7 support * Pricing Search / Sign in Sign up Appearance settings You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert felixrieseberg / electron-windows-notifications Public * Notifications You must be signed in to change notification settings * Fork 41 * Star 268 * Code * Issues 18 * Pull requests 9 * Actions * Projects * Wiki * Security and quality 0 * Insights Additional navigation options * Code * Issues * Pull requests * Actions * Projects * Wiki * Security and quality * Insights master Branches Tags Go to file Code Open more actions menu Latest commit   History 148 Commits 148 Commits Folders and files Name Name Last commit message Last commit date .vscode .vscode     samples samples     src src     test test     .gitignore .gitignore     .npmignore .npmignore     LICENSE LICENSE     README.md README.md     package-lock.json package-lock.json     package.json package.json     View all files Repository files navigation * * README * License More items electron-windows-notifications Create native Windows toast and tile notifications for Windows 8, 8.1, and 10 using native bindings to WinRT (using NodeRT). npm install --save electron-windows-notifications From Electron v14 on, you'll have to require NodeRT modules in the main process. See NodeRT/NodeRT#158 for details. Usage For more samples, check out the samples folder. 📝 Want to respond to interactive notifications (with input fields, for instance)? You can send them with this module - and respond to them with electron-windows-interactive-notifications ! 📝 Want to check if you should send a notification? , accounting for the user notification state and quiet hours? Check out electron-notification-state . ToastNotification The constructor for the ToastNotification class accepts an options object with the following properties: * string template - The XML template for the notification. You can also call new Template() with few properties to customize your own XML template based on the default. See example: template.js * string[] strings - An array of strings to be used in your template. XML escaping is applied to all strings. * Date expirationTime - Time after which a toast notification should not be displayed. * string group - Group identifier for the notification. * string tag - Unique identifier of this notification within the notification group. * string appId - appUserModelId of the application for which the notification is sent. If not passed, it will be assumed to be a global property in Electron's main thread. const appId = 'electron-windows-notifications' const { ToastNotification } = require ( 'electron-windows-notifications' ) let notification = new ToastNotification ( { appId : appId , template : `<toast><visual><binding template="ToastText01"><text id="1">%s</text></binding></visual></toast>` , strings : [ 'Hi!' ] } ) notification . on ( 'activated' , ( ) => console . log ( 'Activated!' ) ) notification . show ( ) TileNotification Tile notifications update the app's primary or secondary tiles. They require that the app is running inside the UWP model, which is possible on Windows 10 Anniversary Update and later. For more information, check out electron-windows-store . The constructor for the TileNotification class accepts an options object with the following properties: * string template - The XML template for the notification. You can also call new Template() with few properties to customize your own XML template based on the default. See example: template.js * string[] strings - An array of strings to be used in your template. XML escaping is applied to all strings. * string tag - Unique identifier of this notification within the notification group. * string tileId - If set, the given tile will be updated. Otherwise, the app's primary tile will be used. const appId = 'electron-windows-notifications' const { ToastNotification } = require ( 'electron-windows-notifications' ) let notification = new ToastNotification ( { appId : appId , template : `<toast><visual><binding template="ToastText01"><text id="1">%s</text></binding></visual></toast>` , strings : [ 'Hi!' ] } ) notification . on ( 'activated' , ( ) => console . log ( 'Activated!' ) ) notification . show ( ) Hints appUserModelId The appUserModelId identifies application in Windows. In Electron, you can set it at runtime using the app.setAppUserModelId() method. If you don't pass it, this module will assume that it's a property on Electron's main thread. Unless running inside a UWP container, you probably want to pass it. Mysterious Failures & XML Escaping Microsoft follows the XML spec to the letter - and XML has escaping rules you might not be familiar with. If you're adding strings and properties to your template, consider just using the strings property in the constructor - it will automatically properly escape all input. String replacement Inside the module, util.format is used. It'll format the template in a printf -like format. The template is expected to hold zero or more placeholders. Each placeholder is replaced with the converted value from its corresponding argument. If the placeholder does not have a corresponding argument, the placeholder is not replaced. Supported placeholders are: * %s - String. * %d - Number (both integer and float). * %j - JSON. * %% - single percent sign ('%'). This does not consume an argument. License MIT. Please see LICENSE for details. About ⚡ Send native Windows WinRT notifications from Electron Topics electron notifications windows Resources Readme License Activity Stars 268 stars Watchers 6 watching Forks 41 forks Report repository Releases Packages Used by Contributors Languages Footer (c) 2026 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Community * Docs * Contact * Manage cookies * Do not share my personal information You can’t perform that action at this time.