Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nightowl888/jquery.dirtyforms.dialogs.pnotify.dist
A jQuery Plugin module to enable automatic PNotify dialog support when using jQuery Dirty Forms.
https://github.com/nightowl888/jquery.dirtyforms.dialogs.pnotify.dist
Last synced: 5 days ago
JSON representation
A jQuery Plugin module to enable automatic PNotify dialog support when using jQuery Dirty Forms.
- Host: GitHub
- URL: https://github.com/nightowl888/jquery.dirtyforms.dialogs.pnotify.dist
- Owner: NightOwl888
- License: mit
- Created: 2015-06-29T19:19:46.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-01-30T11:15:48.000Z (almost 9 years ago)
- Last Synced: 2024-11-10T23:37:27.721Z (5 days ago)
- Language: JavaScript
- Homepage: https://github.com/snikch/jquery.dirtyforms
- Size: 18.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.myget.org/)
# jquery.dirtyforms.dialogs.pnotify
This is a dialog module for the [jQuery Dirty Forms](https://github.com/snikch/jquery.dirtyforms) project.
## Purpose
This module causes Dirty Forms to use PNotify as its dialog when the user attempts to leave the page by clicking a hyperlink (but not when interacting with the navigation buttons of the browser).
> Only 1 dialog module can be used by Dirty Forms at a time. The default behavior without this package is to use the browser's built in dialog that is fired by the `beforeunload` event.
## Prerequisites
Prerequesites must be included in this order:
- CSS theme from [BootStrap 3](http://getbootstrap.com/), [jQuery UI](http://jqueryui.com/themeroller/), or [Font Awesome](http://fontawesome.io/)
- [jQuery](http://jquery.com) (>= 1.6.0)
- [PNotify](http://sciactive.com/pnotify/) (>= 1.3) - both the CSS and JS
- [jquery.dirtyforms](https://github.com/snikch/jquery.dirtyforms) (>= 1.0.0)
**NOTE:** In PNotify 3.x, you must include the Confirm module and the History module JavaScript files after the main PNotify file.
> If you are using a [Package Manager](#package-managers), the JavaScript dependencies will be installed automatically, but you will need to manually get a CSS theme if you are not already using one. Also, depending on your environment you may still need to add references to the JavaScript manually.
## Download & Installation
There are several different ways to get the code. Some examples below:
#### CDN
The PNotify dialog module is available over jsDelivr CDN and can directly be included on every page.
```HTML
```
jsDelivr also supports [on-the-fly concatenation of files](https://github.com/jsdelivr/jsdelivr#load-multiple-files-with-single-http-request), so you can reference only 1 URL to get jQuery, PNotify, jquery.dirtyforms, and jquery.dirtyforms.dialogs.pnotify in one request.
```HTML
```
#### Self-Hosted
Download and save one of two available files to include the PNotify dialog module to your page, either the [latest distribution](https://raw.githubusercontent.com/NightOwl888/jquery.dirtyforms.dialogs.pnotify.dist/master/jquery.dirtyforms.dialogs.pnotify.js) or the [latest minified](https://raw.githubusercontent.com/NightOwl888/jquery.dirtyforms.dialogs.pnotify.dist/master/jquery.dirtyforms.dialogs.pnotify.min.js) version.
```HTML
```
You can also conveniently get all of the latest Dirty Forms files in one [Zip Download](https://github.com/NightOwl888/jquery.dirtyforms.dist/archive/master.zip).
#### Package Managers
The PNotify dialog module is even available through [NPM](http://npmjs.org), [Bower](http://bower.io), and [NuGet](https://www.nuget.org/). Just use one of the following commands below to install the dialog module, including all dependencies.
[](http://www.npmjs.org/package/jquery.dirtyforms.dialogs.pnotify)
[](http://bower.io/search/?q=jquery.dirtyforms.dialogs.pnotify)
[](https://www.nuget.org/packages/jquery.dirtyforms.dialogs.pnotify/)
[](https://nodei.co/npm/jquery.dirtyforms.dialogs.pnotify/)
```
// NPM
$ npm install jquery.dirtyforms.dialogs.pnotify
// Bower
$ bower install jquery.dirtyforms.dialogs.pnotify
// NuGet
PM> Install-Package jquery.dirtyforms.dialogs.pnotify
```
## SourceMaps
A [SourceMap](https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k/edit?hl=en_US&pli=1&pli=1) file is also available via CDN or your favorite package manager.
#### CDN
```HTML
```
#### Package Managers
Bower and NuGet will install the SourceMap file into the destination directory.
```
jquery.dirtyforms.dialogs.pnotify.min.js.map
```
## Usage
This dialog module is automatic. Simply include the reference to the dialog module after the [prerequisites](#prerequisites) and use Dirty Forms [as per the documentation](https://github.com/snikch/jquery.dirtyforms#usage) and PNotify [as per the documentation](http://sciactive.com/pnotify/).
```HTML
// Theme (use one of: BootStrap 3, jQuery UI, or Font Awesome)
// BootStrap 3
// jQuery UI (many other themes available at [jsDelivr](https://github.com/jsdelivr/jsdelivr/tree/master/files/jquery.ui/1.11.3/themes))
// Font Awesome
// PNotify (required)
// JavaScript (required)
```
> If not using a CDN, you need to apply the dependencies in the same order as in the example above.
## Options
The following options are available to set via **$.DirtyForms.dialog.OPTIONNAME = OPTIONVALUE** or get via **OPTIONVALUE = $.DirtyForms.dialog.OPTIONNAME**
Name
Type
Default
Description
title
string
'Are you sure you want to do that?'
Sets the title of the dialog.
class
string
'dirty-dialog'
Sets the CSS class of the DIV element (SPAN if using PNotify 1.3) that contains all of the elements of the dialog.
proceedButtonText
string
'Leave This Page'
Sets the text of the continue button of the dialog.
stayButtonText
string
'Stay Here'
Sets the text of the cancel button of the dialog.
styling
string
'bootstrap3'
Sets the CSS theme you want to style PNotify. Available choices: 'bootstrap3', 'jqueryui', or 'fontawesome'. See the theme section of the PNotify documentation for details.
width
string
'330'
Sets the width of the dialog.