betsol-load-on-demand
v0.0.0
Published
Resource lazy-loading for browser
Downloads
34
Maintainers
Readme
load-on-demand
Resource lazy-loading for browser.
This small module allows you to load JavaScript and Stylesheet resources asynchronously inside the browser on demand.
Features
- Loads JavaScript and CSS files on demand, triggers your callback function when everything is loaded
- Loads scripts sequentially according to the specified order
- Loads scripts only when necessary (e.g. loads jQuery only if it's not available already)
Dependencies
Right now this module requires jQuery to work. However, this dependency can be easily removed, feel free to submit a PR on this!
Installation
Install library with Bower
bower install --save betsol-load-on-demand
Install library with NPM
npm i --save betsol-load-on-demand
Add library to your page
<script src="/bower_components/betsol-load-on-demand/dist/betsol-load-on-demand.js"></script>
You should use minified version (betsol-load-on-demand.min.js
) in production.
Usage
loadOnDemand({
stylesheets: [
'/css/foo.css',
'/vendor/bar/build/css/bar.css'
],
scripts: {
angular: [
'/vendor/angular/angular.min.js'
],
intlTelInput: [
'/vendor/international-phone-number/international-phone-number.min.js'
],
cfpHotkeys: [
'/vendor/angular-hotkeys/hotkeys.min.js'
]
}
}, function () {
// Your code here!
});
API
@todo
Changelog
Please see the changelog for list of changes.
Feedback
If you have found a bug or have another issue with the library — please create an issue.
If you have a question regarding the library or it's integration with your project — consider asking a question at StackOverflow and sending me a link via E-Mail. I will be glad to help.
Have any ideas or propositions? Feel free to contact me by E-Mail.
Cheers!
FAQ
@todo
Developer guide
Fork, clone, create a feature branch, commit, create a PR.
Run:
npm i
to initialize the projectgulp build
to re-build the dist files
Do not add dist files to the PR itself. We will re-compile the module manually each time before releasing.
Support
If you like this library consider to add star on GitHub repository.
Thank you!
License
The MIT License (MIT)
Copyright (c) 2016 Slava Fomin II, BETTER SOLUTIONS
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.