About
Windows balloon notification using PowerShell.
Doesn't use any native module. Everything is done through PowerShell.
Looking for Windows toast notification ? node-powertoast
Example
Windows 7 | Windows 10 |
Sending a simple balloon notification
import balloon from 'powerballoon';
balloon({
title: "NPM",
message: "Installed.",
ico: "C:\\Program Files\\nodejs\\node.exe",
showTime: 7,
callback: {
onActivated: ()=>{
console.log("clicked");
},
onDismissed: ()=>{
console.log("closed");
}
}
})
.then(()=>{
console.log("done");
})
.catch((err) => {
console.error(err);
});
Installation
npm install powerballoon
API
Previous version(s) are CommonJS (CJS) with an ESM wrapper.
Default export
(option?: obj): Promise<void>
-
title
The title of your notification
-
message
The content message of your notification. This can not be empty !
Thus default to "Hello World !" -
ico
Path to the icon shown in the systray.
Path can target either an .ico file or an .exe.
default to the PowerShell executable icon. -
type
- 0 (
ℹ️ Info) - 1 (
⚠️ Warning) - 2 (
❌ Error)
This change the icon displayed within the tooltip.
default to '0 (Info)' - 0 (
-
showTime
balloon duration in sec.
default to 7.⚠️ Please note that Windows can dismiss the pop-up before the timeout expires. -
callback
onActivated() : When the balloon tooltip is clicked.
onDismissed() : When the balloon tooltip is closed.
NB: Please note that since v2.0.0. The promise will resolve when the balloon tooltip is done because we need to wait and then clean up the systray.
Common Issues
-
Windows balloon are disabled
There is a registry setting that controls whether a balloons can be show or not.
HKCU\Software\Microsoft\Windows\CurrentVersion\Explorer\Advanced
DWORD::EnableBalloonTips -
Powershell is not recognized as an internal or external command [...]
Powershell needs to be installed.
Windows 7/Server 2008 R2 are the first Windows versions to come with PowerShell installed.