nav tabs on admin dashboard
This commit is contained in:
158
node_modules/node-notifier/README.md
generated
vendored
158
node_modules/node-notifier/README.md
generated
vendored
@@ -1,4 +1,4 @@
|
||||
# node-notifier [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][depstat-image]][depstat-url]
|
||||
# node-notifier [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]
|
||||
|
||||
Send cross platform native notifications using Node.js. Notification Center for macOS,
|
||||
`notify-osd`/`libnotify-bin` for Linux, Toasters for Windows 8/10, or taskbar balloons for
|
||||
@@ -30,10 +30,10 @@ notifier.notify({
|
||||
|
||||
## Requirements
|
||||
|
||||
* **macOS**: >= 10.8 for native notifications, or Growl if earlier.
|
||||
* **Linux**: `notify-osd` or `libnotify-bin` installed (Ubuntu should have this by default)
|
||||
* **Windows**: >= 8, or task bar balloons for Windows < 8. Growl as fallback. Growl takes precedence over Windows balloons.
|
||||
* **General Fallback**: Growl
|
||||
- **macOS**: >= 10.8 for native notifications, or Growl if earlier.
|
||||
- **Linux**: `notify-osd` or `libnotify-bin` installed (Ubuntu should have this by default)
|
||||
- **Windows**: >= 8, or task bar balloons for Windows < 8. Growl as fallback. Growl takes precedence over Windows balloons.
|
||||
- **General Fallback**: Growl
|
||||
|
||||
See [documentation and flow chart for reporter choice](./DECISION_FLOW.md).
|
||||
|
||||
@@ -45,7 +45,7 @@ npm install --save node-notifier
|
||||
|
||||
## <abbr title="Command Line Interface">CLI</abbr>
|
||||
|
||||
<abbr title="Command Line Interface">CLI</abbr> has moved to separate project:
|
||||
<abbr title="Command Line Interface">CLI</abbr> has moved to separate project:
|
||||
<https://github.com/mikaelbr/node-notifier-cli>
|
||||
|
||||
## Cross-Platform Advanced Usage
|
||||
@@ -80,7 +80,7 @@ notifier.on('timeout', function(notifierObject, options) {
|
||||
});
|
||||
```
|
||||
|
||||
If you want super fine-grained control, you can customize each reporter individually,
|
||||
If you want super fine-grained control, you can customize each reporter individually,
|
||||
allowing you to tune specific options for different systems.
|
||||
|
||||
See below for documentation on each reporter.
|
||||
@@ -119,11 +119,11 @@ new nn.Growl(options).notify(options);
|
||||
|
||||
## Contents
|
||||
|
||||
* [Notification Center documentation](#usage-notificationcenter)
|
||||
* [Windows Toaster documentation](#usage-windowstoaster)
|
||||
* [Windows Balloon documentation](#usage-windowsballoon)
|
||||
* [Growl documentation](#usage-growl)
|
||||
* [Notify-send documentation](#usage-notifysend)
|
||||
- [Notification Center documentation](#usage-notificationcenter)
|
||||
- [Windows Toaster documentation](#usage-windowstoaster)
|
||||
- [Windows Balloon documentation](#usage-windowsballoon)
|
||||
- [Growl documentation](#usage-growl)
|
||||
- [Notify-send documentation](#usage-notifysend)
|
||||
|
||||
### Usage: `NotificationCenter`
|
||||
|
||||
@@ -135,14 +135,15 @@ error will be returned in the callback.
|
||||
|
||||
#### Example
|
||||
|
||||
Because `node-notifier` wraps around [**`terminal-notifier`**](https://github.com/julienXX/terminal-notifier),
|
||||
you can do anything `terminal-notifier` can, just by passing properties to the `notify`
|
||||
method.
|
||||
Because `node-notifier` wraps around [**`terminal-notifier`**](https://github.com/julienXX/terminal-notifier),
|
||||
you can do anything `terminal-notifier` can, just by passing properties to the `notify`
|
||||
method.
|
||||
|
||||
For example:
|
||||
|
||||
- if `terminal-notifier` says `-message`, you can do `{message: 'Foo'}`
|
||||
- if `terminal-notifier` says `-list ALL`, you can do `{list: 'ALL'}`.
|
||||
|
||||
For example:
|
||||
* if `terminal-notifier` says `-message`, you can do `{message: 'Foo'}`
|
||||
* if `terminal-notifier` says `-list ALL`, you can do `{list: 'ALL'}`.
|
||||
|
||||
Notification is the primary focus of this module, so listing and activating do work,
|
||||
but they aren't documented.
|
||||
|
||||
@@ -160,7 +161,7 @@ notifier.notify(
|
||||
{
|
||||
title: void 0,
|
||||
subtitle: void 0,
|
||||
message: void 0,
|
||||
message: void 0,
|
||||
sound: false, // Case Sensitive string for location of sound file, or use one of macOS' native sounds (see below)
|
||||
icon: 'Terminal Icon', // Absolute Path to Triggering Icon
|
||||
contentImage: void 0, // Absolute Path to Attached Image (Content Image)
|
||||
@@ -180,21 +181,21 @@ notifier.notify(
|
||||
);
|
||||
```
|
||||
|
||||
----
|
||||
---
|
||||
|
||||
**Note:** The `wait` option is shorthand for `timeout: 5`. This just sets a timeout
|
||||
for 5 seconds. It does _not_ make the notification sticky!
|
||||
**Note:** The `wait` option is shorthand for `timeout: 5`. This just sets a timeout
|
||||
for 5 seconds. It does _not_ make the notification sticky!
|
||||
|
||||
Without `wait` or `timeout`, notifications are just fired and forgotten. They don't
|
||||
wait for any response.
|
||||
wait for any response.
|
||||
|
||||
To make notifications wait for a response (like activation/click), you must define
|
||||
To make notifications wait for a response (like activation/click), you must define
|
||||
a `timeout`.
|
||||
|
||||
_Exception:_ If `reply` is defined, it's recommended to set `timeout` to a either
|
||||
_Exception:_ If `reply` is defined, it's recommended to set `timeout` to a either
|
||||
high value, or to nothing at all.
|
||||
|
||||
----
|
||||
---
|
||||
|
||||
**For macOS notifications: `icon`, `contentImage`, and all forms of `reply`/`actions` require macOS 10.9.**
|
||||
|
||||
@@ -203,52 +204,57 @@ Sound can be one of these: `Basso`, `Blow`, `Bottle`, `Frog`, `Funk`, `Glass`,
|
||||
|
||||
If `sound` is simply `true`, `Bottle` is used.
|
||||
|
||||
----
|
||||
---
|
||||
|
||||
**See Also:**
|
||||
* [Example: specific Notification Centers](./example/advanced.js)
|
||||
* [Example: input](./example/macInput.js).
|
||||
|
||||
----
|
||||
- [Example: specific Notification Centers](./example/advanced.js)
|
||||
- [Example: input](./example/macInput.js).
|
||||
|
||||
---
|
||||
|
||||
**Custom Path clarification**
|
||||
|
||||
`customPath` takes a value of a relative or absolute path to the binary of your
|
||||
`customPath` takes a value of a relative or absolute path to the binary of your
|
||||
fork/custom version of **`terminal-notifier`**.
|
||||
|
||||
**Example:** `./vendor/terminal-notifier.app/Contents/MacOS/terminal-notifier`
|
||||
**Example:** `./vendor/mac.noindex/terminal-notifier.app/Contents/MacOS/terminal-notifier`
|
||||
|
||||
**Spotlight clarification**
|
||||
|
||||
`terminal-notifier.app` resides in a `mac.noindex` folder to prevent Spotlight from indexing the app.
|
||||
|
||||
### Usage: `WindowsToaster`
|
||||
|
||||
**Note:** There are some limitations for images in native Windows 8 notifications:
|
||||
* The image must be a PNG image
|
||||
* The image must be smaller than 1024×1024 px
|
||||
* The image must be less than 200kb
|
||||
* The image must be specified using an absolute path
|
||||
|
||||
These limitations are due to the Toast notification system. A good tip is to use
|
||||
- The image must be a PNG image
|
||||
- The image must be smaller than 1024×1024 px
|
||||
- The image must be less than 200kb
|
||||
- The image must be specified using an absolute path
|
||||
|
||||
These limitations are due to the Toast notification system. A good tip is to use
|
||||
something like `path.join` or `path.delimiter` to keep your paths cross-platform.
|
||||
|
||||
From [mikaelbr/gulp-notify#90 (comment)](https://github.com/mikaelbr/gulp-notify/issues/90#issuecomment-129333034)
|
||||
|
||||
> You can make it work by going to System > Notifications & Actions. The 'toast'
|
||||
> app needs to have Banners enabled. (You can activate banners by clicking on the
|
||||
> You can make it work by going to System > Notifications & Actions. The 'toast'
|
||||
> app needs to have Banners enabled. (You can activate banners by clicking on the
|
||||
> 'toast' app and setting the 'Show notification banners' to On)
|
||||
|
||||
----
|
||||
---
|
||||
|
||||
**Windows 10 Fall Creators Update (Version 1709) Note:**
|
||||
|
||||
With the Fall Creators Update, Notifications on Windows 10 will only work as
|
||||
expected if the correct `appID` is specified. Your `appID` must be exactly the same
|
||||
With the Fall Creators Update, Notifications on Windows 10 will only work as
|
||||
expected if the correct `appID` is specified. Your `appID` must be exactly the same
|
||||
value that was registered during the installation of your app.
|
||||
|
||||
You can find the ID of your App by searching the registry for the `appID` you
|
||||
specified at installation of your app. For example: If you use the squirrel
|
||||
You can find the ID of your App by searching the registry for the `appID` you
|
||||
specified at installation of your app. For example: If you use the squirrel
|
||||
framework, your `appID` will be something like `com.squirrel.your.app`.
|
||||
|
||||
The default behaviour is to have the underlying toaster applicaton as `appId`.
|
||||
The default behaviour is to have the underlying toaster applicaton as `appId`.
|
||||
This works as expected, but shows `SnoreToast` as text in the notification.
|
||||
|
||||
[**Snoretoast**](https://github.com/KDE/snoretoast) is used to get native Windows Toasts!
|
||||
@@ -362,13 +368,13 @@ See flags and options on the man page [`notify-send(1)`](http://manpages.ubuntu.
|
||||
|
||||
## Thanks to OSS
|
||||
|
||||
`node-notifier` is made possible through Open Source Software.
|
||||
`node-notifier` is made possible through Open Source Software.
|
||||
A very special thanks to all the modules `node-notifier` uses.
|
||||
|
||||
* [`terminal-notifier`](https://github.com/julienXX/terminal-notifier)
|
||||
* [`Snoretoast`](https://github.com/KDE/snoretoast)
|
||||
* [`notifu`](http://www.paralint.com/projects/notifu/)
|
||||
* [`growly`](https://github.com/theabraham/growly/)
|
||||
- [`terminal-notifier`](https://github.com/julienXX/terminal-notifier)
|
||||
- [`Snoretoast`](https://github.com/KDE/snoretoast)
|
||||
- [`notifu`](http://www.paralint.com/projects/notifu/)
|
||||
- [`growly`](https://github.com/theabraham/growly/)
|
||||
|
||||
[![NPM downloads][npm-downloads]][npm-url]
|
||||
|
||||
@@ -376,41 +382,41 @@ A very special thanks to all the modules `node-notifier` uses.
|
||||
|
||||
### Windows: `SnoreToast` text
|
||||
|
||||
See note on "Windows 10 Fall Creators Update" in Windows section.
|
||||
See note on "Windows 10 Fall Creators Update" in Windows section.
|
||||
_**Short answer:** update your `appId`._
|
||||
|
||||
### Use inside tmux session
|
||||
|
||||
When using `node-notifier` within a tmux session, it can cause a hang in the system.
|
||||
When using `node-notifier` within a tmux session, it can cause a hang in the system.
|
||||
This can be solved by following the steps described in [this comment](https://github.com/julienXX/terminal-notifier/issues/115#issuecomment-104214742)
|
||||
|
||||
There’s even more info [here](https://github.com/mikaelbr/node-notifier/issues/61#issuecomment-163560801)
|
||||
There’s even more info [here](https://github.com/mikaelbr/node-notifier/issues/61#issuecomment-163560801)
|
||||
<https://github.com/mikaelbr/node-notifier/issues/61#issuecomment-163560801>.
|
||||
|
||||
### macOS: Custom icon without Terminal icon
|
||||
|
||||
Even if you define an icon in the configuration object for `node-notifier`, you will
|
||||
see a small Terminal icon in the notification (see the example at the top of this
|
||||
document).
|
||||
Even if you define an icon in the configuration object for `node-notifier`, you will
|
||||
see a small Terminal icon in the notification (see the example at the top of this
|
||||
document).
|
||||
|
||||
This is the way notifications on macOS work. They always show the icon of the
|
||||
parent application initiating the notification. For `node-notifier`, `terminal-notifier`
|
||||
is the initiator, and it has the Terminal icon defined as its icon.
|
||||
This is the way notifications on macOS work. They always show the icon of the
|
||||
parent application initiating the notification. For `node-notifier`, `terminal-notifier`
|
||||
is the initiator, and it has the Terminal icon defined as its icon.
|
||||
|
||||
To define your custom icon, you need to fork `terminal-notifier` and build your
|
||||
custom version with your icon.
|
||||
To define your custom icon, you need to fork `terminal-notifier` and build your
|
||||
custom version with your icon.
|
||||
|
||||
See [Issue #71 for more info](https://github.com/mikaelbr/node-notifier/issues/71)
|
||||
See [Issue #71 for more info](https://github.com/mikaelbr/node-notifier/issues/71)
|
||||
<https://github.com/mikaelbr/node-notifier/issues/71>.
|
||||
|
||||
### Within Electron Packaging
|
||||
|
||||
If packaging your Electron app as an `asar`, you will find `node-notifier` will fail to load.
|
||||
If packaging your Electron app as an `asar`, you will find `node-notifier` will fail to load.
|
||||
|
||||
Due to the way asar works, you cannot execute a binary from within an `asar`.
|
||||
As a simple solution, when packaging the app into an asar please make sure you
|
||||
`--unpack` the `vendor/` folder of `node-notifier`, so the module still has access to
|
||||
the notification binaries.
|
||||
Due to the way asar works, you cannot execute a binary from within an `asar`.
|
||||
As a simple solution, when packaging the app into an asar please make sure you
|
||||
`--unpack` the `vendor/` folder of `node-notifier`, so the module still has access to
|
||||
the notification binaries.
|
||||
|
||||
You can do so with the following command:
|
||||
|
||||
@@ -418,15 +424,19 @@ You can do so with the following command:
|
||||
asar pack . app.asar --unpack "./node_modules/node-notifier/vendor/**"
|
||||
```
|
||||
|
||||
### Using with pkg
|
||||
|
||||
For issues using with the pkg module. Check this issue out: https://github.com/mikaelbr/node-notifier/issues/220#issuecomment-425963752
|
||||
|
||||
### Using Webpack
|
||||
|
||||
When using `node-notifier` inside of `webpack`, you must add the snippet below to your `webpack.config.js`.
|
||||
When using `node-notifier` inside of `webpack`, you must add the snippet below to your `webpack.config.js`.
|
||||
|
||||
This is necessary because `node-notifier` loads the notifiers from a binary, so it
|
||||
needs a relative file path. When webpack compiles the modules, it supresses file
|
||||
directories, causing `node-notifier` to error on certain platforms.
|
||||
This is necessary because `node-notifier` loads the notifiers from a binary, so it
|
||||
needs a relative file path. When webpack compiles the modules, it supresses file
|
||||
directories, causing `node-notifier` to error on certain platforms.
|
||||
|
||||
To fix this, you can configure webpack to keep the relative file directories.
|
||||
To fix this, you can configure webpack to keep the relative file directories.
|
||||
Do so by append the following code to your `webpack.config.js`:
|
||||
|
||||
```javascript
|
||||
@@ -445,5 +455,3 @@ node: {
|
||||
[npm-downloads]: http://img.shields.io/npm/dm/node-notifier.svg?style=flat
|
||||
[travis-url]: http://travis-ci.org/mikaelbr/node-notifier
|
||||
[travis-image]: http://img.shields.io/travis/mikaelbr/node-notifier.svg?style=flat
|
||||
[depstat-url]: https://gemnasium.com/mikaelbr/node-notifier
|
||||
[depstat-image]: http://img.shields.io/gemnasium/mikaelbr/node-notifier.svg?style=flat
|
||||
|
||||
Reference in New Issue
Block a user