Skip to content

klev-o/alert-notify

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Alert Notifications

Simple fully customisable JQuery plugin for notifications

Requirements

Installation

<head>
<!-- ...your stuff... -->
<link href="your path to alertNotify.min.css" type="text/css" rel="stylesheet"/>
</head>

<body>
<!-- ...your stuff... -->
<script src="your path to alertNotify.min.js"></script>
</body>

Basic Usage

var notify = new AlertNotify({
    enable_fa: false
});
notify.showNotification({
    text: 'test'
});

Advanced Usage

var notify = new AlertNotify({
    enable_fa: true, // font awesome is required
    vertical_align: 'bottom',
    horizontal_align: 'right',
    animateIn: 'fade',
    animateOut: 'fade',
    timeIn: 500,
    timeOut: 1500,
    duration: 3500,
    classPrefix: 'alert-notify'
});
notify.showNotification({
    html: '<h4>My advanced title</h4><p>My notify text</p>'
});

Global Options:

enable_fa

Enable/Disable usage of Font Awesome

var notify = new AlertNotify({
    enabe_fa: true
});

Possible values: true/false

Default value: true

vertical_align

Vertical positioning of notifications block

var notify = new AlertNotify({
    vertical_align: 'bottom'
});

Possible values:

  • 'top'
  • 'bottom'

Default value: 'top'

horizontal_align

Horizontal positioning of notifications block

var notify = new AlertNotify({
    horizontal_align: 'right'
});

Possible values:

  • 'right'
  • 'left'
  • 'center'

Default value: 'right'

animateIn/animateOut

Appear/Disappear animation

var notify = new AlertNotify({
    animateIn: 'fade',
    animateOut: 'slide'
});

Possible values:

  • 'basic'
  • 'slide'
  • 'fade'

Default value: 'fade'/'fade'

timeIn/timeOut

Appear/Disappear animation timeout

var notify = new AlertNotify({
    timeIn: 2500,
    timeOut: 1000
});

Possible values: any integer

Default value: 500/1500

duration

Duration of notification

var notify = new AlertNotify({
    duration: 2500
});

Possible values: any integer

Default value: 3500

classPrefix

Class prefix for all elements of alert-notify

var notify = new AlertNotify({
    classPrefix: 'my-awesome-class'
});

Notify Options:

type

Type of notification

notify.showNotification({
    type: 'warning'
});

Possible values:

  • 'default'
  • 'success'
  • 'warning'
  • 'error'

Default value: 'default' :)

title

Title of notification

notify.showNotification({
    title: 'test'
});

Possible values: any text

text (required if 'html' option not set)

Text of notification

notify.showNotification({
    text: 'test'
});

Possible values: any text

html (required if 'text' option not set) Html content of notification

notify.showNotification({
    html: '<p>my awesome html code</p>'
});

Possible values: any valid html code

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 83.3%
  • CSS 16.7%