Skip to content

bl0001.md

Latest commit

 

History

History
57 lines (40 loc) · 1.67 KB

bl0001.md

File metadata and controls

57 lines (40 loc) · 1.67 KB
title BL0001: Component parameter should have public setters
description Learn about analysis rule BL0001: Component parameter should have public setters
author guardrex
monikerRange >= aspnetcore-3.1
ms.author riande
ms.date 10/21/2021
uid diagnostics/bl0001

BL0001: Component parameter should have public setters

Value
Rule ID BL0001
Category Usage
Fix is breaking or non-breaking Breaking

Cause

A property on a type deriving from xref:Microsoft.AspNetCore.Components.ComponentBase annotated with [Parameter] has a missing or non-public setters.

Rule description

Component parameters are required to have publicly accessible setters to allow the framework to assign values. All of the parameter declarations in the following example result in this diagnostic.

@code
{
    [Parameter] int Parameter1 { get; set; }

    [Parameter] public int Parameter2 { get; }

    [Parameter] public int Parameter3 { get; private set; }
}

How to fix violations

  • Make the property and its setter public.
@code
{
    [Parameter] public int Parameter1 { get; set; }

    [Parameter] public int Parameter2 { get; set; }

    [Parameter] public int Parameter3 { get; set; }
}
  • If making the property non-public is not possible, consider implementing SetParametersAsync manually.

When to suppress warnings

Do not suppress a warning from this rule.