-
Notifications
You must be signed in to change notification settings - Fork 10.6k
Implement nested and non-nested Label support 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
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
b7347ca
Implement nested label rendering.
ilonatommy adeacbe
Feedback: condition rendering more strictly.
ilonatommy 41c8ab7
Feedback: localization test.
ilonatommy 21e3415
Feedback: explicit `for` should not break implicit `For` association.
ilonatommy 7a0cb28
Merge branch 'main' into fix-64791
ilonatommy f44cf7a
Merge branch 'main' into fix-64791
ilonatommy 31c7258
Merge branch 'fix-64791' of https://github.com/ilonatommy/aspnetcore …
ilonatommy 06b798e
Feedback: unify previous value storage types.
ilonatommy d4ce0f1
Feedback: check for all params change, not only display name + unit t…
ilonatommy ccd918a
Unify the behavior: no throwing.
ilonatommy b274683
Feedback: non-nested approach.
ilonatommy b88187e
Feedback: small updates.
ilonatommy 60b6542
Feedback: Sanitize `id` like MVC does.
ilonatommy 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,80 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System.Buffers; | ||
| using System.Text; | ||
|
|
||
| namespace Microsoft.AspNetCore.Components.Forms; | ||
|
|
||
| /// <summary> | ||
| /// Provides methods for generating valid HTML id attribute values from field names. | ||
| /// </summary> | ||
| internal static class FieldIdGenerator | ||
| { | ||
| // Valid characters for HTML 4.01 id attributes (excluding '.' to avoid CSS selector conflicts) | ||
| // See: https://www.w3.org/TR/html401/types.html#type-id | ||
| private static readonly SearchValues<char> ValidIdChars = | ||
| SearchValues.Create("-0123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz"); | ||
|
|
||
| /// <summary> | ||
| /// Sanitizes a field name to create a valid HTML id attribute value. | ||
| /// </summary> | ||
| /// <param name="fieldName">The field name to sanitize.</param> | ||
| /// <returns>A valid HTML id attribute value, or an empty string if the input is null or empty.</returns> | ||
| /// <remarks> | ||
| /// This method follows HTML 4.01 id attribute rules: | ||
| /// - The first character must be a letter (A-Z, a-z) | ||
| /// - Subsequent characters can be letters, digits, hyphens, underscores, colons, or periods | ||
| /// - Periods are replaced with underscores to avoid CSS selector conflicts | ||
| /// </remarks> | ||
| public static string SanitizeHtmlId(string? fieldName) | ||
| { | ||
| if (string.IsNullOrEmpty(fieldName)) | ||
| { | ||
| return string.Empty; | ||
| } | ||
|
|
||
| // Fast path: check if sanitization is needed | ||
| var firstChar = fieldName[0]; | ||
| var startsWithLetter = char.IsAsciiLetter(firstChar); | ||
| var indexOfInvalidChar = fieldName.AsSpan(1).IndexOfAnyExcept(ValidIdChars); | ||
|
|
||
| if (startsWithLetter && indexOfInvalidChar < 0) | ||
| { | ||
| return fieldName; | ||
| } | ||
|
|
||
| // Slow path: build sanitized string | ||
| var result = new StringBuilder(fieldName.Length); | ||
|
|
||
| // First character must be a letter | ||
| if (startsWithLetter) | ||
| { | ||
| result.Append(firstChar); | ||
| } | ||
| else | ||
| { | ||
| result.Append('z'); | ||
| if (IsValidIdChar(firstChar)) | ||
| { | ||
| result.Append(firstChar); | ||
| } | ||
| else | ||
| { | ||
| result.Append('_'); | ||
| } | ||
| } | ||
|
|
||
| // Process remaining characters | ||
| for (var i = 1; i < fieldName.Length; i++) | ||
| { | ||
| var c = fieldName[i]; | ||
| result.Append(IsValidIdChar(c) ? c : '_'); | ||
| } | ||
|
|
||
| return result.ToString(); | ||
| } | ||
|
|
||
| private static bool IsValidIdChar(char c) | ||
| => ValidIdChars.Contains(c); | ||
| } | ||
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
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
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
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
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
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
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
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
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,117 @@ | ||
| // 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. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// <para> | ||
| /// The component supports two usage patterns: | ||
| /// </para> | ||
| /// <para> | ||
| /// <strong>Nested (wrapping) pattern:</strong> When <see cref="ChildContent"/> is provided, the label wraps | ||
| /// the input component, providing implicit HTML association without requiring matching for/id attributes. | ||
| /// </para> | ||
| /// <para> | ||
| /// <strong>Non-nested pattern:</strong> When <see cref="ChildContent"/> is not provided, the label renders | ||
| /// with a <c>for</c> attribute matching the field expression. The corresponding input component must have | ||
| /// a matching <c>id</c> attribute (which is automatically generated by input components derived from | ||
| /// <see cref="InputBase{TValue}"/>). | ||
| /// </para> | ||
| /// </remarks> | ||
| /// <typeparam name="TValue">The type of the field.</typeparam> | ||
| public class Label<TValue> : IComponent | ||
| { | ||
| private RenderHandle _renderHandle; | ||
| private string? _displayName; | ||
| private string? _fieldId; | ||
|
|
||
| [CascadingParameter] private HtmlFieldPrefix FieldPrefix { get; set; } = default!; | ||
|
|
||
| /// <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; } | ||
ilonatommy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| /// <inheritdoc /> | ||
| void IComponent.Attach(RenderHandle renderHandle) | ||
| { | ||
| _renderHandle = renderHandle; | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| Task IComponent.SetParametersAsync(ParameterView parameters) | ||
| { | ||
| var previousFor = For; | ||
| var previousChildContent = ChildContent; | ||
| var previousAdditionalAttributes = AdditionalAttributes; | ||
ilonatommy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| parameters.SetParameterProperties(this); | ||
|
|
||
| if (For is null) | ||
| { | ||
| throw new InvalidOperationException($"{GetType()} requires a value for the " + | ||
| $"{nameof(For)} parameter."); | ||
| } | ||
|
|
||
| // Only recalculate display name and field id if the expression changed | ||
| var displayNameChanged = false; | ||
| if (For != previousFor) | ||
| { | ||
| var newDisplayName = ExpressionMemberAccessor.GetDisplayName(For); | ||
| if (newDisplayName != _displayName) | ||
| { | ||
| _displayName = newDisplayName; | ||
| displayNameChanged = true; | ||
| } | ||
| _fieldId = FieldIdGenerator.SanitizeHtmlId( | ||
| FieldPrefix != null ? FieldPrefix.GetFieldName(For) : | ||
| ExpressionFormatter.FormatLambda(For)); | ||
| } | ||
|
|
||
| var otherParamsChanged = ChildContent != previousChildContent || AdditionalAttributes != previousAdditionalAttributes; | ||
| if (displayNameChanged || otherParamsChanged) | ||
| { | ||
| _renderHandle.Render(BuildRenderTree); | ||
| } | ||
|
|
||
| return Task.CompletedTask; | ||
| } | ||
|
|
||
| private void BuildRenderTree(RenderTreeBuilder builder) | ||
| { | ||
| builder.OpenElement(0, "label"); | ||
|
|
||
| // For non-nested usage (no ChildContent), add 'for' attribute to associate with input by id | ||
| if (ChildContent is null) | ||
| { | ||
| builder.AddAttribute(1, "for", _fieldId); | ||
| } | ||
|
|
||
| builder.AddMultipleAttributes(2, AdditionalAttributes); | ||
| builder.AddContent(3, _displayName); | ||
| builder.AddContent(4, 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.
Uh oh!
There was an error while loading. Please reload this page.