MountOptions Type

MountOptions type represents the configuration options for mounting the SDK to a DOM element

Overview

MountOptions type represents the configuration options for mounting the SDK to a DOM element. The code snippet below shows how to use the MountOptions type to create a mount options object.

JavaScript

type MountOptions = {
  rootElement: HTMLElement;
  encounter: Encounter;
  uiOptions?: UIOptions;
  ambientOptions?: AmbientOptions;
};

Properties

Hide properties

rootElement · HTMLElement · required

The DOM element to mount the SDK into. Should be an empty container element

encounter · Encounter · required

The encounter data to pre-populate the SDK

uiOptions · UIOptions

UI configuration options

ambientOptions · AmbientOptions

Ambient session configuration options