react-iframe

React Iframe

Simple React component for including an iframed page.

Usage

import Iframe from 'react-iframe'
<Iframe url="http://www.youtube.com/embed/xDMP3i36naA"
        width="450px"
        height="450px"
        id="myId"
        className="myClassname"
        display="initial"
        position="relative"
        allowFullScreen/>

Properties

url (required) - string the iframe url.

scrolling (optional) - string not set if if not provided.

overflow (optional) - string default to "auto".

position (optional) - string defaults to "absolute".

id (optional) - string if set, adds the id parameter with the given value.

className (optional) - string if set, adds the class parameter with the given value.

display (optional) - string defaults to "block"

height (optional) - string (1px > any number above 0, or 1% to 100%)

width (optional) - string (1px > any number above 0, or 1% to 100%)

allowFullScreen (optional) - if set, applies the allowFullScreen param

sandbox (optional) - add optional sandbox values ("allow-forms allow-pointer-lock allow-popups allow-same-origin allow-scripts allow-top-navigation")

allow (optional) - add optional allow values ("geolocation microphone camera midi encrypted-media")

styles (optional) - add any additional styles here. Will (intentionally) override any of the props above. For instance:

<Iframe url="http://www.youtube.com/embed/xDMP3i36naA"
            position="absolute"
            width="100%"
            id="myId"
            className="myClassname"
            height="100%"
            styles={{height: "25px"}}
            allowFullScreen/>

will set the height to 25px even though it was specified as 100% in the props.

A comprehensive overview of the iframe element is available from the MDN web docs.

Development

All code resides in index.js. Deploy with either npm run release, npm run release-minor or npm run release-major

Changelog

1.6.0 (2019-04-09)

<a name="1.5.3"></a>