Document OpenAI Apps SDK Display Mode Support #946
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 modesdocs/contributing/openai-sdk-architecture.mdx- Added technical implementation details for display mode supportNote
Documents OpenAI Apps SDK display modes (inline/PiP/fullscreen),
requestDisplayMode(withmaxHeight), and the corresponding parent-side handling, plus adds user-facing playground guidance.docs/contributing/openai-sdk-architecture.mdx):thread.tsx), mode detection and CSS classes, exit button, and synchronization to ensure single PiP widget.window.openai.requestDisplayMode()to acceptoptions.maxHeight; document propagation to parent and height handling.openai:requestDisplayMode, manage PiP enter/exit, and setmaxHeight.openai-app-renderer.tsx,thread.tsx,ChatTabV2.tsx.docs/inspector/llm-playground.mdx):requestDisplayModewith user exit behavior.Written by Cursor Bugbot for commit 6b5b71f. This will update automatically on new commits. Configure here.