Back to Remotion

Iframe

packages/docs/docs/iframe.mdx

4.0.4821.4 KB
Original Source

The <IFrame /> can be used like the regular <iframe> HTML tag.

Remotion automatically wraps the <iframe> in a delayRender() call and ensures that the iframe is loaded before rendering the frame.

Ideally, the website should not have any animations, since only animations using useCurrentFrame() are supported by Remotion. See Flickering for an explanation.

Example

tsx
import {IFrame} from 'remotion';

export const MyComp: React.FC = () => {
  return <IFrame src="https://remotion.dev" />;
};

Props

src

The URL to load.

delayRenderTimeoutInMilliseconds<AvailableFrom v="4.0.140" />

Customize the timeout of the delayRender() call that this component makes.

delayRenderRetries<AvailableFrom v="4.0.140" />

Customize the number of retries of the delayRender() call that this component makes.
Prefer the maxRetries prop over this.

Compatibility

<CompatibilityTable chrome firefox safari nodejs="" bun="" serverlessFunctions="" clientSideRendering={false} serverSideRendering player studio hideServers />

See also