readme.md

DEPRECATED

This is no longer supported, please consider using the CSS property object-fit instead.

For Fit Sake

A jQuery object-fit polyfill for Internet Explorer and Edge

For Fit Sake is a polyfill for browsers that do not support the CSS property object-fit. Inspired by this Medium post, currently the only requirement is jQuery.

The plugin will only currently object-fit images (we've yet to encounter a use case where it would be anything else). It already includes the Modernizr check, so no extra libraries are needed.

It works by applying the image as a background image in unsupported browsers to it's parent so you can use background-size.

Configuration

forFitSake has only two configuration options:

Parameter	Default	Description
class	'hasForFitSake'	The class applied to the element if it does not support object-fit (without the .)
includeDetection	true	Whether to include the Modernizr detection (only set to false if you have already included Modernizr)
debug	false	Bypass Modernizr and apply the background image no matter what (will console log)

e.g.

$('div').forFitSake({
	class: 'hasForFitSake',
	includeDetection: true,
	debug: true
});

Example

HTML:

<div class="parent">
	<img src="path/to/image">
</div>

CSS:

.parent {
	width: 12rem;
	height: 12rem;
	background-position: center;
	background-size: cover; /* Should match the object-fit prop */
}
.parent img {
	display: block;
	width: 100%;
	height: 100%;
	object-fit: cover;
}
.hasForFitSake img {
	visibility: hidden;
}

JS:

The selector is the parent containing the image

$('.parent').forFitSake();

Contributing

We welcome pull requests and issues!

If making a PR, it would be handy if you could please run npm run dist before committing and pushing. To run this you will need uglifyjs installed as a global module.

If you can't run it, don't let it put you off - we'll run it our end 😀