Skip to content

Commit a8a8820

Browse files
committed
Deprecate stand-alone error message and fieldset tag helpers
1 parent 40f4fe4 commit a8a8820

File tree

9 files changed

+16
-0
lines changed

9 files changed

+16
-0
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
#### `asp-for` attributes
88
The `asp-for` attribute is now obsolete; the `for` attribute should be used in its place.
99

10+
#### `<govuk-error-message>` and `<govuk-fieldset>` tag helpers
11+
The `<govuk-error-message>` and `<govuk-fieldset>` tag helpers are deprecated and will be removed in a future release.
12+
1013
## 2.8.0
1114

1215
Targets GOV.UK Frontend v5.8.0.

src/GovUk.Frontend.AspNetCore.DocSamples/GovUk.Frontend.AspNetCore.DocSamples.csproj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
<PropertyGroup>
44
<TargetFramework>net8.0</TargetFramework>
5+
<NoWarn>CS0618</NoWarn>
56
</PropertyGroup>
67

78
<ItemGroup>

src/GovUk.Frontend.AspNetCore/TagHelpers/ErrorMessageTagHelper.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ namespace GovUk.Frontend.AspNetCore.TagHelpers;
1717
/// </summary>
1818
[HtmlTargetElement(TagName)]
1919
[OutputElementHint(ComponentGenerator.ErrorMessageElement)]
20+
[Obsolete("This tag helper will be removed in a future release.")]
2021
public class ErrorMessageTagHelper : TagHelper
2122
{
2223
internal const string TagName = "govuk-error-message";

src/GovUk.Frontend.AspNetCore/TagHelpers/FieldsetContext.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ public void SetLegend(
1616

1717
if (Legend != null)
1818
{
19+
#pragma warning disable CS0618 // Type or member is obsolete
1920
throw ExceptionHelper.OnlyOneElementIsPermittedIn(
2021
FieldsetLegendTagHelper.TagName,
2122
FieldsetTagHelper.TagName);
23+
#pragma warning restore CS0618 // Type or member is obsolete
2224
}
2325

2426
Legend = (isPageHeading, attributes, content);
@@ -28,7 +30,9 @@ public void ThrowIfNotComplete()
2830
{
2931
if (Legend == null)
3032
{
33+
#pragma warning disable CS0618 // Type or member is obsolete
3134
throw ExceptionHelper.AChildElementMustBeProvided(FieldsetLegendTagHelper.TagName);
35+
#pragma warning restore CS0618 // Type or member is obsolete
3236
}
3337
}
3438
}

src/GovUk.Frontend.AspNetCore/TagHelpers/FieldsetLegendTagHelper.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
using System;
12
using System.Threading.Tasks;
23
using GovUk.Frontend.AspNetCore.HtmlGeneration;
34
using Microsoft.AspNetCore.Razor.TagHelpers;
@@ -9,6 +10,7 @@ namespace GovUk.Frontend.AspNetCore.TagHelpers;
910
/// </summary>
1011
[HtmlTargetElement(TagName, ParentTag = FieldsetTagHelper.TagName)]
1112
[OutputElementHint(ComponentGenerator.FieldsetLegendElement)]
13+
[Obsolete("This tag helper will be removed in a future release.")]
1214
public class FieldsetLegendTagHelper : TagHelper
1315
{
1416
internal const string TagName = "govuk-fieldset-legend";

src/GovUk.Frontend.AspNetCore/TagHelpers/FieldsetTagHelper.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
using System;
12
using System.Threading.Tasks;
23
using GovUk.Frontend.AspNetCore.HtmlGeneration;
34
using Microsoft.AspNetCore.Html;
@@ -11,6 +12,7 @@ namespace GovUk.Frontend.AspNetCore.TagHelpers;
1112
/// </summary>
1213
[HtmlTargetElement(TagName)]
1314
[OutputElementHint(ComponentGenerator.FieldsetElement)]
15+
[Obsolete("This tag helper will be removed in a future release.")]
1416
public class FieldsetTagHelper : TagHelper
1517
{
1618
internal const string TagName = "govuk-fieldset";

tests/GovUk.Frontend.AspNetCore.Tests/TagHelpers/ErrorMessageTagHelperTests.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
using Microsoft.AspNetCore.Razor.TagHelpers;
1111
using Moq;
1212
using Xunit;
13+
#pragma warning disable CS0618 // Type or member is obsolete
1314

1415
namespace GovUk.Frontend.AspNetCore.Tests.TagHelpers;
1516

tests/GovUk.Frontend.AspNetCore.Tests/TagHelpers/FieldsetLegendTagHelperTests.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
using Microsoft.AspNetCore.Html;
66
using Microsoft.AspNetCore.Razor.TagHelpers;
77
using Xunit;
8+
#pragma warning disable CS0618 // Type or member is obsolete
89

910
namespace GovUk.Frontend.AspNetCore.Tests.TagHelpers;
1011

tests/GovUk.Frontend.AspNetCore.Tests/TagHelpers/FieldsetTagHelperTests.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
using Microsoft.AspNetCore.Html;
77
using Microsoft.AspNetCore.Razor.TagHelpers;
88
using Xunit;
9+
#pragma warning disable CS0618 // Type or member is obsolete
910

1011
namespace GovUk.Frontend.AspNetCore.Tests.TagHelpers;
1112

0 commit comments

Comments
 (0)