Have ideas to improve npm?Join in the discussion! »

    imgload

    1.0.2 • Public • Published

    imgload

    imgload loads an image src and fires events (properly fires even if image is cached!).

    For radical image loading, use the module built with imgload: Mad Basic Loader.

    Getting Started

    imgload is meant to be consumed in a CommonJS, Browserify environment (though you can also use a pre-bundled version, more below):

    npm i imgload
    

    Usage

    // require
    var imgload = require('imgload')
    
    // setup
    var loadme = imgload('image.jpg')
    
    // start!
    loadme.start()
    

    Events

    Events are fired. Bind to events like so:

    loadme.on('error', function(data) {
    	// triggered on image error
    })
    
    loadme.on('load', function(data) {
    	// triggered on image load
    })
    
    loadme.on('always', function(data) {
    	// triggered on image load
    })
    

    The on method returns this for chainability:

    loadme
    	.on('error', beep)
    	.on('load', bop)
    	.on('always', boop)
    

    Bundled Version

    If you don't want to mess with a build process you can also include the pre-bundled version found in dist/imgload.bundled.js in your project which exposes imgload() globally.

    Todo

    • Tests

    Install

    npm i imgload

    DownloadsWeekly Downloads

    4

    Version

    1.0.2

    License

    MIT

    Last publish

    Collaborators

    • avatar