@uiw/react-iframe
Advanced tools
This component allows you to wrap your entire React application or each component in an iFrame.
This component allows you to wrap your entire React application or each component in an <iframe>.
📚 Use Typescript to write, better code hints.
📦 Zero dependencies.
🐝 Encapsulation based on function components.
🍄 Provides comprehensive code test coverage.
🌐 Complete official document demo preview.
npm i @uiw/react-iframe
import React from 'react';
import IFrame from '@uiw/react-iframe';
export default function Demo() {
return (
<IFrame>
<h1>Hello World!</h1>
</IFrame>
);
}
headThe head prop is a dom node that gets inserted before the children of the frame.
import React from 'react';
import IFrame from '@uiw/react-iframe';
const head = (
<style>{`body { background: red; }`}</style>
);
export default function Demo() {
return (
<IFrame head={head}>
<h1>Hello World!</h1>
</IFrame>
);
}
initialContentThe 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.
Defaults to <!DOCTYPE html><html><head></head><body></body></html>
import React from 'react';
import IFrame from '@uiw/react-iframe';
const initialContent = '<!DOCTYPE html><html><head><title>React IFrame</title><meta name="keywords" content="react,iframe,component,development" /></head><body></body></html>';
export default function Demo() {
return (
<IFrame initialContent={initialContent}>
<div style={{ fontSize: 32, color: 'red' }}>Hello World!</div>
</IFrame>
);
}
mountTargetThe mountTarget attribute is a css selector (#target/.target) that specifies the child within the initial content of the iframe to be mounted.
import React from 'react';
import IFrame from '@uiw/react-iframe';
const initialContent = '<!DOCTYPE html><html><head></head><body><h1>i wont be changed</h1><div id="mountHere"></div></body></html>';
export default function Demo() {
return (
<IFrame initialContent={initialContent} mountTarget="#mountHere">
<div style={{ fontSize: 32, color: 'red' }}>Hello World!</div>
</IFrame>
);
}
refThe ref prop provides a way to access inner <iframe> DOM node.
import React, { useEffect, useState, Fragment } from 'react';
import IFrame from '@uiw/react-iframe';
export default function Demo() {
const [iframeRef, setIframeRef] = useState();
const [count, setCount] = useState(0);
useEffect(() => {
if (iframeRef) {
iframeRef.focus();
}
}, [iframeRef]);
const click = () => setCount(count + 1);
return (
<Fragment>
<button onClick={click} style={{ display: 'flex' }}>Click</button>
<IFrame ref={(node) => node && setIframeRef(node)}>
<div>Hello World!</div>
<div style={{ fontSize: 32, color: 'red' }}>{count}</div>
</IFrame>
</Fragment>
);
}
srcOpen a URL in an <iframe>.
import React, { useEffect, useState, Fragment } from 'react';
import IFrame from '@uiw/react-iframe';
export default function Demo() {
return (
<IFrame src="https://wangchujiang.com/" style={{ width: '100%', height: 320 }} />
);
}
window and documentThe iframe's window and document may be accessed via the FrameContext.Consumer or the useFrame hook.
import React, { useEffect, useState, Fragment } from 'react';
import IFrame, { FrameContext } from '@uiw/react-iframe';
export default function Demo() {
return (
<IFrame>
<FrameContext.Consumer>
{({ document, window }) => {
return (
<div>
<div>Hello World!</div>
</div>
)
}}
</FrameContext.Consumer>
</IFrame>
);
}
The example with useFrame hook:
import React, { useEffect, useState, Fragment } from 'react';
import IFrame, { useFrame } from '@uiw/react-iframe';
const InnerComponent = () => {
// Hook returns iframe's window and document instances from Frame context
const { document, window } = useFrame();
return (
<div>
<div>Hello World!</div>
</div>
);
};
export default function Demo() {
return (
<IFrame>
<InnerComponent />
</IFrame>
);
}
import React, { useEffect, useState, Fragment } from 'react';
import IFrame, { useFrame } from '@uiw/react-iframe';
const InnerComponent = () => {
// Hook returns iframe's window and document instances from Frame context
const { document, window } = useFrame();
return (
<div>
<div>Hello World!</div>
</div>
);
};
export default function Demo() {
const onLoad = (evn) => {
console.log("iframe loaded successfully!", evn)
}
return (
<IFrame onLoad={onLoad}>
<InnerComponent />
</IFrame>
);
}
export interface IFrameProps extends React.HTMLAttributes<HTMLIFrameElement> {
head?: React.ReactNode;
initialContent?: string;
mountTarget?: string;
}
declare const IFrame: import("react").ForwardRefExoticComponent<IFrameProps & import("react").RefAttributes<HTMLIFrameElement>>;
export default IFrame;
Runs the project in development mode.
# Step 1, run first, listen to the component compile and output the .js file
# listen for compilation output type .d.ts file
npm run watch
# Step 2, development mode, listen to compile preview website instance
npm run start
Builds the app for production to the build folder.
npm run build
The build is minified and the filenames include the hashes. Your app is ready to be deployed!
As always, thanks to our amazing contributors!
Made with contributors.
Licensed under the MIT License.
FAQs
This component allows you to wrap your entire React application or each component in an iFrame.
The npm package @uiw/react-iframe receives a total of 717 weekly downloads. As such, @uiw/react-iframe popularity was classified as not popular.
We found that @uiw/react-iframe demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.