useRequestDisplayMode

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

import { useRequestDisplayMode } from 'sunpeak';

Signature

function useRequestDisplayMode(): {
  requestDisplayMode: (mode: AppDisplayMode) => Promise<void>;
  availableModes: AppDisplayMode[] | undefined;
}

AppDisplayMode

mode

'inline' | 'pip' | 'fullscreen'

Available display modes.

Returns

requestDisplayMode

(mode: AppDisplayMode) => Promise<void>

Function to request a display mode change.

availableModes

AppDisplayMode[] | undefined

List of display modes supported by the host.

Usage

import { useRequestDisplayMode } from 'sunpeak';

function MyResource() {
  const { requestDisplayMode, availableModes } = useRequestDisplayMode();

  return (
    <div>
      {availableModes?.includes('fullscreen') && (
        <button onClick={() => requestDisplayMode('fullscreen')}>
          Go Fullscreen
        </button>
      )}
    </div>
  );
}

useRequestTeardownRequest app-initiated teardown.

​Overview

Wraps requestDisplayMode

​Import

​Signature

​AppDisplayMode

​Returns

​Usage