Skip to content

An open-source jQuery plugin to easily and semantically add captions to images.

Notifications You must be signed in to change notification settings

ericmagnuson/captionjs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

01f75bf · Feb 25, 2017

History

73 Commits
Feb 3, 2017
Feb 3, 2017
Feb 3, 2017
Apr 4, 2014
Feb 3, 2017
Feb 25, 2017
Feb 25, 2017
Feb 3, 2017
Feb 3, 2017
Feb 3, 2017
Feb 3, 2017

Repository files navigation

Documentation

Install using NPM:

npm install --save captionjs

Install using Bower:

bower install captionjs

Below is the basic setup for caption.js. For more info, please see captionjs.com.

$(window).load(function() {
    $('img.caption').captionjs({
		'class_name'      : 'captionjs', // Class name for each <figure>
		'schema'          : true,        // Use schema.org markup (i.e., itemtype, itemprop)
		'mode'            : 'default',   // default | stacked | animated | hidden (deprecated: hide)
		'debug_mode'      : false,       // Output debug info to the JS console
		'force_dimensions': true,        // Force the dimensions in case they cannot be detected (e.g., image is not yet painted to viewport)
		'is_responsive'   : false,       // Ensure the figure and image change size when in responsive layout. Requires a container to control responsiveness!
		'inherit_styles'  : false        // Have the caption.js container inherit box-model properties from the original image
	});
});