https://github.com/ericmagnuson/captionjs

An open-source jQuery plugin to easily and semantically add captions to images.
https://github.com/ericmagnuson/captionjs

accessibility caption captions css javascript js schema

Last synced: about 15 hours ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ericmagnuson/captionjs
• Owner: ericmagnuson
• Created: 2012-05-10T05:08:56.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2017-02-25T23:44:48.000Z (over 7 years ago)
• Last Synced: 2024-11-13T20:36:29.168Z (5 days ago)
• Topics: accessibility, caption, captions, css, javascript, js, schema
• Language: CSS
• Homepage: https://captionjs.com
• Size: 1.05 MB
• Stars: 62
• Watchers: 7
• Forks: 11
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
## Documentation

Install using NPM:

```bash

npm install --save captionjs

```

Install using Bower:

```bash

bower install captionjs

```

Below is the basic setup for caption.js.  For more info, please see [captionjs.com](http://captionjs.com).

```js

$(window).load(function() {

    $('img.caption').captionjs({

		'class_name'      : 'captionjs', // Class name for each 

		'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

	});

});

```