Skip to content

Let API union variants fold their fields behind a toggle #4491

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

Merged
akira28 merged 1 commit into from
Oct 16, 2026
Merged

Let API union variants fold their fields behind a toggle #4491

Show file tree
Hide file tree
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
11 changes: 6 additions & 5 deletions src/Elastic.ApiExplorer/Components/PropertyTree/_Partials/_UnionOptions.cshtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,16 @@
var variant = Model.Variants[i];
// A picked chip is the choice to read that variant: its fields show at once, and its chip already names it, so
// the label keeps only what the chip does not say (the discriminator value, the link to the type's page, or
// that the variant is an array).
var collapsible = variant.IsCollapsible && !Model.UseChips;
// that the variant is an array). The fields still fold behind the toggle, for a shorter view.
var collapsible = variant.IsCollapsible;
var expanded = Model.UseChips || variant.DefaultExpanded;
var folded = variant.UseHidden && !Model.UseChips;
// An array variant keeps its "X[]" heading, so its fields read as each item's; a primitive keeps its type, which is
// all its panel has to show.
var showName = !Model.UseChips || variant.PageUrl is { Length: > 0 } || variant.IsArrayVariant || !variant.IsObjectType;
var showLabel = showName || variant.DiscriminatorLabel is { Length: > 0 };

<div class="union-variant-item @(variant.ShowProperties ? "has-children" : "") @(collapsible ? (variant.DefaultExpanded ? "expanded" : "collapsed") : "")" id="@variant.AnchorId" hidden="@(Model.UseChips && i > 0 ? "until-found" : null)">
<div class="union-variant-item @(variant.ShowProperties ? "has-children" : "") @(collapsible ? (expanded ? "expanded" : "collapsed") : "")" id="@variant.AnchorId" hidden="@(Model.UseChips && i > 0 ? "until-found" : null)">
@if (showLabel)
{
<div class="union-variant-label">
Expand Down Expand Up @@ -109,8 +110,8 @@
{
<div class="expand-toggle-row union-expand-toggle">
<button class="expand-toggle">
<span class="toggle-icon">@(variant.DefaultExpanded ? "−" : "+")</span>
<span class="toggle-label">@(variant.DefaultExpanded ? "hide" : "show") properties</span>
<span class="toggle-icon">@(expanded ? "−" : "+")</span>
<span class="toggle-label">@(expanded ? "hide" : "show") properties</span>
</button>
</div>
}
Expand Down
5 changes: 3 additions & 2 deletions tests/Elastic.ApiExplorer.Tests/UnionOptionsRenderingTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,12 @@ public async Task Render_ThreeVariants_ShowsChipsAndOnlyTheFirstVariant()
}

[Test]
public async Task Render_ThreeVariants_ShowsTheFieldsAtOnceWithoutRepeatingTheName()
public async Task Render_ThreeVariants_ShowsTheFieldsAtOnceWithAToggleAndWithoutRepeatingTheName()
{
var html = await Render(3, foldable: true);

html.Should().NotContain("show properties", "picking a chip is the choice to read that variant");
html.Should().Contain("hide properties", "the fields show at once, and a toggle offers a shorter view");
html.Should().NotContain("show properties", "nothing starts folded");
html.Should().Contain("""<div class="nested-properties" id="v-0--children">""", "the fields are not folded");
html.Should().NotContain(">Variant0</span></code>", "the chip already names the variant");
html.Should().Contain(
Expand Down
Loading