Skip to content

[docs] Document ResourceUrlAnnotation.DisplayOrder #1806

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
aspire-repo-bot wants to merge 1 commit into
base: release/17.0
Choose a base branch
from
+18 −0
Draft

[docs] Document ResourceUrlAnnotation.DisplayOrder #1806

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions src/frontend/src/content/docs/fundamentals/custom-resource-urls.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,24 @@ When the resource is started, the URL is available in the dashboard.

Alternatively, you could use the overload that accepts a `Func<EndpointReference, ResourceUrlAnnotation>` as a callback. This allows you to specify deep-links on target `EndpointReference` instances.

### Control URL display order

When a resource exposes multiple custom URLs, use the `DisplayOrder` property on `ResourceUrlAnnotation` to control the order they appear in the dashboard. Higher values sort higher (first) in the list. `DisplayOrder` is a nullable `int`, so URLs without an explicit value fall back to the default ordering.

```csharp title="AppHost.cs"
var builder = DistributedApplication.CreateBuilder(args);

builder.AddProject<Projects.AspireApp_Api>("api")
.WithUrlForEndpoint("https", url =>
{
url.DisplayText = "Scalar (HTTPS)";
url.Url = "/scalar";
url.DisplayOrder = 1000;
});

builder.Build().Run();
```

### Customize multiple resource URLs

To customize multiple URLs for a resource, use the `WithUrls` method. This method allows you to specify multiple URLs for a resource, each with its own display text. The following example demonstrates how to set multiple URLs for a project resource:
Expand Down
Loading