Skip to main content
sunpeak API

Overview

Returns a function to request display mode changes and the list of available modes. The host may accept or deny the request.

Wraps requestDisplayMode

MCP Apps SDK reference

Import

Signature

AppDisplayMode

'inline' | 'pip' | 'fullscreen'
Available display modes.

Returns

(mode: AppDisplayMode) => Promise<void>
Function to request a display mode change.
AppDisplayMode[] | undefined
List of display modes supported by the host.

Usage