[docs] Document icon fallback behavior for resource commands#1277
Open
aspire-repo-bot[bot] wants to merge 2 commits into
Open
[docs] Document icon fallback behavior for resource commands#1277aspire-repo-bot[bot] wants to merge 2 commits into
aspire-repo-bot[bot] wants to merge 2 commits into
Conversation
When a resource command specifies an unrecognized iconName, the dashboard now renders a QuestionCircle (question mark circle) icon as a fallback instead of displaying the raw display-name text. For highlighted commands (IsHighlighted = true) with no iconName, the dashboard uses a Flash icon by default so the inline action button stays compact and never overflows the resource row. Documents changes from microsoft/aspire#18389. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
JamesNK
approved these changes
Jun 22, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Aspire docs to describe the dashboard’s new icon fallback behavior for custom resource commands, so users understand what happens when iconName is missing or invalid (especially for highlighted commands that render as inline action buttons).
Changes:
- Expanded the
iconNameparameter description to document:- fallback to a QuestionCircle icon when an unknown icon name is provided
- default Flash icon when a highlighted command omits
iconName
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
JamesNK
reviewed
Jun 22, 2026
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.
Documents changes from microsoft/aspire#18389 (by
@JamesNK).Targeting
release/13.5based on the source PR milestone13.5.Why this PR is needed
PR microsoft/aspire#18389 fixed a dashboard overflow bug: when a resource command had
IsHighlighted = trueand specified an unrecognizediconName, the dashboard previously rendered the rawdisplayNametext in the inline action button slot. A long display name could widen the resource row past the viewport, pushing the...overflow menu off-screen.The fix introduces two new fallback behaviors that users of the
WithCommand/iconNameAPI need to know about:iconNameresolves to no known Fluent UI icon, the dashboard now renders a QuestionCircle (❓) icon instead of the display-name text.IsHighlighted = trueandiconNameis omitted, the dashboard renders a Flash (⚡) icon by default, keeping the button compact.What was changed
Updated the
iconNameparameter description insrc/frontend/src/content/docs/fundamentals/custom-resource-commands.mdxto document both fallback behaviors.Files modified
src/frontend/src/content/docs/fundamentals/custom-resource-commands.mdx— updated existing page