ASP.NET Splatting de atributos principais Blazor e parâmetros arbitrários

Os componentes podem capturar e renderizar atributos adicionais, além dos parâmetros e campos declarados do componente. Atributos adicionais podem ser capturados em um dicionário e, em seguida, aplicados a um elemento, chamado splatting, quando o componente é renderizado usando o @attributesRazor atributo de diretiva. Esse cenário é útil para definir um componente que produz um elemento de marcação que oferece suporte a uma variedade de personalizações. Por exemplo, pode ser tedioso definir atributos separadamente para um <input> que suporta muitos parâmetros ou campos.

Distribuição de atributos

No componente seguinte Splat:

• O primeiro <input> elemento (id="useIndividualParams") usa campos de componentes individuais.
• O segundo <input> elemento (id="useAttributesDict") usa splatting de atributos.

Splat.razor:

@page "/splat"

<PageTitle>SPLAT!</PageTitle>

<h1>Splat Parameters Example</h1>

<input id="useIndividualParams"
       maxlength="@maxlength"
       placeholder="@placeholder"
       required="@required"
       size="@size" />

<input id="useAttributesDict"
       @attributes="InputAttributes" />

@code {
    private string maxlength = "10";
    private string placeholder = "Input placeholder text";
    private string required = "required";
    private string size = "50";

    private Dictionary<string, object> InputAttributes { get; set; } =
        new()
        {
            { "maxlength", "10" },
            { "placeholder", "Input placeholder text" },
            { "required", "required" },
            { "size", "50" }
        };
}

Com exceção de id, os elementos renderizados <input> na página da Web têm atributos idênticos:

<input id="useIndividualParams"
       maxlength="10"
       placeholder="Input placeholder text"
       required="required"
       size="50">

<input id="useAttributesDict"
       maxlength="10"
       placeholder="Input placeholder text"
       required="required"
       size="50">

Embora o exemplo anterior use campos para o primeiro <input> elemento (id="useIndividualParams"), o mesmo comportamento se aplica quando os parâmetros do componente são usados.

Atributos arbitrários

Para aceitar atributos arbitrários, defina um parâmetro de componente com a CaptureUnmatchedValues propriedade definida como true:

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

A CaptureUnmatchedValues propriedade on [Parameter] permite que o parâmetro corresponda a todos os atributos que não correspondem a nenhum outro parâmetro. Um componente só pode definir um único parâmetro com CaptureUnmatchedValues. O tipo de propriedade usado com CaptureUnmatchedValues deve ser atribuível a partir de Dictionary<string, object> com chaves de strings. Uso de IEnumerable<KeyValuePair<string, object>> ou IReadOnlyDictionary<string, object> também são opções neste cenário.

A posição de @attributes relativa à posição dos atributos dos elementos é importante. Quando @attributes são espalhados no elemento renderizado, os atributos são processados da direita para a esquerda (do último para o primeiro), onde o primeiro atributo prevalece para quaisquer atributos comuns. Considere o exemplo a seguir de um componente pai que consome um componente filho, onde o filho define um atributo "extra" e o componente pai aplica um atributo "extra" no componente filho.

AttributeOrderChild1.razor:

<div @attributes="AdditionalAttributes" extra="5" />

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

AttributeOrder1.razor:

@page "/attribute-order-1"

<PageTitle>Attribute Order 1</PageTitle>

<h1>Attribute Order Example 1</h1>

<AttributeOrderChild1 extra="10" />

<p>
    View the HTML markup in your browser to inspect the attributes on
    the AttributeOrderChild1 component.
</p>

O atributo AttributeOrderChild1 do componente extra é definido à direita de @attributes. A AttributeOrderParent1 renderização <div> do componente contém extra="5" quando é passada pelo atributo adicional porque os atributos são processados da direita para a esquerda (do último para o primeiro), sendo o primeiro atributo "extra" o vencedor, que é o atributo HTML codificado extra do componente AttributeOrderParent1.

<div extra="5" />

No exemplo a seguir, a ordem de extra e @attributes é invertida no componente filho <div>. Nesse cenário, o componente AttributeOrderParent2 renderizado <div> contém extra="10" quando é passado pelo atributo adicional, porque o primeiro atributo "extra" processado é o atributo HTML espelhado extra do componente pai.

AttributeOrderChild2.razor:

<div extra="5" @attributes="AdditionalAttributes" />

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

AttributeOrder2.razor:

@page "/attribute-order-2"

<PageTitle>Attribute Order 2</PageTitle>

<h1>Attribute Order Example 2</h1>

<AttributeOrderChild2 extra="10" />

<p>
    View the HTML markup in your browser to inspect the attributes on
    the AttributeOrderChild2 component.
</p>

A <div> página da Web renderizada do componente pai contém extra="10":

<div extra="10" />