Need help with object-fit-polyfill?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

constancecchen
495 Stars 102 Forks ISC License 83 Commits 5 Opened issues

Description

A Javascript polyfill for browsers that don't support the object-fit CSS property.

Services available

!
?

Need anything else?

Contributors list

object-fit-polyfill

A polyfill for browsers that don't support the

object-fit
CSS property. Unsure of what the
object-fit
does? Essentially
object-fit
is to
tags what
background-size
is to
background-image
. You can check out the MDN page for more details.

Features

  • Works with
    img
    ,
    picture
    ,
    srcset
    ,
    video
    , and
    canvas
  • Supports
    object-position
  • Supports IE 9+, Edge 18-, iOS 7-, and Android 4.4-
  • Lightweight
    • 3KB (2KB with the basic version)
    • No dependencies: vanilla Javascript (works with or without jQuery)
  • Flexible usage

Requirements

  • This plugin requires setting data attributes on elements that you want polyfilled (
    data-object-fit
    ).
  • This plugin makes the assumption that the parent container is acting as a picture frame - it must have a height & width set.

Demo

You can check out the bare-bones demo here. Note that the plugin simply won't do anything if you're on a browser that already supports object-fit, so you'll want to test it on IE or older iOS/Android browsers.

How does it work?

Unlike object-fit-images or Primož Cigler's method (both excellent alternatives if you'd rather not use this one), this polyfill does not set a background image on the parent container, but instead resizes and repositions the image (using inline CSS for height, width, absolute positioning, and negative margins).

The polyfilled item will receive the class

object-fit-polyfill
if styling issues occur that require overrides.

Why bother?

If you're wondering: why bother using

tags versus
background-image
? Here's a couple reasons:
  1. tags have better SEO/crawling visibility.
  2. In cases where images are dynamically returned and can't simply be added to your stylesheets (e.g., CMS's), you're forced to inline your background-image. This solves that somewhat-ugly-looking inline CSS.
  3. background-image
    doesn't work with
    picture
    ,
    video
    , or
    canvas
    elements.

Of course, there's still plenty of cases where using a background image makes more sense than a regular image.

Usage

Initialization:


Customized object-fit/object-position:

If you're only interested in using the basic polyfill (which assumes

object-fit: cover
and
object-position: 50% 50%
), you can save yourself some bytes by using:

Advanced usage

If you need to dynamically call the polyfill on the fly for any reason (for example, carousels or lazy-loaded images), you can do so quite easily:

// Rerun the polyfill on all elements with the data attribute
objectFitPolyfill();

// Rerun the polyfill on a single DOM node var element = document.querySelector('.foo'); objectFitPolyfill(element);

// Rerun the polyfill on multiple elements var elements = document.querySelectorAll('.bar'); objectFitPolyfill(elements);

// Rerun the polyfill with a jQuery selector objectFitPolyfill($('.baz'));

Installation via package managers

If you prefer not to manually add Javascript files to your sites, you can use bower and npm like so:

npm install objectFitPolyfill
yarn add objectFitPolyfill
# Or:
bower install objectFitPolyfill

Usage within a modern ES6/webpack JS project

import 'objectFitPolyfill';
// Or:
require('objectFitPolyfill');

window.objectFitPolyfill();

Note that in SPA's, you must manually call

window.objectFitPolyfill()
after component mount / once you're sure your media is loaded in & available. See this example React usage.

Requests?

If you'd like to make feature requests such as IE 8- or adding object-position support for Safari, feel free to open an issue or pull request! It's doable and on my radar, but I probably won't get to it without some prodding.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.