Skip to main content

​
Overview

The useDisplayMode hook returns the current display mode of the widget.

​
Import

import { useDisplayMode } from 'sunpeak';

​
Signature

function useDisplayMode(): 'pip' | 'inline' | 'fullscreen' | null

​
Returns

​
return
'pip' | 'inline' | 'fullscreen' | null
The current display mode:
  • 'pip' - Picture-in-picture mode.
  • 'inline' - Inline mode within the chat.
  • 'fullscreen' - Fullscreen mode.
  • null - Display mode not available.

​
Usage

import { useDisplayMode } from 'sunpeak';

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

  return (
    <div>
      Display mode: {displayMode}
    </div>
  );
}