@1milligram/frame
v1.0.1
Published
An iframe wrapper that resizes based on its content automatically
Downloads
7
Maintainers
Readme
Frame
A React component that wraps an iframe
inside an element:
- [x] The
iframe
is only loaded when it is visible in the screen - [x] The
iframe
is resized automatically when its content resizes
Due to the cross domain (CORS) issue, it only supports iframe
whose src
belongs to the same domain of your site.
Usage
- Install the package:
$ npm install @1milligram/frame
- Using the
Frame
component:
import { Frame } from '@1milligram/frame';
import '@1milligram/frame/lib/styles/index.css';
<Frame url="/path/to/iframe" />;
Options
Setting the frame height
For any reason that you would like to do your own calculation to adjust the frame height:
const setFrameHeight = (doc: Document) => {
// `doc` is the document instance of the iframe content
return doc.body.scrollHeight;
};
<Frame setFrameHeight={setFrameHeight} />;