Quick summary
Minimized layout changes the Headed Web SDK into a compact, viewport-aligned widget during supported ambient sessions. Your host application, keeps the chart visible while the Web SDK preserves recording controls. This feature is available in version
3.1.0 and later.Important:
- This applies only to the Headed Web SDK, where Suki runs inside the SDK iframe. It does not apply to the Headless Web SDK, headless-only apps, or API-only integrations.
- Minimized layout frees up screen space for the EHR/chart while maintaining ambient awareness.
- On critical errors, Web SDK automatically re-expands the UI to ensure visibility of required actions.
- You control the surrounding layout to reclaim space for your own UI. You do not control when minimized layout is enabled.
When minimized layout is available
In the headed iframe, auto-minimize runs when the following conditions are met:- Ambient and Re-ambient: The minimized UI tracks an active ambient-style session in that iframe. It is not a partner-controlled “small UI” mode for non-ambient flows.
- Minimize capability: The hosted iframe evaluates policy and runtime constraints for the current user or organization before shrinking. The UI requests minimized layout only when minimize capability is on. If it is off, the Headed Web SDK stays expanded and auto-minimize does not run.
Common integration patterns and use cases
Plan minimized layout around the host UI that must remain usable while ambient or re-ambient capture continues.Chart-First Workspace
Keep the patient chart or order workflow visible while the minimized widget provides pause, cancel, and note-generation controls.
Constrained Web Layout
Use a collapsible grid, flex, or split-view slot so short, narrow, or portrait layouts can reclaim the space reserved for the expanded SDK.
Stable Overlay Mount
Mount the SDK on a stable ancestor without transformed or clipping wrappers so the fixed widget stays aligned and visible.
Visible Error Recovery
Keep the expanded SDK area available because critical errors can return the interface to the full headed view for recovery actions.
When minimize capability is off, the iframe stays fully expanded for ambient sessions and partners will not see auto-minimize.
Minimized layout capabilities
Auto-Minimize
When ambient (or re-ambient) recording is active and minimize is supported, the UI moves to a small rectangular overlay automatically. No separate partner action is required to shrink the iframe.
Core Controls on the Widget
From the minimized UI users can pause (center), cancel (top-left), or generate notes (bottom-right) without opening the full headed panel. Cancel still uses the standard confirmation step before ending the session.
Auto-Expand on Errors
On 409 Conflict (for example session collisions or state locks), the SDK exits minimized layout and returns to the full headed view so the user can complete Remote Completion or other recovery UI.
How Minimized layout works
Suki turns on minimize capability in the hosted configuration for eligible partners and users. On your side, ship a correct mount and reclaim layout space so the minimized iframe does not leave a large empty slot in your app.Contant Suki Support to enable minimize capability for your organization.
Configure the mount point
In Minimized layout, the SDK draws a small overlay usingposition: fixed. Fixed positioning is resolved against the nearest containing block, not always the browser viewport. If that block is wrong, the widget can shift, clip, or disappear.
Follow these rules when you choose the DOM node where the Web SDK mounts.
Where to mount
Mount the Headed Web SDK root on a stable, full-viewport ancestor, for example:- Mount on
document.body. - A full-height app shell you control (main layout wrapper).
- A side panel that is not nested under an element that applies CSS transforms.
Do not mount inside modals, animated drawers, or other subtrees that sit under transformed or heavily layered stacking ancestors. Those patterns can trap or clip
position: fixed descendants, misalign the widget to the viewport, or break expected z-order.Avoid transformed ancestors
Do not mount the SDK inside subtrees that settransform, filter, or will-change in a way that creates a new containing block for fixed descendants. Those properties create new stacking contexts; position: fixed on the iframe may then resolve to the wrong box, which can look like offscreen placement, clipping, or odd layering.
If you cannot move the mount, remove or isolate those properties on ancestors above the mount node.
Keep overflow visible
While minimized, set the mount element (and any immediate wrappers you own) tooverflow: visible so the fixed iframe is not clipped by overflow: hidden or auto scrollers.
Reclaim screen space
The SDK sizes and positions the iframe for both headed and minimized modes. Your app still owns the mount container around that iframe. If that container keeps the same width and height as the full headed panel (often about 360×640 px reserved in your layout), you will see a large empty gap even though the SDK UI is already small. After minimize, shrink or collapse that container so your grid, flex, or split view can grow into the freed space. Recommended approaches:- Drop or lower
min-height/min-widthon the mount wrapper while minimized. - Switch the mount slot to
autoheight, a smaller fixed height, or hide a dedicated “SDK column” until the user expands again.
fixed and does not need layout flow space.