Constructors

  • The SDK should be configured clientside and it exposes all controllers to work with in other applications

    Parameters

    • config: ConfigType

      The configuration object where the SDK and editor can get configured

    Returns default

Properties

This controller is still experimental and might change in future releases.

connection: Connection
sdkEvents: SdkEvents

SDK method invocation events.

Use this to observe which SDK controller method was called and with which parameters/result. These are SDK-level events (SDK -> consumer), separate from engine subscriber events (config.events).

Methods

  • Shuts this SDK instance down and releases the engine it loaded.

    This tears down the postMessage connection, removes the engine iframe from the document and drops the references the SDK itself holds. Removing the iframe is what lets the browser discard the engine realm, which is where the bulk of the memory lives (the Dart heap plus the CanvasKit and QuickJS WASM memory).

    Call this whenever an integration unmounts an editor it previously created with loadEditor. Without it every mount leaves a fully live engine behind. The method is safe to call more than once.

    Returns void

  • This method will initiate the editor, running this will result in the editor restarting It will generate an iframe in the document

    Returns void

  • Parameters

    • newConnection: Connection

    Returns void