UIOptions Type

UIOptions type represents the user interface configuration options for the SDK

UIOptions type represents the user interface configuration options for the SDK. The code snippet below shows how to use the UIOptions type to create a ui options object.

JavaScript

type UIOptions = {
  showCloseButton?: boolean;
  showCreateEmptyNoteButton?: boolean;
  sectionEditing?: SectionEditingOptions;
  showStartAmbientButton?: boolean;
};

Properties

Hide properties

showCloseButton · boolean · default: "false"

Whether to show the close button in the SDK header.

showCreateEmptyNoteButton · boolean · default: "false"

Whether to show the create empty note button in the patient profile.

sectionEditing · SectionEditingOptions · default: "all enabled"

Configuration for section editing features. Defaults to all enabled.

showStartAmbientButton · boolean · default: "false"

Whether to show the start ambient button in the patient profile.