-
Notifications
You must be signed in to change notification settings - Fork 10.5k
Blazor supports DisplayName for models
#64636
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
14
commits into
dotnet:main
Choose a base branch
from
ilonatommy:fix-49147
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.
+526
−17
Open
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
ba210fd
API proposal.
ilonatommy 46795d5
Unit tests.
ilonatommy a167497
Add E2E tests.
ilonatommy 60aa7f7
Alphabetically.
ilonatommy db4d8af
Update templates to use the new feature.
ilonatommy 11da419
Cleanup.
ilonatommy 7bfb44c
Update src/Components/Web/src/Forms/DisplayNameLabel.cs
ilonatommy dc39fdc
Allign null operations.
ilonatommy b048f80
Feedback: remove `Label` from the name to avoid misunderstandings.
ilonatommy ce68d5a
Fix merge error
ilonatommy a8098f9
Feedback: use same caching approach as `FieldIdentifier` uses.
ilonatommy b6195cc
Fix build.
ilonatommy dfec213
Feedback: use the infrastructure from `ValidationMessage`.
ilonatommy 5a4421f
Feedback: Make sure localization is supported.
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,109 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System.Collections.Concurrent; | ||
| using System.ComponentModel; | ||
| using System.ComponentModel.DataAnnotations; | ||
| using System.Linq.Expressions; | ||
| using System.Reflection; | ||
| using Microsoft.AspNetCore.Components.HotReload; | ||
| using Microsoft.AspNetCore.Components.Rendering; | ||
|
|
||
| namespace Microsoft.AspNetCore.Components.Forms; | ||
|
|
||
| /// <summary> | ||
| /// Displays the display name for a specified field, reading from <see cref="DisplayAttribute"/> | ||
| /// or <see cref="DisplayNameAttribute"/> if present, or falling back to the property name. | ||
| /// </summary> | ||
| /// <typeparam name="TValue">The type of the field.</typeparam> | ||
| public class DisplayName<TValue> : IComponent | ||
| { | ||
| private static readonly ConcurrentDictionary<MemberInfo, string> _displayNameCache = new(); | ||
|
|
||
| private RenderHandle _renderHandle; | ||
| private Expression<Func<TValue>>? _previousFieldAccessor; | ||
| private string? _displayName; | ||
|
|
||
| /// <summary> | ||
| /// Specifies the field for which the display name should be shown. | ||
| /// </summary> | ||
| [Parameter, EditorRequired] | ||
| public Expression<Func<TValue>>? For { get; set; } | ||
|
|
||
| static DisplayName() | ||
| { | ||
| if (HotReloadManager.Default.MetadataUpdateSupported) | ||
| { | ||
| HotReloadManager.Default.OnDeltaApplied += ClearCache; | ||
| } | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| void IComponent.Attach(RenderHandle renderHandle) | ||
| { | ||
| _renderHandle = renderHandle; | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| Task IComponent.SetParametersAsync(ParameterView parameters) | ||
| { | ||
| parameters.SetParameterProperties(this); | ||
|
|
||
| if (For is null) | ||
| { | ||
| throw new InvalidOperationException($"{GetType()} requires a value for the " + | ||
| $"{nameof(For)} parameter."); | ||
| } | ||
|
|
||
| // Only recalculate if the expression changed | ||
| if (For != _previousFieldAccessor) | ||
| { | ||
| var member = ExpressionMemberAccessor.GetMemberInfo(For); | ||
| var newDisplayName = GetDisplayName(member); | ||
|
|
||
| if (newDisplayName != _displayName) | ||
| { | ||
| _displayName = newDisplayName; | ||
| _renderHandle.Render(BuildRenderTree); | ||
| } | ||
|
|
||
| _previousFieldAccessor = For; | ||
| } | ||
|
|
||
| return Task.CompletedTask; | ||
| } | ||
|
|
||
| private void BuildRenderTree(RenderTreeBuilder builder) | ||
| { | ||
| builder.AddContent(0, _displayName); | ||
| } | ||
|
|
||
| private static string GetDisplayName(MemberInfo member) | ||
| { | ||
| return _displayNameCache.GetOrAdd(member, static m => | ||
| { | ||
| var displayAttribute = m.GetCustomAttribute<DisplayAttribute>(); | ||
| if (displayAttribute is not null) | ||
| { | ||
| var name = displayAttribute.GetName(); | ||
| if (name is not null) | ||
| { | ||
| return name; | ||
| } | ||
| } | ||
|
|
||
| var displayNameAttribute = m.GetCustomAttribute<DisplayNameAttribute>(); | ||
| if (displayNameAttribute?.DisplayName is not null) | ||
| { | ||
| return displayNameAttribute.DisplayName; | ||
| } | ||
|
|
||
| return m.Name; | ||
| }); | ||
| } | ||
|
|
||
| private static void ClearCache() | ||
| { | ||
| _displayNameCache.Clear(); | ||
| } | ||
| } | ||
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,54 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System.Collections.Concurrent; | ||
| using System.Linq.Expressions; | ||
| using System.Reflection; | ||
| using Microsoft.AspNetCore.Components.HotReload; | ||
|
|
||
| namespace Microsoft.AspNetCore.Components.Forms; | ||
|
|
||
| internal static class ExpressionMemberAccessor | ||
| { | ||
| private static readonly ConcurrentDictionary<Expression, MemberInfo> _memberInfoCache = new(); | ||
|
|
||
| static ExpressionMemberAccessor() | ||
| { | ||
| if (HotReloadManager.Default.MetadataUpdateSupported) | ||
| { | ||
| HotReloadManager.Default.OnDeltaApplied += ClearCache; | ||
| } | ||
| } | ||
|
|
||
| public static MemberInfo GetMemberInfo<TValue>(Expression<Func<TValue>> accessor) | ||
| { | ||
| ArgumentNullException.ThrowIfNull(accessor); | ||
|
|
||
| return _memberInfoCache.GetOrAdd(accessor, static expr => | ||
| { | ||
| var lambdaExpression = (LambdaExpression)expr; | ||
| var accessorBody = lambdaExpression.Body; | ||
|
|
||
| if (accessorBody is UnaryExpression unaryExpression | ||
| && unaryExpression.NodeType == ExpressionType.Convert | ||
| && unaryExpression.Type == typeof(object)) | ||
| { | ||
| accessorBody = unaryExpression.Operand; | ||
| } | ||
|
|
||
| if (accessorBody is not MemberExpression memberExpression) | ||
| { | ||
| throw new ArgumentException( | ||
| $"The provided expression contains a {accessorBody.GetType().Name} which is not supported. " + | ||
| $"Only simple member accessors (fields, properties) of an object are supported."); | ||
| } | ||
|
|
||
| return memberExpression.Member; | ||
| }); | ||
| } | ||
|
|
||
| private static void ClearCache() | ||
| { | ||
| _memberInfoCache.Clear(); | ||
| } | ||
| } |
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.