docs: HTML Widgets in-depth guide - #2934
Draft
corinagum wants to merge 6 commits into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new HTML Widgets in-depth documentation section to teams.md, covering the end-to-end flow (sending widgets, handling tool calls, security policy helpers, and model-context updates) with per-language include snippets (TypeScript/Python/.NET).
Changes:
- Adds the HTML Widgets overview page with payload shape + navigation to sub-guides.
- Adds four sub-guides (sending widgets, tool calls, security policy, updating model context).
- Adds language-specific include snippets for each guide section, plus the new doc category definition.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| teams.md/src/pages/templates/in-depth-guides/html-widgets/README.mdx | Overview page: concept, wire format, payload fields, and SDK helper index. |
| teams.md/src/pages/templates/in-depth-guides/html-widgets/sending-widgets.mdx | Guide page for constructing/sending widget messages and markdown. |
| teams.md/src/pages/templates/in-depth-guides/html-widgets/handling-tool-calls.mdx | Guide page for receiving htmlwidget/calltool invokes and returning typed results. |
| teams.md/src/pages/templates/in-depth-guides/html-widgets/security-policy.mdx | Guide page for securityPolicy and the validate/inject helpers. |
| teams.md/src/pages/templates/in-depth-guides/html-widgets/updating-model-context.mdx | Guide page for parsing ui/update-model-context requests from message activities. |
| teams.md/src/pages/templates/in-depth-guides/html-widgets/category.json | Adds the “HTML Widgets” category metadata (sidebar position/label). |
| teams.md/src/components/include/in-depth-guides/html-widgets/sending-widgets/typescript.incl.md | TS snippets for building widget messages/markdown. |
| teams.md/src/components/include/in-depth-guides/html-widgets/sending-widgets/python.incl.md | Python snippets for building widget messages/markdown. |
| teams.md/src/components/include/in-depth-guides/html-widgets/sending-widgets/csharp.incl.md | C# snippets for building widget messages/markdown. |
| teams.md/src/components/include/in-depth-guides/html-widgets/handling-tool-calls/typescript.incl.md | TS snippets for handling tool calls + response shape. |
| teams.md/src/components/include/in-depth-guides/html-widgets/handling-tool-calls/python.incl.md | Python snippets for handling tool calls + response shape. |
| teams.md/src/components/include/in-depth-guides/html-widgets/handling-tool-calls/csharp.incl.md | C# snippets for handling tool calls + response shape. |
| teams.md/src/components/include/in-depth-guides/html-widgets/security-policy/typescript.incl.md | TS snippets for validating policy + injecting protocol script. |
| teams.md/src/components/include/in-depth-guides/html-widgets/security-policy/python.incl.md | Python snippets for validating policy + injecting protocol script. |
| teams.md/src/components/include/in-depth-guides/html-widgets/security-policy/csharp.incl.md | C# snippets for validating policy + injecting protocol script. |
| teams.md/src/components/include/in-depth-guides/html-widgets/updating-model-context/typescript.incl.md | TS snippet for parsing ui/update-model-context. |
| teams.md/src/components/include/in-depth-guides/html-widgets/updating-model-context/python.incl.md | Python snippet for parsing ui/update-model-context. |
| teams.md/src/components/include/in-depth-guides/html-widgets/updating-model-context/csharp.incl.md | C# snippet for parsing ui/update-model-context. |
corinagum
marked this pull request as draft
July 27, 2026 19:47
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Do not merge: putting on hold per request of HTML Widgets PM.
Summary
Adds documentation for the HTML Widgets feature (in-depth guide) covering all three SDKs (TypeScript, Python, .NET). HTML Widgets let an app render rich, interactive HTML inside a Teams message via an MCP Apps (ext-apps) surface.
Pages added
Under In-Depth Guides > HTML Widgets:
README.mdx) - what HTML Widgets are, how they travel inside anextendedmarkdownmessage, the payload shape, and a "What the SDK provides" helper index.htmlwidget/calltoolhandler and typed response shape.securityPolicy, the validate/inject helpers, and their limits.ui/update-model-contextrequest off an incoming message.Notes