Skip to content

Latest commit

 

History

History
118 lines (87 loc) · 3.64 KB

README.md

File metadata and controls

118 lines (87 loc) · 3.64 KB
Raw

React <Frame /> component

NPM version Build Status Dependency Status

This component allows you to encapsulate your entire React application or per component in an iFrame.

npm install --save react-frame-component

How to use:

var Frame = require('react-frame-component');

Go check out the [demo] demo-url.

var Header = React.createClass({
  render: function() {
    return (
      <Frame>
        <h1>{this.props.children}</h1>
      </Frame>
    );
  }
});

React.render(<Header>Hello</Header>, document.body);

Or you can wrap it at the render call.

React.render(
  <Frame>
    <Header>Hello</Header>
  </Frame>,
  document.body
);

#####Props:

######head head: React.PropTypes.node

The head prop is a dom node that gets inserted before the children of the frame. Note that this is injected into the body of frame (see the blog post for why). This has the benefit of being able to update and works for stylesheets.

######initialContent initialContent: React.PropTypes.string

Defaults to '<!DOCTYPE html><html><head></head><body><div></div></body></html>'

The initialContent props is the initial html injected into frame. It is only injected once, but allows you to insert any html into the frame (e.g. a head tag, script tags, etc). Note that it does not update if you change the prop. Also at least one div is required in the body of the html, which we use to render the react dom into.

######mountTarget mountTarget: React.PropTypes.string

The mountTarget props is a css selector (#target/.target) that specifies where in the initialContent of the iframe, children will be mounted.

<Frame
  initialContent='<!DOCTYPE html><html><head></head><body><h1>i wont be changed</h1><div id="mountHere"></div></body></html>'
  mountTarget='#mountHere'
  >
</Frame>

######contentDidMount and contentDidUpdate contentDidMount: React.PropTypes.func contentDidUpdate: React.PropTypes.func

contentDidMount and contentDidUpdate are conceptually equivalent to componentDidMount and componentDidUpdate, respecitvely. The reason these are needed is because internally we call ReactDOM.render which starts a new set of lifecycle calls. This set of lifecycle calls are sometimes triggered after the lifecycle of the parent component, so these callbacks provide a hook to know when the frame contents are mounted and updated.

######Accessing the iframe's window and document The iframe's window and document may be accessed via the React context values window and document respectively.

const MyComponent = (props, context) => {
  const {
    document: iframeDocument,
    window: iframeWindow
  } = context;
  return (<...rendered jsx.../>);
};
MyComponent.contextTypes = {
  window: PropTypes.any,
  document: PropTypes.any
};

More info

I wrote a [blog post] blog-url about building this component.

License

Copyright 2014, Ryan Seddon. This content is released under the MIT license http://ryanseddon.mit-license.org