Introduction
The iframe-resizer library aims to take away the pain points with using iframes. It will resize your iframe to match the size of your content and then monitor the iframe to ensure that it is always the perfect size.
As browsers don’t provide a single consistently reliable method to calculate content size, iframe-resizer automatically inspects your page and selects the best value for your content every time it detects something changed.
Supports both internal (same-domain) and external (cross-domain) iframes via a simple JS file that is designed to be a zero impact guest on the sites hosting it.
Extended API
Additionally iframe-resizer provides a range of missing browser API features, that allows you to securely integrate your iframe content with the parent page.
- Scroll the page, relative to the iframe or parent page’s position
- Get details of the position of the iframe, the scroll position and viewport of the parent page
- Fixes in page linking in the iframe and allows links to propagate to the parent page
- Adds onMouseEnter and onMouseLeave events to the iframe element
- Simplified message passing between the iframe and the parent page
- Automatic domain authentication
When combined with viewer.js it can even resize iframes containing PDF and ODF documents.
Setup and API guide
Please see the iframe-resizer website for setup guides and API documentation. This includes versions for:
Along with setup guides for:
Their is also an API to support the creation of additional custom components.
Version 5
This version of iframe-resizer has been extensively rewritten to use modern browser APIs, this has enabled significantly better performance and greater accuracy in the detection of content resizing events.
With this release, the opportunity has been taken to refresh and simplify the API, if you are coming from a previous version then their is an Upgrade Guide to explain the changes.
Main packages
For version 5 iframe-resizer is split into two main packages to make it simpler to deploy across different domains and better support tree shaking. These two packages can be installed from NPM, or downloaded as a zip file.
The parent page package sets up an iframe for automatic content resizing. Their are versions of this package for several popular libraries and frameworks (see below).
This package needs loading into the iframe, where it will quietly wait for a message from the parent page before initialising. It is designed to be a good guest on someone else site.
Frameworks and Libraries
In addition to the two main packages, their are versions of the parent package for the following platforms.
A React component for the parent page.
A Vue component for the parent page.
A simple jQuery wrapper for the parent page.
API
The core API for the parent page, used by @iframe-resizer/parent, plus the framework and library component versions.
Copyright © 2013-24 David J. Bradshaw - Licensed under the GPL V3