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
-`Windows 8 - 11`: [Ntfy Toasts](#what-is-ntfy-toast) / Windows Toasts
95
110
-`Windows 7 and earlier`: [Windows balloons](#windowsballoon)
96
111
-[Windows balloons](#windowsballoon) for Windows < 8.
97
112
-[Growl](#growl) as fallback.
@@ -101,6 +116,7 @@ The correct notification package will be used by Toasted Notifier depending on t
101
116
<br />
102
117
103
118
## What is ntfy-toast
119
+
104
120
[ntfy-toast](https://github.com/Aetherinox/ntfy-toast) is a package included in this repo, which services notifications for users running Windows 8 - 11.
105
121
106
122
It is based on [SnoreToast](https://github.com/KDE/snoretoast), but has been updated with numerous features.
@@ -112,6 +128,7 @@ It is based on [SnoreToast](https://github.com/KDE/snoretoast), but has been upd
112
128
<br />
113
129
114
130
# Features
131
+
115
132
- Notification support for Windows XP - 11, Linux, and MacOS.
116
133
- Windows custom appID support for branding
117
134
- Persistent notifications keep a message on-screen until the user dismisses it
@@ -125,6 +142,7 @@ It is based on [SnoreToast](https://github.com/KDE/snoretoast), but has been upd
This format can be used for all notification vendors _(Windows, Linux, Mac)_
147
167
148
168
```javascript
@@ -176,6 +196,7 @@ toasted.on('timeout', function (obj, options) {
176
196
<br />
177
197
178
198
## Fine-grained Control
199
+
179
200
If you want super fine-grained control for each reporter; you can call them individually. This allows you to tune specific options for the different vendors.
180
201
181
202
See below for documentation on each reporter.
@@ -214,28 +235,35 @@ new tn.Growl(options).notify(options);
214
235
<br />
215
236
216
237
## Specific Vendor Documentation
238
+
217
239
To see information about each specific vendor and operating system, select one below:
218
240
219
241
---
220
242
221
-
-[NotificationCenter](#notificationcenter)
222
-
-[WindowToaster](#windowstoaster)
223
-
-[Growl](#growl)
224
-
-[WindowsBalloon](#windowsballoon)
225
-
-[NotifySend](#notifysend)
243
+
The following different types of notifications are listed below:
244
+
245
+
| Notification API | Operating System | File | View Docs |
246
+
| --- | --- | --- | --- |
247
+
|**WindowToaster**|`Windows 8, 10, and 11`|`notifiers\toaster.js`|[view](#windowstoaster)|
248
+
|**WindowsBalloon**|`Windows XP / 7`|`notifiers\balloon.js`|[view](#windowsballoon)|
|**NotificationCenter**|`macOS / OS X`|`notifiers\notificationcenter.js`|[view](#notificationcenter)|
251
+
|**Growl**|`MacOS / OS X`|`notifiers\growl.js`|[view](#growl)|
226
252
227
253
---
228
254
229
255
<br />
230
256
231
257
### NotificationCenter
258
+
232
259
- A Node.js wrapper for terminal-notify (with fallback).
233
260
- Code available at: `node_modules\toasted-notifier\notifiers\notificationcenter.js`
234
261
- Requires macOS version 10.8 or higher; otherwise the fallback is [Growl](#growl). If growl is not installed, an error will be returned in the callback.
235
262
236
263
<br />
237
264
238
-
Since toasted-notifier wraps around `terminal-notifier`, you can do anything terminal-notifier can by passing properties to the method.
265
+
Since `toasted-notifier` wraps around `terminal-notifier`, you can do anything terminal-notifier can by passing properties to the method.
266
+
239
267
- if `terminal-notifier` says `-message`, you can do `{message: 'Foo'}`
240
268
- if `terminal-notifier` says `-list ALL`, you can do `{list: 'ALL'}`
241
269
@@ -333,6 +361,7 @@ If `sound: true`, **Bottle** is the default sound.
333
361
<br />
334
362
335
363
#### Custom Path
364
+
336
365
`customPath` takes a string which can be either a relative or absolute path to the binary of your fork/custom version of terminal-notifier.
0 commit comments