Skip to content

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Nov 24, 2025

Added documentation for the new Display Mode feature (Picture-in-Picture and Fullscreen) for OpenAI Apps SDK widgets introduced in PR #927. This enhancement allows widgets to request different display modes to optimize their presentation, including floating PiP mode and immersive fullscreen experiences.

Files Changed

  • docs/inspector/llm-playground.mdx - Added user-facing documentation for display modes
  • docs/contributing/openai-sdk-architecture.mdx - Added technical implementation details for display mode support

Note

Documents OpenAI Apps SDK display modes (inline/PiP/fullscreen), requestDisplayMode (with maxHeight), and the corresponding parent-side handling, plus adds user-facing playground guidance.

  • Docs:
    • Architecture (docs/contributing/openai-sdk-architecture.mdx):
      • Add comprehensive Display Mode support docs: PiP/fullscreen/inline behavior, state management (thread.tsx), mode detection and CSS classes, exit button, and synchronization to ensure single PiP widget.
      • Extend window.openai.requestDisplayMode() to accept options.maxHeight; document propagation to parent and height handling.
      • Update parent message handling to process openai:requestDisplayMode, manage PiP enter/exit, and set maxHeight.
      • Refresh code references (line ranges) and iframe sandbox location; expand Related Files with openai-app-renderer.tsx, thread.tsx, ChatTabV2.tsx.
    • Playground (docs/inspector/llm-playground.mdx):
      • Add Display Modes section describing inline, PiP, fullscreen, and usage of requestDisplayMode with user exit behavior.

Written by Cursor Bugbot for commit 6b5b71f. This will update automatically on new commits. Configure here.

@khandrew1 khandrew1 marked this pull request as ready for review November 24, 2025 23:03
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Nov 24, 2025
@khandrew1 khandrew1 merged commit 617bd86 into main Nov 24, 2025
4 checks passed
@dosubot dosubot bot added the documentation Improvements or additions to documentation label Nov 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants