loadIframe

Load a given URL as an iframe.

Usage

import { loadIframe } from '@studiometa/js-toolkit/utils';

const src = '/path/to/my/iframe.html';
const { event, element } = await loadIframe(src);

if (event.type === 'error') {
  console.log(`Failed to load ${src}: ${event.message}`);
} else {
  console.log(`${src} has been loaded!`);
}

Parameters

• src (string): the source URL to load
• options ({ appendTo?: HTMLElement }): configure the loader behavior
  • options.appendTo (HTMLElement): append the created element to a DOM element

Return value

• Promise<{ event: Event, element: HTMLelement }>: a promise resolving to an object containing both the load event object and the created element