Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xan105/node-powerballoon
Windows balloon notification using PowerShell.
https://github.com/xan105/node-powerballoon
balloon nodejs notification powershell windows
Last synced: 29 days ago
JSON representation
Windows balloon notification using PowerShell.
- Host: GitHub
- URL: https://github.com/xan105/node-powerballoon
- Owner: xan105
- License: mit
- Created: 2020-02-08T21:10:23.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-10T15:36:04.000Z (6 months ago)
- Last Synced: 2024-09-26T01:53:03.470Z (about 1 month ago)
- Topics: balloon, nodejs, notification, powershell, windows
- Language: JavaScript
- Homepage:
- Size: 105 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
About
=====
Windows balloon notification using PowerShell.
Doesn't use any native module. Everything is done through PowerShell.
Looking for Windows toast notification ? [node-powertoast](https://github.com/xan105/node-powertoast)
Example
=======
Windows 7
Windows 10
Sending a simple balloon notification
```js
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
===
⚠️ This module is only available as an ECMAScript module (ESM) starting with version 2.0.0.
Previous version(s) are CommonJS (CJS) with an ESM wrapper.
## Default export
#### `(option?: obj): Promise`
- **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)'_
- **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.