Skip to main content

Configuration

Typically, integration with SX RecorderSDK and it's many lifecycle events happens entirely via callback functions that are defined within the Config object. These are divided into 7 objects.

  • RootElement
  • ProjectConfig
  • PopupConfig
  • RecordingConfig
  • ToolsConfig
  • UserProperties
  • CustomTheme

All configuration options have defaults that use behaviour native to the StoryXpress domain.

Config is generally an object in the following format:

const myPopupConfig = {...};
const myProjectConfig = {...};
const myRecorderConfig = {...};
const myUserProperties = {...};
const myCustomTheme = {...};
const myToolsConfig = {...};

const myRootElement = document.getElementById("myRootButton");

const Config = {
RootElement: myRootElement,
ProjectConfig: myProjectConfig,
PopupConfig: myPopupConfig,
RecordingConfig: myRecorderConfig,
ToolsConfig: myToolsConfig,
UserProperties: myUserProperties,
CustomTheme: myCustomTheme,
};