-
Notifications
You must be signed in to change notification settings - Fork 10.5k
Implement nested Label for DisplayName
#64821
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.
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
Open
ilonatommy
wants to merge
3
commits into
dotnet:main
Choose a base branch
from
ilonatommy:fix-64791
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+453
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System.Linq.Expressions; | ||
| using Microsoft.AspNetCore.Components.Rendering; | ||
|
|
||
| namespace Microsoft.AspNetCore.Components.Forms; | ||
|
|
||
| /// <summary> | ||
| /// Renders a <c><label></c> element for a specified field, reading the display name from | ||
| /// <see cref="System.ComponentModel.DataAnnotations.DisplayAttribute"/> or | ||
| /// <see cref="System.ComponentModel.DisplayNameAttribute"/> if present, or falling back to the property name. | ||
| /// The label wraps its child content (typically an input component), providing implicit association | ||
| /// without requiring matching for/id attributes. | ||
| /// </summary> | ||
| /// <typeparam name="TValue">The type of the field.</typeparam> | ||
| public class Label<TValue> : IComponent | ||
| { | ||
| private RenderHandle _renderHandle; | ||
| private Expression<Func<TValue>>? _previousFieldAccessor; | ||
| private string? _displayName; | ||
|
|
||
| /// <summary> | ||
| /// Specifies the field for which the label should be rendered. | ||
| /// </summary> | ||
| [Parameter, EditorRequired] | ||
| public Expression<Func<TValue>>? For { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets the child content to be rendered inside the label element. | ||
| /// Typically this contains an input component that will be implicitly associated with the label. | ||
| /// </summary> | ||
| [Parameter] | ||
| public RenderFragment? ChildContent { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Gets or sets a collection of additional attributes that will be applied to the label element. | ||
| /// </summary> | ||
| [Parameter(CaptureUnmatchedValues = true)] | ||
| public IReadOnlyDictionary<string, object>? AdditionalAttributes { get; set; } | ||
|
|
||
| /// <inheritdoc /> | ||
| void IComponent.Attach(RenderHandle renderHandle) | ||
| { | ||
| _renderHandle = renderHandle; | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| Task IComponent.SetParametersAsync(ParameterView parameters) | ||
| { | ||
| var previousChildContent = ChildContent; | ||
| var previousAdditionalAttributes = AdditionalAttributes; | ||
|
|
||
| parameters.SetParameterProperties(this); | ||
|
|
||
| if (For is null) | ||
| { | ||
| throw new InvalidOperationException($"{GetType()} requires a value for the " + | ||
| $"{nameof(For)} parameter."); | ||
| } | ||
|
|
||
| // Only recalculate display name if the expression changed | ||
| if (For != _previousFieldAccessor) | ||
| { | ||
| var newDisplayName = ExpressionMemberAccessor.GetDisplayName(For); | ||
|
|
||
| if (newDisplayName != _displayName) | ||
| { | ||
| _displayName = newDisplayName; | ||
| _renderHandle.Render(BuildRenderTree); | ||
| } | ||
|
|
||
| _previousFieldAccessor = For; | ||
| } | ||
| else if (ChildContent != previousChildContent || AdditionalAttributes != previousAdditionalAttributes) | ||
| { | ||
| // Re-render if other parameters changed | ||
| _renderHandle.Render(BuildRenderTree); | ||
| } | ||
|
|
||
| return Task.CompletedTask; | ||
| } | ||
|
|
||
| private void BuildRenderTree(RenderTreeBuilder builder) | ||
| { | ||
| builder.OpenElement(0, "label"); | ||
| builder.AddMultipleAttributes(1, AdditionalAttributes); | ||
| builder.AddContent(2, _displayName); | ||
| builder.AddContent(3, ChildContent); | ||
| builder.CloseElement(); | ||
| } | ||
| } | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What happens if user adds
forattribute manually?