This software is maintained under a new repository located at yowainwright/reframe.js
🖼 Reframe.js
Reframe.js is a javascript plugin that makes elements scale at a fixed ratio.
This is particularly awesome for making embedded stuff, like videos or playlists, scale appropriately within a content area. This can done by hand but it's difficult to maintain, especially with CMS's and multiple editors. Reframe.js solves this issue—perfectly!
Alternatively, noframe.js is provided. Noframe.js scales selected elements at a fixed ratio but does not manipulate the dom's element structure at all! This keeps things like analytic events that run on embedded content intact!
Installing
NPM
npm i reframe.js --saveYarn
yarn add reframe.jsSetup
- Add
dist/reframe.js reframethe element you'd like to re-frame.
Examples
reframe('iframe'); // Wrap all iFrames in the page
reframe(document.getElementById('my-frame')); // Pass a DOM element
reframe(document.querySelectorAll('.my-targets')) // Pass a live node listElements that have been wrapped with reframe will not be wrapped twice.
How?
Reframe.js wraps a specified element in a div that is an intrinsic ratio of the original element. This plugin is great for embedded content like iframes or videos.
Why Reframe.js?
Reframe.js is inspired by FitVids and does what FitVids does but without the need for jQuery. This makes the plugin highly valuable when including it in a module that has to be very small and with minimal dependencies. Here's a basic codepen example.
This plugin is small - ~1.3kb unminified and is meant to do 1 thing - wrap elements that aren't responsive and make them responsive.
Options
If you'd like to not use the classname 'js-reframe', just use your own.
reframe('iframe', 'my-classname');jQuery
Reframe.js works with jQuery or Zepto. As of version 2.0.0, use jquery.reframe.js for jQuery or Zepto.
$('iframe').reframe();
// While using a custom class name
$('iframe').reframe('my-classname');🌐 Noframe.js
Noframe.js makes the same ratio as Reframe.js using css calc.
Noframe.js's doesn't wrap the element you'd like to be responsive. It, instead, does a calculation based on its or a parent element's max-width. Here's a basic codepen example.
Noframe.js Notes
- The reframed element requires a parent element with a
max widthto scale above the selected elements intial size otherwise the reframed element will only scale below its initial size.👍
Setup
- Add
dist/noframe.js noframethe element you'd like to re-frame.
Examples
noframe('iframe');
noframe('iframe', 'parent');jQuery
Noframe.js works with jQuery or Zepto. As of version 2.0.0, use jquery.noframe.js for jQuery or Zepto.
$('iframe').noframe();
$('iframe').noframe('parent');Reframe.js or Noframe.js?
Reframe.js offers the simplest solution to making elements scale at an intrinsic ratio.
Noframe.js doesn't wrap the selected element to make it scale at an intrinsic ratio. Noframe.js is the ideal solution when various events, like tracking events, could be affected when an element is wrapped. It does require a width or max-width which can involve a bit more setup awareness.
Created and maintained by Jeff Wainwright with Dollar Shave Club Engineering.