ASP.NET parametri di splatting e arbitrari degli attributi core Blazor

Oltre ai parametri dichiarati del componente, i componenti possono acquisire attributi aggiuntivi ed eseguirne il rendering. È possibile acquisire gli attributi aggiuntivi in un dizionario e quindi eseguirne lo splatting su un elemento quando viene eseguito il rendering del componente usando l'attributo della direttiva di Razor@attributes. Questo scenario è utile per definire un componente che produce un elemento di markup che supporta un'ampia gamma di personalizzazioni. Ad esempio, può essere impegnativo definire gli attributi separatamente per un <input> che support più parametri.

Splatting degli attributi

Nel componente Splat seguente:

• Il primo elemento <input> (id="useIndividualParams") usa i singoli parametri del componente.
• Il secondo elemento <input> (id="useAttributesDict") usa lo splatting degli attributi.

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" }
        };
}

Gli elementi <input> sottoposti a rendering nella pagina Web sono identici:

<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">

Attributi arbitrari

Per accettare attributi arbitrari, definire un parametro del componente con la proprietà CaptureUnmatchedValues impostata su true:

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

La proprietà CaptureUnmatchedValues in [Parameter] consente al parametro di associare tutti gli attributi che non corrispondono a nessun altro parametro. Un componente può definire solo un singolo parametro con CaptureUnmatchedValues. Il tipo di proprietà usato con CaptureUnmatchedValues deve essere assegnabile da Dictionary<string, object> con chiavi di stringa. In questo scenario è anche possibile usare IEnumerable<KeyValuePair<string, object>> o IReadOnlyDictionary<string, object>.

La posizione di @attributes rispetto alla posizione degli attributi dell'elemento è importante. Quando viene eseguito lo splatting di @attributes sull'elemento, gli attributi vengono elaborati da destra a sinistra (dall'ultimo al primo). Si consideri l'esempio seguente di un componente padre che utilizza un componente figlio:

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>

L'attributo extra del componente AttributeOrderChild1 è impostato a destra di @attributes. L'elemento <div> sottoposto a rendering del componente AttributeOrderParent1 contiene extra="5" quando viene passato attraverso l'attributo aggiuntivo perché gli attributi vengono elaborati da destra a sinistra (dall'ultimo al primo):

<div extra="5" />

Nell'esempio seguente l'ordine di extra e @attributes viene invertito nell'elemento <div> del componente figlio:

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>

La pagina Web sottoposta a rendering del componente padre <div> contiene extra="10" quando viene elaborata dall'attributo aggiuntivo:

<div extra="10" />