0.4.1 • Published 10 years ago

jquery-nodeico v0.4.1

Weekly downloads
12
License
-
Repository
-
Last release
10 years ago

A jQuery plugin to display your Node Modules on NPM.

Getting started

Three quick start options are available:

Setup

Use Bower to fetch all dependencies:

$ bower install

Now you're ready to go!

Usage

HTML

<div id="example"></div>

Include jQuery:

<script src="//ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>

Include plugin's JS:

<script src="jquery.nodeico.min.js"></script>

Call the plugin:

$("#example").nodeico();

Check full example's source code.

Options

Here's a list of available settings.

$("#example").nodeico({
    name: 'some-node-module',
    type:  'standard',
    downloads:  true,
    rank: true,
    stars: true
});
AttributeTypeDefaultDescription
nameStringjquery-nodeicoThe name of the node module.
typeStringstandardHow is the badge ('standard', 'mini', 'compact', 'histogram').
downloadsBooleanfalseDisplays the number of downloads that the module has.
rankBooleanfalseDisplays the download rank of the module.
starsBooleanfalseDisplays the number of stars that the module has.
monthsNumber1How many months ago should display ('12', '9', '6', '3', '1').
heightNumber1The height of the histograms, there are 3 heights ('1', '2', '3')

Credits

Built on top of nodei.co.

Used jQuery Boilerplate to generate the structure.

License

MIT License © Lucas Vieira

0.4.1

10 years ago

0.4.0

10 years ago

0.3.2

10 years ago

0.3.1

10 years ago