A lightweight jQuery plugin that help create a modal dialog.
- Main files
- Quick start
- Requirements
- Usage
- Examples
- Options
- Methods
- Events
- No conflict
- Browser support
- Contributing
- Development
- Changelog
- Copyright and license
dist/
├── jquery-asModal.js
├── jquery-asModal.es.js
├── jquery-asModal.min.js
└── css/
├── asModal.css
└── asModal.min.css
Several quick start options are available:
- Development - unminified
- Production - minified
bower install jquery-asModal --save
npm install jquery-asModal --save
yarn add jquery-asModal
If you want build from source:
git clone git@github.com:amazingSurge/jquery-asModal.git
cd jquery-asModal
npm install
npm install -g gulp-cli babel-cli
gulp build
Done!
jquery-asModal
requires the latest version of jQuery
.
<link rel="stylesheet" href="/path/to/asModal.css">
<script src="/path/to/jquery.js"></script>
<script src="/path/to/jquery-asModal.js"></script>
<button href="login.html" class="example">click to open modal</button>
All you need to do is call the plugin on the element:
jQuery(function($) {
$('.example').asModal();
});
There are some example usages that you can look at to get started. They can be found in the examples folder.
jquery-asModal
can accept an options object to alter the way it behaves. You can see the default options by call $.asModal.setDefaults()
. The structure of an options object is as follows:
{
namespace: 'modal', // String: Prefix string attached to the class of every element generated by the plugin
skin: null, // set plugin skin
content: null, // Set the URL, ID or Class.
overlay: true, // Show the overlay.
closeElement: null, // Element ID or Class to close the modal
effect: 'fadeScale', // fadein | slide | newspaper | fall
overlaySpeed: 200, // Sets the speed of the overlay, in milliseconds
effectFallback: 'fade', // set default jquery animate when css3 animation doesn't support
focus: true, // set focus to form element in content
errorContent: 'sorry, ajax error.', // set ajax error content
loadingContent: 'loading...', // set loading content
closeByEscape: true, // Allow the user to close the modal by pressing 'ESC'.
closeByOverlayClick: true, // Allow the user to close the modal by clicking the overlay.
width: null, // Set a fixed total width.
hieght: null, // Set a fixed total height.
// Callback API
onOpen: null, // Callback: function() - Fires when the modal open
onClose: null // Callback: function() - Fires when the modal close
//onComplete: null // Callback: function() - Fires when the effect end
}
Methods are called on asModal instances through the asModal method itself. You can also save the instances to variable for further use.
// call directly
$().asModal('destroy');
// or
var api = $().data('asModal');
api.destroy();
Move the modal handle to the position.
// move to 50px
$().asModal('moveTo', '50');
// move to 50%
$().asModal('moveTo', '50%');
Open the modal.
$().asModal('open');
Close the modal.
$().asModal('close');
Enable the modal functions.
$().asModal('enable');
Disable the modal functions.
$().asModal('disable');
Destroy the modal instance.
$().asModal('destroy');
jquery-asModal
provides custom events for the plugin’s unique actions.
$('.the-element').on('asModal::ready', function (e) {
// on instance ready
});
Event | Description |
---|---|
ready | Fires when the instance is ready for API use. |
enable | Fired when the enable instance method has been called. |
disable | Fired when the disable instance method has been called. |
destroy | Fires when an instance is destroyed. |
If you have to use other plugin with the same namespace, just call the $.asModal.noConflict
method to revert to it.
<script src="other-plugin.js"></script>
<script src="jquery-asModal.js"></script>
<script>
$.asModal.noConflict();
// Code that uses other plugin's "$().asModal" can follow here.
</script>
Tested on all major browsers.
Latest ✓ | Latest ✓ | Latest ✓ | Latest ✓ | 9-11 ✓ | Latest ✓ |
As a jQuery plugin, you also need to see the jQuery Browser Support.
Anyone and everyone is welcome to contribute. Please take a moment to
review the guidelines for contributing. Make sure you're using the latest version of jquery-asModal
before submitting an issue. There are several ways to help out:
- Bug reports
- Feature requests
- Pull requests
- Write test cases for open bug issues
- Contribute to the documentation
jquery-asModal
is built modularly and uses Gulp as a build system to build its distributable files. To install the necessary dependencies for the build system, please run:
npm install -g gulp
npm install -g babel-cli
npm install
Then you can generate new distributable files from the sources, using:
gulp build
More gulp tasks can be found here.
To see the list of recent changes, see Releases section.
Copyright (C) 2016 amazingSurge.
Licensed under the LGPL license.