IFrames support

Cross-document IFrames

Note: IFrames that are not cross document are supported out-of-box without adding the SDK to the embedded page. This guide is for supporting cross document IFrames.
To use Cobrowse for Web with cross document IFrames you will need to add our javascript snippet to the page being embedded, i.e. the iframed page. You will then need to add a list of trusted origins of all the parent pages that will be allowed to access the iframed page content for Cobrowse purposes:
// NOTE: this configuration should go into the page being embedded, NOT the top level page.
CobrowseIO.trustedOrigins = [
'https://myexample.com', // parent origin to trust
'https://my-other-website.net' // another parent origin to trust
];
CobrowseIO.start();
It is not necessary for the embedded page to contain the Cobrowse license key, if provided it will be ignored.

Code example

See our JS examples repo for the parent and child SDK configuration: https://github.com/cobrowseio/cobrowse-sdk-js-examples#cross-document-iframes.

Running only in an IFrame

A few customers want to run Cobrowse.io only within an IFrame, and not any containing or parent page. This is supported, but requires passing an extra configuration option when starting Cobrowse.
CobrowseIO.start({allowIFrameStart:true});
Last modified 3mo ago
Copy link
On this page
Cross-document IFrames
Code example
Running only in an IFrame