Gathering detailed insights and metrics for @pisano/react-frame-component
Gathering detailed insights and metrics for @pisano/react-frame-component
Render your React app to an iFrame
Installations
npm install @pisano/react-frame-componentDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
8.12.0
NPM Version
6.4.1
Score
67
Supply Chain
94.4
Quality
74.9
Maintenance
100
Vulnerability
100
License
Releases
15
Languages
2
JavaScript
HTML
JavaScript (97.78%)
HTML (2.22%)
Developer
Download Statistics
Total Downloads
5,601
Last Day
3
Last Week
14
Last Month
119
Last Year
932
GitHub Statistics
MIT License
1,798 Stars
269 Commits
158 Forks
23 Watchers
9 Branches
44 Contributors
Updated on Jul 18, 2025
Maintainers
1
Package Meta Information
Latest Version
2.0.4
Package Id
@pisano/react-frame-component@2.0.4
Unpacked Size
195.26 kB
Size
53.10 kB
File Count
16
NPM Version
6.4.1
Node Version
8.12.0
Total Downloads
Cumulative downloads
Total Downloads
5,601
Last Day
0%
3
Compared to previous day
Last Week
-36.4%
14
Compared to previous week
Last Month
98.3%
119
Compared to previous month
Last Year
-6.9%
932
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
3
Dev Dependencies
36
babel-clibabel-corebabel-eslintbabel-loaderbabel-plugin-transform-class-propertiesbabel-preset-latestbabel-preset-reactbabel-preset-stage-2babel-registerchaieslinteslint-config-airbnbeslint-plugin-importeslint-plugin-jsx-a11yeslint-plugin-reactgh-pageshtml-webpack-pluginkarmakarma-chrome-launcherkarma-mochakarma-osx-reporterkarma-sourcemap-loaderkarma-webpackmochamocha-junit-reportermocha-multimocha-osx-reporternpm-run-allprop-typesreactreact-domrimrafsinonwallaby-webpackwebpackwebpack-dev-server
React <Frame /> component
This component allows you to encapsulate your entire React application or per component in an iFrame.
1npm install --save react-frame-component
How to use:
1import Frame from 'react-frame-component';
Go check out the demo.
1const Header = ({ children }) => ( 2 <Frame> 3 <h1>{children}</h1> 4 </Frame> 5); 6 7ReactDOM.render(<Header>Hello</Header>, document.body);
Or you can wrap it at the render call.
1ReactDOM.render( 2 <Frame> 3 <Header>Hello</Header> 4 </Frame>, 5 document.body 6);
Props:
head
head: 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: 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: PropTypes.string
The mountTarget props is a css selector (#target/.target) that specifies where in the initialContent of the iframe, children will be mounted.
1<Frame 2 initialContent='<!DOCTYPE html><html><head></head><body><h1>i wont be changed</h1><div id="mountHere"></div></body></html>' 3 mountTarget='#mountHere' 4 > 5</Frame>
contentDidMount and contentDidUpdate
contentDidMount: PropTypes.func
contentDidUpdate: 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.
1const MyComponent = (props, context) => { 2 const { 3 document: iframeDocument, 4 window: iframeWindow 5 } = context; 6 7 return (<...rendered jsx.../>); 8}; 9 10MyComponent.contextTypes = { 11 window: PropTypes.any, 12 document: PropTypes.any 13};
More info
I wrote a blog post about building this component.
License
Copyright 2014, Ryan Seddon. This content is released under the MIT license http://ryanseddon.mit-license.org
No vulnerabilities found.