Skip to content

Document interaction service updates: progress dialogs, file input, and TypeScript support#1347

Open
JamesNK wants to merge 1 commit into
release/13.5from
docs/interaction-progress-api
Open

Document interaction service updates: progress dialogs, file input, and TypeScript support#1347
JamesNK wants to merge 1 commit into
release/13.5from
docs/interaction-progress-api

Conversation

@JamesNK

@JamesNK JamesNK commented Jul 10, 2026

Copy link
Copy Markdown
Member

Documents interaction service changes from Aspire 13.5:

Changes

Interaction service page (extensibility/interaction-service.mdx)

  • Removed "(Preview)" from page title — the interaction service is no longer experimental per #18032
  • Integrated TypeScript examples throughout using <Tabs syncKey='aspire-lang'> — resolving the service, message boxes, notifications, confirmations, multi-input prompts, dynamic loading, validation, and progress dialogs
  • Added "Display progress" section documenting PromptProgressAsync with experimental API warning and work callback / no-work-callback patterns
  • Added "Prompt for file upload" section documenting the File input type with single and multiple file examples
  • Added PromptProgressAsync and File to the methods/input-types tables
  • Updated CLI context notes to include PromptProgressAsync

Custom resource commands page (fundamentals/custom-resource-commands.mdx)

  • Added "Command progress" section documenting CommandOptions.Progress with CommandProgressOptions (C# and TypeScript)
  • Documents HideCancelButton option

Copilot AI review requested due to automatic review settings July 10, 2026 04:58
@JamesNK JamesNK requested a review from IEvangelist as a code owner July 10, 2026 04:58
@JamesNK JamesNK force-pushed the docs/interaction-progress-api branch from 9c59d8c to 7f691b3 Compare July 10, 2026 05:01

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates Aspire docs to cover progress dialogs for commands and the new IInteractionService.PromptProgressAsync API, and adds TypeScript AppHost examples throughout the interaction service guidance.

Changes:

  • Added a “Command progress” section documenting CommandOptions.Progress / CommandProgressOptions with C# + TypeScript examples.
  • Expanded the interaction service docs to include PromptProgressAsync plus a new “Display progress” section.
  • Introduced <Tabs syncKey="aspire-lang"> blocks across the interaction service page to provide TypeScript examples alongside C#.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.

File Description
src/frontend/src/content/docs/fundamentals/custom-resource-commands.mdx Adds command progress documentation and examples, including cancel button behavior and a link to the interaction service progress section.
src/frontend/src/content/docs/extensibility/interaction-service.mdx Adds PromptProgressAsync to the API table/cautions, adds a progress section, and integrates TypeScript examples throughout via tabs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/frontend/src/content/docs/fundamentals/custom-resource-commands.mdx Outdated
Comment thread src/frontend/src/content/docs/fundamentals/custom-resource-commands.mdx Outdated
Comment thread src/frontend/src/content/docs/extensibility/interaction-service.mdx Outdated
Comment thread src/frontend/src/content/docs/extensibility/interaction-service.mdx Outdated
Comment thread src/frontend/src/content/docs/extensibility/interaction-service.mdx Outdated
Comment thread src/frontend/src/content/docs/extensibility/interaction-service.mdx Outdated
Comment thread src/frontend/src/content/docs/extensibility/interaction-service.mdx Outdated
Comment thread src/frontend/src/content/docs/extensibility/interaction-service.mdx Outdated
@JamesNK JamesNK force-pushed the docs/interaction-progress-api branch 3 times, most recently from fa20d37 to c8cefb0 Compare July 10, 2026 05:19
@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1347. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1347 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

@JamesNK JamesNK force-pushed the docs/interaction-progress-api branch from c8cefb0 to ed3f1af Compare July 10, 2026 05:22
@JamesNK JamesNK requested a review from Copilot July 10, 2026 05:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread src/frontend/src/content/docs/extensibility/interaction-service.mdx Outdated
@JamesNK JamesNK force-pushed the docs/interaction-progress-api branch from ed3f1af to e73137a Compare July 10, 2026 05:36
@JamesNK JamesNK changed the title Document PromptProgressAsync API and add TypeScript examples to interaction service Document interaction service updates: progress dialogs, file input, and TypeScript support Jul 10, 2026
…action service

- Add PromptProgressAsync to the interaction service docs with C# and TypeScript examples
- Add CommandProgressOptions section to custom resource commands page
- Integrate TypeScript tabs throughout interaction service documentation
- Update method table and context notes to include PromptProgressAsync

Documents changes from microsoft/aspire#18493
@JamesNK JamesNK force-pushed the docs/interaction-progress-api branch from e73137a to 00a5519 Compare July 10, 2026 05:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants