Skip to main content
Widgets are pre-built UI components you can drop into your EHR application without building a recording interface from scratch. Introduced in SDK v1.8.0, widgets handle microphone access, recording controls, audio visualization, and result delivery out of the box — while giving you full control over appearance and behavior through configuration.

​
Benefits

  • Quick integration: add a fully functional recording interface in minutes
  • Fully themeable: match your application’s color scheme, typography, and border radius
  • Highly customizable: configure behavior, language, and output templates per use case
  • Multi-language support: built-in localization for English, Dutch, French, and German
  • Always improving: widgets receive regular enhancements without changes to your integration

​
How widgets work

Every widget follows the same three-step lifecycle:
1

Initialize the SDK

Create a Squire instance with your access token and output language. See Authentication for how to obtain a short-lived token.
const squire = new Squire({
  token: 'YOUR_ACCESS_TOKEN',
  outputLanguage: 'en',
});
2

Mount the widget

Call mountWidget with a CSS selector for the container element and the widget name. Pass an optional configuration object to customize appearance and behavior.
const widget = squire.mountWidget('#your-container', 'widget-name');
3

Listen for events

Use the on method on the returned widget instance to react to lifecycle events and results.
widget.on('loaded', () => {
  console.log('Widget is ready');
});

​
Available widgets

AI Consultation Widget

A complete recording interface with mic selection, waveform visualization, and automatic consultation summary generation.

Microphone Quality Test Widget

Let users verify their microphone quality before starting a recording session.