AspNetCore.Docs/aspnetcore/diagnostics/bl0002.md

1.4 KiB

title description author monikerRange ms.author ms.date uid
BL0002: Component has multiple CaptureUnmatchedValues parameters Learn about analysis rule BL0002: Component has multiple CaptureUnmatchedValues parameters pranavkm >= aspnetcore-3.1 riande 10/21/2021 diagnostics/bl0002

BL0002: Component has multiple CaptureUnmatchedValues parameters

Value
Rule ID BL0002
Category Usage
Fix is breaking or non-breaking Non-breaking

Cause

More than one parameter on a type deriving from xref:Microsoft.AspNetCore.Components.ComponentBase is annotated with CaptureUnmatchedValues = true.

Rule description

For a component, exactly one parameter is expected to have the xref:Microsoft.AspNetCore.Components.ParameterAttribute.CaptureUnmatchedValues set to true.

@code
{
    [Parameter(CaptureUnmatchedValues = true)] public Dictionary<string, object> Parameter1 { get; set; }

    [Parameter(CaptureUnmatchedValues = true)] public Dictionary<string, object> Parameter2 { get; set; }
}

How to fix violations

Limit a single parameter to have CaptureUnmatchedValues set.

@code
{
    [Parameter(CaptureUnmatchedValues = true)] public Dictionary<string, object> Parameter1 { get; set; }

    [Parameter] public Dictionary<string, object> Parameter2 { get; set; }
}

When to suppress warnings

Do not suppress a warning from this rule.