UIOptions Type

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

boolean

default:"false"

Whether to show the close button in the SDK header.

boolean

default:"false"

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

SectionEditingOptions

default:"all enabled"

Configuration for section editing features. Defaults to all enabled.

boolean

default:"false"

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

Last modified on August 13, 2026

Get Started

Concepts & Feature Guides

API Reference

Resources

UIOptions Type

Properties

​Properties

Properties