@itsmistad/notify.js
v1.0.1
Published
A simple notification UI package.
Readme
notify.js
This is a simple, lightweight notification UI package for web applications.
Note: This library requires @itsmistad/network.js for server-to-client notifications. Without network.js, notify.initNetwork will not work.
Importing
CDN
In your .html file, add this to your <head> tag
<!-- Required Dependencies --->
<script src="https://code.jquery.com/jquery-3.4.1.min.js"></script>
<!-- Optional Dependencies --->
<script src="https://cdnjs.cloudflare.com/ajax/libs/aspnet-signalr/1.1.4/signalr.min.js"></script>
<script src="https://cdn.mistad.net/network.js"></script>
<!-- notify.js --->
<script src="https://cdn.mistad.net/notify.js"></script>
<link href="https://cdn.mistad.net/notify.min.css" rel="stylesheet">Default Options
targetSelector: 'body'
What element selector to use when adding the notification using the "targetMethod"
targetMethod: 'append'
How to add the notification to the "targetSelector" ('prepend', 'append', 'before', and 'after')
class: 'notify-popup'
The string list of style classes for the element's class attribute
header: ''
The html header of the notification ('' = disabled and hidden)
subheader: ''
The html subheader of the notification ('' = disabled and hidden)
body: ''
The html body of the notification ('' = disabled and hidden)
closeButton: true
Toggles the close button
timeout: 0
How long (in ms) until the notification closes (0 = disabled)
fadeOutDuration: 400
How long (in ms) does the fade out animation last
fadeInDuration: 800
How long (in ms) does the fade in animation last
layer: defaultNotificationLayer
The z-index layer of the notification
onStartClose: () => { }
The event that gets called when the notification starts closing
onClose: () => { }
The event that gets called when the notification is fully closed
handleAsStack: false
Toggles handling FIFO notification stacks by sliding down the notifications after an older sibling is closed
maxInStack: 4
The maximum amount of notifications that can be added to the stack at once when "handleAsStack" is true
sound: ''
The sound name that was specified with "notify.initSound(name, file)"
buttons: []
The list of button objects to insert into the notification form
buttons: [
{
text: 'OK',
class: '', // The string list of style classes for the element's class attribute
action: button => { }, // The event that gets called when the button is clicked
close: true // Toggles whether the button closes the notification when clicked
}
]CSS
notify.js uses the following style-class structure:
.notify-popup | .notify-popup.corner
∟ .header
∟ .subheader
∟ .body
∟ .buttonsUsage
Initialize a notification sound:
notify.initSound([file path])
notify.initSound('/path/to/mp3/');Connect to the server's /Notify hub:
notify.initNetwork([optional action])
notify.initNetwork(() => {
// Do any additional stuff between the client and hub.
});Toggle the notification overlay layer:
notify.overlay([toggle state], [optional fade duration], [optional opacity])
network.overlay(true, 300, 0.3);Create a center notification:
notify.me([options object])
/*
* notification contains the following properties:
* - id (element id)
* - $ (jQuery object)
* - options (the options it was originally invoked with)
* - close() (closes the notification)
*/
var notification = notify.me({
header: 'Test Notification',
subheader: 'This is a test',
body: 'This is a test!',
onStartClose: () => {
notify.overlay(false);
},
closeButton: true
});
notify.overlay(true);Create a corner notification:
notify.me([options object])
/*
* This assumes you have <div id="notify-queue"></div> somewhere on your page.
*/
notifiy.initSound('default', 'https://cdn.mistad.net/notify.mp3');
notify.me({
class: 'notify-popup corner',
subheader: 'Welcome',
body: 'This is a test corner notification.',
handleAsStack: true,
buttons: [],
fadeInDuration: 200,
fadeOutDuration: 300,
targetSelector: '#notify-queue',
targetMethod: 'prepend',
sound: 'default'
});