-
Notifications
You must be signed in to change notification settings - Fork 25.1k
[11.0 P1] Forms on BLazor support DisplayName attribute
#36438
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
Draft
ilonatommy
wants to merge
1
commit into
main
Choose a base branch
from
aspnetcore-pr-64636
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.
Draft
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -458,27 +458,34 @@ The validation summary displays the friendly name when the field's value is inva | |||||
|
|
||||||
| > The Production Date field must be a date. | ||||||
|
|
||||||
| <!-- UPDATE 11.0 The feature has been backlogged. | ||||||
| https://github.com/dotnet/aspnetcore/issues/49147 | ||||||
| :::moniker-end | ||||||
|
|
||||||
| > [!NOTE] | ||||||
| > Alternatively, the [`[Display]` attribute](xref:System.ComponentModel.DataAnnotations.DisplayAttribute) on the model class property is supported: | ||||||
| > | ||||||
| > ```csharp | ||||||
| > [Required, Display(Name = "Production Date")] | ||||||
| > public DateTime ProductionDate { get; set; } | ||||||
| > ``` | ||||||
| > | ||||||
| > [`[DisplayName]` attribute](xref:System.ComponentModel.DisplayNameAttribute) is also supported: | ||||||
| > | ||||||
| > ```csharp | ||||||
| > [Required, DisplayName("Production Date")] | ||||||
| > public DateTime ProductionDate { get; set; } | ||||||
| > ``` | ||||||
| > | ||||||
| > Between the two approaches, the `[Display]` attribute is recommended, which makes additional properties available. The `[Display]` attribute also enables assigning a resource type for localization. | ||||||
| :::moniker range=">= aspnetcore-11.0" | ||||||
|
|
||||||
| --> | ||||||
| The <xref:Microsoft.AspNetCore.Components.Forms.DisplayName%601> component can be used to display property names from metadata attributes. The [`[Display]` attribute](xref:System.ComponentModel.DataAnnotations.DisplayAttribute) on the model class property is supported: | ||||||
|
|
||||||
| ```csharp | ||||||
| [Required, Display(Name = "Production Date")] | ||||||
| public DateTime ProductionDate { get; set; } | ||||||
| ``` | ||||||
|
|
||||||
| [`[DisplayName]` attribute](xref:System.ComponentModel.DisplayNameAttribute) is also supported: | ||||||
|
|
||||||
| ```csharp | ||||||
| [Required, DisplayName("Production Date")] | ||||||
| public DateTime ProductionDate { get; set; } | ||||||
| ``` | ||||||
|
|
||||||
| Between the two approaches, the `[Display]` attribute is recommended, which makes additional properties available. The `[Display]` attribute also enables assigning a resource type for localization. When both attributes are present, `[Display]` takes precedence over `[DisplayName]`. If neither attribute is present, the component falls back to the property name itself. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| Use the `DisplayName` component in labels or table headers: | ||||||
|
|
||||||
| ```razor | ||||||
| <label> | ||||||
| <DisplayName For="@(() => Model!.ProductionDate)" /> | ||||||
| <InputDate @bind-Value="Model!.ProductionDate" /> | ||||||
| </label> | ||||||
| ``` | ||||||
|
|
||||||
| :::moniker-end | ||||||
|
|
||||||
|
|
||||||
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.