useDisplayMode

sunpeak API

Overview

The useDisplayMode hook returns the current display mode of the app. It is a convenience wrapper around useHostContext.

Wraps onhostcontextchanged

MCP Apps SDK reference

Import

import { useDisplayMode } from 'sunpeak';

Signature

function useDisplayMode(): McpUiDisplayMode

The return type is McpUiDisplayMode.

Returns

'inline' | 'pip' | 'fullscreen'

The current display mode. Defaults to 'inline' when unavailable.

Usage

import { useDisplayMode } from 'sunpeak';

function MyResource() {
  const displayMode = useDisplayMode();

  return (
    <div className={displayMode === 'fullscreen' ? 'h-screen' : 'max-h-96'}>
      Current mode: {displayMode}
    </div>
  );
}

Getting Started

CLI

Components

Functions

Hooks

Resources

Tools

Guides

Overview

Wraps onhostcontextchanged

Import

Signature

Returns

Usage

​Overview

Wraps onhostcontextchanged

​Import

​Signature

​Returns

​Usage

Overview

Import

Signature

Returns

Usage