# set-iframe-height

> cross-domain responsive iframes: automatically set iframe height to fit iframe content

Latest version **2.1.1** (published 2020-02-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install set-iframe-height
pnpm add set-iframe-height
yarn add set-iframe-height
bun add set-iframe-height
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2020-02-21 |
| First published | 2015-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 98.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 44 |
| Author | Jonas Fischer-Maeck |
| Maintainers | jfmaeck |
| Keywords | iframe, responsive |

## Links

- npm: https://www.npmjs.com/package/set-iframe-height
- Repository: https://github.com/FaiblUG/setIframeHeight
- Homepage: https://github.com/FaiblUG/setIframeHeight#readme
- Issues: https://github.com/FaiblUG/setIframeHeight/issues
- npm.io page: https://npm.io/package/set-iframe-height

## Recent versions

- 2.1.1 (latest) — 2020-02-21
- 2.1.0 — 2018-03-14
- 2.0.0 — 2018-01-02
- 1.3.1 — 2016-05-01
- 1.1.5 — 2015-03-20
- 1.1.4 — 2015-03-20
- 1.1.3 — 2015-03-20
- 1.1.1 — 2015-02-03
- 1.0.4 — 2015-02-03
- 1.0.3 — 2015-02-03

## README

setIframeHeight
==============================

Automatically adjust iframe height to fit the lenght of the displayed page - works cross-domain


Demo
----

[http://faiblug.github.io/setIframeHeight/](http://faiblug.github.io/setIframeHeight/)


Usage
-----

### Parent Page

#### 1. Include iframe
    
    <iframe scrolling="no" src="..."></iframe>
   
#### 2. Include Script
    
    <script src="dist/set-iframe-height-parent-min.js" async></script>

### Iframe Page

#### 1. Include Script
    
    <script src="dist/set-iframe-height-child-min.js" async></script>
    
### Advanced Options

#### Deep Links

If you want you parent url to be updated whenever the iframe url changes, you need to supply a deep link pattern on the iframe tag:

    <iframe src="..." data-iframeAutoHeight-deepLinkPattern="/path/to/parent-page/?iframe_target=%deepLinkIframeSrc%"></iframe>
    
When rendering your page, you need to validate the value of the iframe_target GET Parameter and if it is valid, you can put the value into the iframe src attribute.

This allows the user to reload, bookmark or share deep-linked iframe content within your parent frame.

If you need to take action whenever the deep link changes, e.g. to dynamically update social share buttons, you can listen to the window.setIframeHeight:deepLink:changed event:

    window.addEventListener('setIframeHeight:deepLink:changed', function(e) {
        console.log(e.detail);
        // Object {childUrl: "http://..", parentUrl: "http://..."}
    });

This event is fired in the parent page and in the iframe itself.

#### Events

The following events are triggered on the window object of the parent page:

setIframeHeight: is periodically triggered (fires very often)
setIframeHeight:enlarged: is triggered whenever the iframe got enlarged
setIframeHeight:shrinked: is triggered whenever the iframe got shrinked

Example usage:

    window.addEventListener('setIframeHeight:shrinked', function (e) {
        console.log('iframe shrinked', e.detail);
    });
    window.addEventListener('setIframeHeight:enlarged', function (e) {
        console.log('iframe enlarged', e.detail);
    });


#### Support for amp-iframe (Accelerated Mobile Pages Project)

[Demo](https://rawgit.com/FaiblUG/setIframeHeight/master/demo/amp-iframe-demo.html)

For implementation details, check the [demo sourcecode](https://github.com/FaiblUG/setIframeHeight/blob/master/demo/amp-iframe-demo.html) and the [amp-iframe documentation](https://github.com/ampproject/amphtml/blob/master/extensions/amp-iframe/amp-iframe.md)

Thanks to [mthiele](https://github.com/mthieleguj) for this contribution.

---
_Source: https://npm.io/package/set-iframe-height · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
