Criar e usar ASP.NET Core componentes do RazorCreate and use ASP.NET Core Razor components

De Luke Latham e Daniel RothBy Luke Latham and Daniel Roth

Exibir ou baixar código de exemplo (como baixar)View or download sample code (how to download)

Os aplicativos mais elaborados são criados usando componentes.Blazor apps are built using components. Um componente é uma parte independente da interface do usuário (IU), como uma página, uma caixa de diálogo ou um formulário.A component is a self-contained chunk of user interface (UI), such as a page, dialog, or form. Um componente inclui marcação HTML e a lógica de processamento necessária para injetar dados ou responder a eventos da interface do usuário.A component includes HTML markup and the processing logic required to inject data or respond to UI events. Os componentes são flexíveis e leves.Components are flexible and lightweight. Eles podem ser aninhados, reutilizados e compartilhados entre projetos.They can be nested, reused, and shared among projects.

Classes de componenteComponent classes

Os componentes são implementados em arquivos de componente do Razor ( . Razor) C# usando uma combinação de marcação HTML e.Components are implemented in Razor component files (.razor) using a combination of C# and HTML markup. Um componente no mais alto é conhecido formalmente como um componente do Razor.A component in Blazor is formally referred to as a Razor component.

O nome de um componente deve começar com um caractere maiúsculo.A component's name must start with an uppercase character. Por exemplo, MyCoolComponent. Razor é válido e MyCoolComponent. Razor é inválido.For example, MyCoolComponent.razor is valid, and myCoolComponent.razor is invalid.

Os componentes podem ser criados usando a extensão de arquivo . cshtml , desde que os arquivos sejam identificados como arquivos de componente do _RazorComponentInclude Razor usando a Propriedade MSBuild.Components can be authored using the .cshtml file extension as long as the files are identified as Razor component files using the _RazorComponentInclude MSBuild property. Por exemplo, um aplicativo que especifica que todos os arquivos . cshtml na pasta páginas devem ser tratados como arquivos de componentes do Razor:For example, an app that specifies that all .cshtml files under the Pages folder should be treated as Razor components files:

<PropertyGroup>
  <_RazorComponentInclude>Pages\**\*.cshtml</_RazorComponentInclude>
</PropertyGroup>

A interface do usuário para um componente é definida usando HTML.The UI for a component is defined using HTML. A lógica de renderização dinâmica (por exemplo, loops, condicionais, expressões) é adicionada usando uma sintaxe de C# inserida chamada Razor.Dynamic rendering logic (for example, loops, conditionals, expressions) is added using an embedded C# syntax called Razor. Quando um aplicativo é compilado, a marcação HTML e C# a lógica de renderização são convertidas em uma classe de componente.When an app is compiled, the HTML markup and C# rendering logic are converted into a component class. O nome da classe gerada corresponde ao nome do arquivo.The name of the generated class matches the name of the file.

Os membros da classe de componente são definidos em um bloco @code.Members of the component class are defined in an @code block. @code No bloco, estado do componente (Propriedades, campos) é especificado com métodos para manipulação de eventos ou para definir outra lógica de componente.In the @code block, component state (properties, fields) is specified with methods for event handling or for defining other component logic. Mais de um bloco de @code é permitido.More than one @code block is permissible.

Observação

Nas visualizações anteriores do ASP.NET Core 3,0, @functions os blocos foram usados para a mesma finalidade que @code os blocos nos componentes do Razor.In prior previews of ASP.NET Core 3.0, @functions blocks were used for the same purpose as @code blocks in Razor components. @functionsos blocos continuam a funcionar em componentes do Razor, mas é recomendável usar o @code bloco no ASP.NET Core 3,0 Preview 6 ou posterior.@functions blocks continue to function in Razor components, but we recommend using the @code block in ASP.NET Core 3.0 Preview 6 or later.

Os membros do componente podem ser usados como parte da lógica de renderização do C# componente usando expressões que @começam com.Component members can be used as part of the component's rendering logic using C# expressions that start with @. Por exemplo, um C# campo é renderizado pela prefixação @ para o nome do campo.For example, a C# field is rendered by prefixing @ to the field name. O exemplo a seguir avalia e renderiza:The following example evaluates and renders:

  • _headingFontStylepara o valor da propriedade de font-styleCSS para._headingFontStyle to the CSS property value for font-style.
  • _headingTextpara o conteúdo do <h1> elemento._headingText to the content of the <h1> element.
<h1 style="font-style:@_headingFontStyle">@_headingText</h1>

@code {
    private string _headingFontStyle = "italic";
    private string _headingText = "Put on your new Blazor!";
}

Depois que o componente é processado inicialmente, o componente regenera sua árvore de renderização em resposta a eventos.After the component is initially rendered, the component regenerates its render tree in response to events. Em seguida, ele compara a nova árvore de renderização com a anterior e aplica quaisquer modificações ao Modelo de Objeto do Documento do navegador (DOM).Blazor then compares the new render tree against the previous one and applies any modifications to the browser's Document Object Model (DOM).

Os componentes são C# classes comuns e podem ser colocados em qualquer lugar dentro de um projeto.Components are ordinary C# classes and can be placed anywhere within a project. Os componentes que produzem páginas da Web geralmente residem na pasta páginas .Components that produce webpages usually reside in the Pages folder. Os componentes que não são de página são frequentemente colocados na pasta compartilhada ou em uma pasta personalizada adicionada ao projeto.Non-page components are frequently placed in the Shared folder or a custom folder added to the project. Para usar uma pasta personalizada, adicione o namespace da pasta personalizada ao componente pai ou ao arquivo _Imports. Razor do aplicativo.To use a custom folder, add the custom folder's namespace to either the parent component or to the app's _Imports.razor file. Por exemplo, o namespace a seguir torna os componentes em uma pasta componentes disponíveis quando o namespace raiz do WebApplicationaplicativo é:For example, the following namespace makes components in a Components folder available when the app's root namespace is WebApplication:

@using WebApplication.Components

Integrar componentes em aplicativos Razor Pages e MVCIntegrate components into Razor Pages and MVC apps

Use componentes com os aplicativos Razor Pages e MVC existentes.Use components with existing Razor Pages and MVC apps. Não é necessário reescrever páginas ou exibições existentes para usar os componentes do Razor.There's no need to rewrite existing pages or views to use Razor components. Quando a página ou a exibição é renderizada, os componentes são renderizados ao mesmo tempo.When the page or view is rendered, components are prerendered at the same time.

Para renderizar um componente de uma página ou exibição, use RenderComponentAsync<TComponent> o método auxiliar HTML:To render a component from a page or view, use the RenderComponentAsync<TComponent> HTML helper method:

<div id="Counter">
    @(await Html.RenderComponentAsync<Counter>(new { IncrementAmount = 10 }))
</div>

Embora as páginas e exibições possam usar componentes, o inverso não é verdadeiro.While pages and views can use components, the converse isn't true. Os componentes não podem usar cenários específicos de exibição e de página, como exibições parciais e seções.Components can't use view- and page-specific scenarios, such as partial views and sections. Para usar a lógica da exibição parcial em um componente, desfatore a lógica de exibição parcial em um componente.To use logic from partial view in a component, factor out the partial view logic into a component.

Para obter mais informações sobre como os componentes são renderizados e o estado do componente é gerenciado no mais alto aplicativo do Modelos de hospedagem mais amASP.NET Core lado do servidor, consulte o artigo.For more information on how components are rendered and component state is managed in Blazor server-side apps, see the Modelos de hospedagem mais amASP.NET Core article.

Usar componentesUse components

Os componentes podem incluir outros componentes, declarando-os usando a sintaxe do elemento HTML.Components can include other components by declaring them using HTML element syntax. A marcação para uso de um componente é semelhante a uma marca HTML, em que o nome da marca é o tipo de componente.The markup for using a component looks like an HTML tag where the name of the tag is the component type.

A associação de atributo diferencia maiúsculas de minúsculas.Attribute binding is case sensitive. Por exemplo, @bind é válido e @Bind é inválido.For example, @bind is valid, and @Bind is invalid.

A marcação a seguir no index. Razor renderiza uma HeadingComponent instância:The following markup in Index.razor renders a HeadingComponent instance:

<HeadingComponent />

Componentes/HeadingComponent. Razor:Components/HeadingComponent.razor:

@using System.Globalization
@*
    The 'using' directive makes System.Globalization available to 
    the component. System.Globalization provides a method for 
    converting a string into title case (capitalizes the first 
    letter of every word in a string), which is used to convert a 
    a string into title case for a heading.
*@

@*
    Heading text is rendered by evaluating the _headingText field. 
    The font-style of the heading is rendered by evaluating the 
    _headingFontStyle field.
*@
<h1 style="font-style:@_headingFontStyle">@_headingText</h1>

<form>
    <div>
        @*
            A check box sets the font style and is bound to the 
            _italicsCheck field.
        *@
        <input type="checkbox" id="italicsCheck" 
               @bind="_italicsCheck" />
        <label class="form-check-label" 
            for="italicsCheck">Use italics</label>
    </div>

    @*
        When the form is submitted, the onclick event executes 
        the UpdateHeading method.
    *@
    <button type="button" class="btn btn-primary" @onclick="UpdateHeading">
        Update heading
    </button>
</form>

@code {
    private static TextInfo _tinfo = CultureInfo.CurrentCulture.TextInfo;
    private string _headingText = 
        _tinfo.ToTitleCase("welcome to blazor!");
    private string _headingFontStyle = "normal";
    private bool _italicsCheck = false;

    // When UpdateHeading is executed, _italicsCheck determines 
    // the value of _headingFontStyle to set the font style of the 
    // heading.
    public void UpdateHeading()
    {
        _headingFontStyle = _italicsCheck ? "italic" : "normal";
    }
}

Se um componente contiver um elemento HTML com uma letra maiúscula ou minúscula que não corresponda a um nome de componente, um aviso será emitido indicando que o elemento tem um nome inesperado.If a component contains an HTML element with an uppercase first letter that doesn't match a component name, a warning is emitted indicating that the element has an unexpected name. A adição @using de uma instrução para o namespace do componente torna o componente disponível, o que remove o aviso.Adding an @using statement for the component's namespace makes the component available, which removes the warning.

Parâmetros do componenteComponent parameters

Os componentes podem ter parâmetros de componente, que são definidos usando propriedades públicas na classe de componente [Parameter] com o atributo.Components can have component parameters, which are defined using public properties on the component class with the [Parameter] attribute. Use atributos para especificar argumentos para um componente na marcação.Use attributes to specify arguments for a component in markup.

Componentes/ChildComponent. Razor:Components/ChildComponent.razor:

<div class="panel panel-default">
    <div class="panel-heading">@Title</div>
    <div class="panel-body">@ChildContent</div>

    <button class="btn btn-primary" @onclick="OnClick">
        Trigger a Parent component method
    </button>
</div>

@code {
    [Parameter]
    public string Title { get; set; }

    [Parameter]
    public RenderFragment ChildContent { get; set; }

    [Parameter]
    public EventCallback<UIMouseEventArgs> OnClick { get; set; }
}

No exemplo a seguir, ParentComponent define o valor Title da Propriedade do ChildComponent.In the following example, the ParentComponent sets the value of the Title property of the ChildComponent.

Páginas/ParentComponent. Razor:Pages/ParentComponent.razor:

@page "/ParentComponent"

<h1>Parent-child example</h1>

<ChildComponent Title="Panel Title from Parent"
                OnClick="@ShowMessage">
    Content of the child component is supplied
    by the parent component.
</ChildComponent>

<p><b>@messageText</b></p>

@code {
    private string messageText;

    private void ShowMessage(UIMouseEventArgs e)
    {
        messageText = "Blaze a new trail with Blazor!";
    }
}

Conteúdo filhoChild content

Os componentes podem definir o conteúdo de outro componente.Components can set the content of another component. O componente de atribuição fornece o conteúdo entre as marcas que especificam o componente de recebimento.The assigning component provides the content between the tags that specify the receiving component.

No exemplo a seguir, o ChildComponent tem uma ChildContent propriedade que representa um RenderFragment, que representa um segmento de interface do usuário a ser renderizado.In the following example, the ChildComponent has a ChildContent property that represents a RenderFragment, which represents a segment of UI to render. O valor de ChildContent é posicionado na marcação do componente onde o conteúdo deve ser renderizado.The value of ChildContent is positioned in the component's markup where the content should be rendered. O valor de ChildContent é recebido do componente pai e renderizado dentro do panel-bodypainel de inicialização.The value of ChildContent is received from the parent component and rendered inside the Bootstrap panel's panel-body.

Componentes/ChildComponent. Razor:Components/ChildComponent.razor:

<div class="panel panel-default">
    <div class="panel-heading">@Title</div>
    <div class="panel-body">@ChildContent</div>

    <button class="btn btn-primary" @onclick="OnClick">
        Trigger a Parent component method
    </button>
</div>

@code {
    [Parameter]
    public string Title { get; set; }

    [Parameter]
    public RenderFragment ChildContent { get; set; }

    [Parameter]
    public EventCallback<UIMouseEventArgs> OnClick { get; set; }
}

Observação

A propriedade que recebe RenderFragment o conteúdo deve ser ChildContent nomeada por convenção.The property receiving the RenderFragment content must be named ChildContent by convention.

O seguinte ParentComponent pode fornecer conteúdo para renderizar ChildComponent o colocando o conteúdo dentro das <ChildComponent> marcas.The following ParentComponent can provide content for rendering the ChildComponent by placing the content inside the <ChildComponent> tags.

Páginas/ParentComponent. Razor:Pages/ParentComponent.razor:

@page "/ParentComponent"

<h1>Parent-child example</h1>

<ChildComponent Title="Panel Title from Parent"
                OnClick="@ShowMessage">
    Content of the child component is supplied
    by the parent component.
</ChildComponent>

<p><b>@messageText</b></p>

@code {
    private string messageText;

    private void ShowMessage(UIMouseEventArgs e)
    {
        messageText = "Blaze a new trail with Blazor!";
    }
}

Atributo nivelamento e parâmetros arbitráriosAttribute splatting and arbitrary parameters

Os componentes podem capturar e renderizar atributos adicionais além dos parâmetros declarados do componente.Components can capture and render additional attributes in addition to the component's declared parameters. Atributos adicionais podem ser capturados em um dicionário e, em seguida, splatted em um elemento quando o componente @attributes é renderizado usando a diretiva Razor.Additional attributes can be captured in a dictionary and then splatted onto an element when the component is rendered using the @attributes Razor directive. Esse cenário é útil ao definir um componente que produz um elemento de marcação que dá suporte a uma variedade de personalizações.This scenario is useful when defining a component that produces a markup element that supports a variety of customizations. Por exemplo, pode ser entediante definir atributos separadamente para um <input> que dê suporte a muitos parâmetros.For example, it can be tedious to define attributes separately for an <input> that supports many parameters.

No exemplo a seguir, o primeiro <input> elemento (id="useIndividualParams") usa parâmetros de componente individuais, enquanto o <input> segundo elementoid="useAttributesDict"() usa o atributo nivelamento:In the following example, the first <input> element (id="useIndividualParams") uses individual component parameters, while the second <input> element (id="useAttributesDict") uses attribute splatting:

<input id="useIndividualParams"
       maxlength="@Maxlength"
       placeholder="@Placeholder"
       required="@Required"
       size="@Size" />

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

@code {
    [Parameter]
    public string Maxlength { get; set; } = "10";

    [Parameter]
    public string Placeholder { get; set; } = "Input placeholder text";

    [Parameter]
    public string Required { get; set; } = "required";

    [Parameter]
    public string Size { get; set; } = "50";

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

O tipo do parâmetro deve implementar IEnumerable<KeyValuePair<string, object>> com chaves de cadeia de caracteres.The type of the parameter must implement IEnumerable<KeyValuePair<string, object>> with string keys. Usar IReadOnlyDictionary<string, object> também é uma opção nesse cenário.Using IReadOnlyDictionary<string, object> is also an option in this scenario.

Os elementos <input> renderizados usando ambas as abordagens são idênticos:The rendered <input> elements using both approaches is identical:

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

Para aceitar atributos arbitrários, defina um parâmetro de componente [Parameter] usando o atributo CaptureUnmatchedValues com a propriedade truedefinida como:To accept arbitrary attributes, define a component parameter using the [Parameter] attribute with the CaptureUnmatchedValues property set to 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.The CaptureUnmatchedValues property on [Parameter] allows the parameter to match all attributes that don't match any other parameter. Um componente só pode definir um único parâmetro com CaptureUnmatchedValues.A component can only define a single parameter with CaptureUnmatchedValues. O tipo de propriedade usado CaptureUnmatchedValues com deve ser atribuível de Dictionary<string, object> com chaves de cadeia de caracteres.The property type used with CaptureUnmatchedValues must be assignable from Dictionary<string, object> with string keys. IEnumerable<KeyValuePair<string, object>>ou IReadOnlyDictionary<string, object> também são opções neste cenário.IEnumerable<KeyValuePair<string, object>> or IReadOnlyDictionary<string, object> are also options in this scenario.

Associação de dadosData binding

A ligação de dados com os componentes e os elementos DOM é @bind realizada com o atributo.Data binding to both components and DOM elements is accomplished with the @bind attribute. O exemplo a seguir associa o _italicsCheck campo ao estado marcado da caixa de seleção:The following example binds the _italicsCheck field to the check box's checked state:

<input type="checkbox" class="form-check-input" id="italicsCheck" 
    @bind="_italicsCheck" />

Quando a caixa de seleção é marcada e desmarcada, o valor da propriedade true é falseatualizado para e, respectivamente.When the check box is selected and cleared, the property's value is updated to true and false, respectively.

A caixa de seleção é atualizada na interface do usuário somente quando o componente é renderizado, não em resposta à alteração do valor da propriedade.The check box is updated in the UI only when the component is rendered, not in response to changing the property's value. Como os componentes são renderizados após a execução do código do manipulador de eventos, as atualizações de propriedade geralmente são refletidas na interface do usuário imediatamente.Since components render themselves after event handler code executes, property updates are usually reflected in the UI immediately.

Usar @bind with a CurrentValue Property (<input @bind="CurrentValue" />) é essencialmente equivalente ao seguinte:Using @bind with a CurrentValue property (<input @bind="CurrentValue" />) is essentially equivalent to the following:

<input value="@CurrentValue"
    @onchange="@((UIChangeEventArgs __e) => CurrentValue = __e.Value)" />

Quando o componente é renderizado, value o do elemento de entrada vem CurrentValue da propriedade.When the component is rendered, the value of the input element comes from the CurrentValue property. Quando o usuário digita na caixa de texto, o onchange evento é acionado e CurrentValue a propriedade é definida como o valor alterado.When the user types in the text box, the onchange event is fired and the CurrentValue property is set to the changed value. Na realidade, a geração de código é um pouco mais complexa @bind porque lida com alguns casos em que as conversões de tipo são executadas.In reality, the code generation is a little more complex because @bind handles a few cases where type conversions are performed. Em princípio, @bind associa o valor atual de uma expressão a um value atributo e manipula as alterações usando o manipulador registrado.In principle, @bind associates the current value of an expression with a value attribute and handles changes using the registered handler.

Além de onchange manipular eventos com @bind-value @bind sintaxe, uma propriedade ou campo pode ser associado usando outros eventos, especificando um atributo com um event parâmetro (@bind-value:event).In addition to handling onchange events with @bind syntax, a property or field can be bound using other events by specifying an @bind-value attribute with an event parameter (@bind-value:event). O exemplo a seguir associa a CurrentValue propriedade para o oninput evento:The following example binds the CurrentValue property for the oninput event:

<input @bind-value="CurrentValue" @bind-value:event="oninput" />

Ao onchangecontrário de, que é acionado quando o oninput elemento perde o foco, é acionado quando o valor da caixa de texto é alterado.Unlike onchange, which fires when the element loses focus, oninput fires when the value of the text box changes.

GlobalizaçãoGlobalization

@bindos valores são formatados para exibição e analisados usando as regras da cultura atual.@bind values are formatted for display and parsed using the current culture's rules.

A cultura atual pode ser acessada System.Globalization.CultureInfo.CurrentCulture a partir da propriedade.The current culture can be accessed from the System.Globalization.CultureInfo.CurrentCulture property.

CultureInfo. InvariantCulture é usado para os seguintes tipos de campo<input type="{TYPE}" />():CultureInfo.InvariantCulture is used for the following field types (<input type="{TYPE}" />):

  • date
  • number

Os tipos de campo anteriores:The preceding field types:

  • São exibidos usando suas regras de formatação baseadas em navegador apropriadas.Are displayed using their appropriate browser-based formatting rules.
  • Não pode conter texto de forma livre.Can't contain free-form text.
  • Fornecer características de interação do usuário com base na implementação do navegador.Provide user interaction characteristics based on the browser's implementation.

Os seguintes tipos de campo têm requisitos de formatação específicos e atualmente não são compatíveis com o mais grande, pois não têm suporte de todos os principais navegadores:The following field types have specific formatting requirements and aren't currently supported by Blazor because they aren't supported by all major browsers:

  • datetime-local
  • month
  • week

@binddá suporte ao System.Globalization.CultureInfo @bind:culture parâmetro para fornecer um para análise e formatação de um valor.@bind supports the @bind:culture parameter to provide a System.Globalization.CultureInfo for parsing and formatting a value. Não é recomendável especificar uma cultura ao date usar number os tipos de campo e.Specifying a culture isn't recommended when using the date and number field types. datee number têm suporte interno de mais alto que fornece a cultura necessária.date and number have built-in Blazor support that provides the required culture.

Para obter informações sobre como definir a cultura do usuário, consulte a seção localização .For information on how to set the user's culture, see the Localization section.

Formatar cadeias de caracteresFormat strings

A vinculação de dados DateTime funciona com cadeias de caracteres de formato usando. @bind:formatData binding works with DateTime format strings using @bind:format. Outras expressões de formato, como formatos de moeda ou número, não estão disponíveis no momento.Other format expressions, such as currency or number formats, aren't available at this time.

<input @bind="StartDate" @bind:format="yyyy-MM-dd" />

@code {
    [Parameter]
    public DateTime StartDate { get; set; } = new DateTime(2020, 1, 1);
}

No código anterior, o <input> tipo de campo do elemento (type) usa como textpadrão.In the preceding code, the <input> element's field type (type) defaults to text. @bind:formattem suporte para ligar os seguintes tipos .NET:@bind:format is supported for binding the following .NET types:

O @bind:format atributo especifica o formato de data a ser aplicado value ao do <input> elemento.The @bind:format attribute specifies the date format to apply to the value of the <input> element. O formato também é usado para analisar o valor quando ocorre onchange um evento.The format is also used to parse the value when an onchange event occurs.

Não é recomendável especificar date um formato para o tipo de campo porque o mais alto tem suporte interno para formatar datas.Specifying a format for the date field type isn't recommended because Blazor has built-in support to format dates.

Parâmetros do componenteComponent parameters

A associação reconhece os parâmetros do @bind-{property} componente, onde pode associar um valor de propriedade entre componentes.Binding recognizes component parameters, where @bind-{property} can bind a property value across components.

O componente filho a seguirChildComponent() tem Year um parâmetro de YearChanged componente e um retorno de chamada:The following child component (ChildComponent) has a Year component parameter and YearChanged callback:

<h2>Child Component</h2>

<p>Year: @Year</p>

@code {
    [Parameter]
    public int Year { get; set; }

    [Parameter]
    public EventCallback<int> YearChanged { get; set; }
}

EventCallback<T>é explicado na seção EventCallback .EventCallback<T> is explained in the EventCallback section.

O componente pai a seguir ChildComponent usa e associa o ParentYear parâmetro Year do pai ao parâmetro no componente filho:The following parent component uses ChildComponent and binds the ParentYear parameter from the parent to the Year parameter on the child component:

@page "/ParentComponent"

<h1>Parent Component</h1>

<p>ParentYear: @ParentYear</p>

<ChildComponent @bind-Year="ParentYear" />

<button class="btn btn-primary" @onclick="ChangeTheYear">
    Change Year to 1986
</button>

@code {
    [Parameter]
    public int ParentYear { get; set; } = 1978;

    private void ChangeTheYear()
    {
        ParentYear = 1986;
    }
}

O carregamento ParentComponent do produz a seguinte marcação:Loading the ParentComponent produces the following markup:

<h1>Parent Component</h1>

<p>ParentYear: 1978</p>

<h2>Child Component</h2>

<p>Year: 1978</p>

ParentYear Se o valor da propriedade for alterado selecionando o botão ParentComponentno ChildComponent , a Year Propriedade do será atualizada.If the value of the ParentYear property is changed by selecting the button in the ParentComponent, the Year property of the ChildComponent is updated. O novo valor de Year é renderizado na interface do usuário ParentComponent quando o é rerenderizado:The new value of Year is rendered in the UI when the ParentComponent is rerendered:

<h1>Parent Component</h1>

<p>ParentYear: 1986</p>

<h2>Child Component</h2>

<p>Year: 1986</p>

O Year parâmetro é ligável porque tem um evento YearChanged complementar que Year corresponde ao tipo do parâmetro.The Year parameter is bindable because it has a companion YearChanged event that matches the type of the Year parameter.

Por convenção, <ChildComponent @bind-Year="ParentYear" /> é essencialmente equivalente a escrever:By convention, <ChildComponent @bind-Year="ParentYear" /> is essentially equivalent to writing:

<ChildComponent @bind-Year="ParentYear" @bind-Year:event="YearChanged" />

Em geral, uma propriedade pode ser associada a um manipulador de eventos correspondente @bind-property:event usando o atributo.In general, a property can be bound to a corresponding event handler using @bind-property:event attribute. Por exemplo, a propriedade MyProp pode ser associada ao MyEventHandler uso dos dois atributos a seguir:For example, the property MyProp can be bound to MyEventHandler using the following two attributes:

<MyComponent @bind-MyProp="MyValue" @bind-MyProp:event="MyEventHandler" />

Manipulação de eventosEvent handling

Os componentes do Razor fornecem recursos de manipulação de eventos.Razor components provide event handling features. Para um atributo de elemento HTML on{event} chamado (por exemplo onclick , onsubmite) com um valor de tipo delegado, os componentes do Razor tratam o valor do atributo como um manipulador de eventos.For an HTML element attribute named on{event} (for example, onclick and onsubmit) with a delegate-typed value, Razor components treats the attribute's value as an event handler. O nome do atributo é sempre formatado @on{Event}.The attribute's name is always formatted @on{event}.

O código a seguir chama UpdateHeading o método quando o botão é selecionado na interface do usuário:The following code calls the UpdateHeading method when the button is selected in the UI:

<button class="btn btn-primary" @onclick="UpdateHeading">
    Update heading
</button>

@code {
    private void UpdateHeading(UIMouseEventArgs e)
    {
        ...
    }
}

O código a seguir chama CheckChanged o método quando a caixa de seleção é alterada na interface do usuário:The following code calls the CheckChanged method when the check box is changed in the UI:

<input type="checkbox" class="form-check-input" @onchange="CheckChanged" />

@code {
    private void CheckChanged()
    {
        ...
    }
}

Os manipuladores de eventos também podem ser assíncronos Taske retornar um.Event handlers can also be asynchronous and return a Task. Não há necessidade de chamar StateHasChanged()manualmente.There's no need to manually call StateHasChanged(). As exceções são registradas quando ocorrem.Exceptions are logged when they occur.

No exemplo a seguir, UpdateHeading é chamado de forma assíncrona quando o botão é selecionado:In the following example, UpdateHeading is called asynchronously when the button is selected:

<button class="btn btn-primary" @onclick="UpdateHeading">
    Update heading
</button>

@code {
    private async Task UpdateHeading(UIMouseEventArgs e)
    {
        ...
    }
}

Tipos de argumento de eventoEvent argument types

Para alguns eventos, são permitidos tipos de argumento de evento.For some events, event argument types are permitted. Se o acesso a um desses tipos de evento não for necessário, ele não será necessário na chamada do método.If access to one of these event types isn't necessary, it isn't required in the method call.

Os UIEventArgs com suporte são mostrados na tabela a seguir.Supported UIEventArgs are shown in the following table.

eventoEvent ClasseClass
Área de TransferênciaClipboard UIClipboardEventArgs
ArrasteDrag UIDragEventArgsé usado para manter os dados arrastados durante uma operação de arrastar e soltar e pode conter um UIDataTransferItemou mais. – DataTransferUIDragEventArgsDataTransfer is used to hold the dragged data during a drag and drop operation and may hold one or more UIDataTransferItem. UIDataTransferItemrepresenta um item de dados de arrastar.UIDataTransferItem represents one drag data item.
ErroError UIErrorEventArgs
FocoFocus UIFocusEventArgsNão inclui suporte para relatedTarget. –UIFocusEventArgs – Doesn't include support for relatedTarget.
<input>alteração<input> change UIChangeEventArgs
TecladoKeyboard UIKeyboardEventArgs
MouseMouse UIMouseEventArgs
Ponteiro do mouseMouse pointer UIPointerEventArgs
Roda do mouseMouse wheel UIWheelEventArgs
ProgressoProgress UIProgressEventArgs
ToqueTouch UITouchEventArgs– representaumúnicopontodecontatoemumUITouchPoint dispositivo sensível ao toque.UITouchEventArgsUITouchPoint represents a single contact point on a touch-sensitive device.

Para obter informações sobre as propriedades e o comportamento de manipulação de eventos dos eventos na tabela anterior, consulte classes EventArgs na origem de referência.For information on the properties and event handling behavior of the events in the preceding table, see EventArgs classes in the reference source.

Expressões lambdaLambda expressions

As expressões lambda também podem ser usadas:Lambda expressions can also be used:

<button @onclick="@(e => Console.WriteLine("Hello, world!"))">Say hello</button>

Geralmente, é conveniente fechar valores adicionais, como ao iterar em um conjunto de elementos.It's often convenient to close over additional values, such as when iterating over a set of elements. O exemplo a seguir cria três botões, cada um dos UpdateHeading quais chamadas passando um argumentoUIMouseEventArgsde evento () e seubuttonNumbernúmero de botão () quando selecionado na interface do usuário:The following example creates three buttons, each of which calls UpdateHeading passing an event argument (UIMouseEventArgs) and its button number (buttonNumber) when selected in the UI:

<h2>@message</h2>

@for (var i = 1; i < 4; i++)
{
    var buttonNumber = i;

    <button class="btn btn-primary"
            @onclick="@(e => UpdateHeading(e, buttonNumber))">
        Button #@i
    </button>
}

@code {
    private string message = "Select a button to learn its position.";

    private void UpdateHeading(UIMouseEventArgs e, int buttonNumber)
    {
        message = $"You selected Button #{buttonNumber} at " +
            $"mouse position: {e.ClientX} X {e.ClientY}.";
    }
}

Observação

Não use a variável de loop (i) em um for loop diretamente em uma expressão lambda.Do not use the loop variable (i) in a for loop directly in a lambda expression. Caso contrário, a mesma variável é usada por todas as iexpressões lambda, fazendo com que o valor seja o mesmo em todos os lambdas.Otherwise the same variable is used by all lambda expressions causing i's value to be the same in all lambdas. Sempre Capture seu valor em uma variável local (buttonNumber no exemplo anterior) e use-o.Always capture its value in a local variable (buttonNumber in the preceding example) and then use it.

EventCallbackEventCallback

Um cenário comum com componentes aninhados é o desejo de executar o método de um componente pai quando ocorre—um evento de componente filho, por exemplo, quando um onclick evento ocorre no filho.A common scenario with nested components is the desire to run a parent component's method when a child component event occurs—for example, when an onclick event occurs in the child. Para expor eventos entre componentes, use um EventCallback.To expose events across components, use an EventCallback. Um componente pai pode atribuir um método de retorno de chamada a um EventCallbackcomponente filho.A parent component can assign a callback method to a child component's EventCallback.

O ChildComponent no aplicativo de exemplo demonstra como o onclick manipulador de um botão é configurado para receber um EventCallback delegado de exemplo ParentComponent.The ChildComponent in the sample app demonstrates how a button's onclick handler is set up to receive an EventCallback delegate from the sample's ParentComponent. O EventCallback é digitado UIMouseEventArgscom, que é apropriado para onclick um evento de um dispositivo periférico:The EventCallback is typed with UIMouseEventArgs, which is appropriate for an onclick event from a peripheral device:

<div class="panel panel-default">
    <div class="panel-heading">@Title</div>
    <div class="panel-body">@ChildContent</div>

    <button class="btn btn-primary" @onclick="OnClick">
        Trigger a Parent component method
    </button>
</div>

@code {
    [Parameter]
    public string Title { get; set; }

    [Parameter]
    public RenderFragment ChildContent { get; set; }

    [Parameter]
    public EventCallback<UIMouseEventArgs> OnClick { get; set; }
}

O ParentComponent define o EventCallback<T> filho como seu ShowMessage método:The ParentComponent sets the child's EventCallback<T> to its ShowMessage method:

@page "/ParentComponent"

<h1>Parent-child example</h1>

<ChildComponent Title="Panel Title from Parent"
                OnClick="@ShowMessage">
    Content of the child component is supplied
    by the parent component.
</ChildComponent>

<p><b>@messageText</b></p>

@code {
    private string messageText;

    private void ShowMessage(UIMouseEventArgs e)
    {
        messageText = "Blaze a new trail with Blazor!";
    }
}

Quando o botão estiver selecionado no ChildComponent:When the button is selected in the ChildComponent:

  • O ParentComponentmétodoéchamado ShowMessage .The ParentComponent's ShowMessage method is called. messageTexté atualizado e exibido no ParentComponent.messageText is updated and displayed in the ParentComponent.
  • Uma chamada para StateHasChanged não é necessária no método do retorno deShowMessagechamada ().A call to StateHasChanged isn't required in the callback's method (ShowMessage). StateHasChangedé chamado automaticamente para renderizar novamente ParentComponento, assim como eventos filho, rerenderização de componente em manipuladores de eventos que são executados dentro do filho.StateHasChanged is called automatically to rerender the ParentComponent, just as child events trigger component rerendering in event handlers that execute within the child.

EventCallbacke EventCallback<T> permitir delegados assíncronos.EventCallback and EventCallback<T> permit asynchronous delegates. EventCallback<T>é fortemente tipado e requer um tipo de argumento específico.EventCallback<T> is strongly typed and requires a specific argument type. EventCallbackestá com tipo fraco e permite qualquer tipo de argumento.EventCallback is weakly typed and allows any argument type.

<p><b>@messageText</b></p>

@{ var message = "Default Text"; }

<ChildComponent 
    OnClick="@(async () => { await Task.Yield(); messageText = "Blaze It!"; })" />

@code {
    private string messageText;
}

Invocar EventCallback um EventCallback<T> ou InvokeAsync com e aguardar Task:Invoke an EventCallback or EventCallback<T> with InvokeAsync and await the Task:

await callback.InvokeAsync(arg);

Use EventCallback eEventCallback<T> para manipulação de eventos e parâmetros de componente de associação.Use EventCallback and EventCallback<T> for event handling and binding component parameters.

Prefira o tipo fortemente EventCallback<T> tipado EventCallback.Prefer the strongly typed EventCallback<T> over EventCallback. EventCallback<T>fornece melhores comentários de erro para os usuários do componente.EventCallback<T> provides better error feedback to users of the component. Semelhante a outros manipuladores de eventos de interface do usuário, especificar o parâmetro de evento é opcional.Similar to other UI event handlers, specifying the event parameter is optional. Use EventCallback quando não houver valor passado para o retorno de chamada.Use EventCallback when there's no value passed to the callback.

Capturar referências a componentesCapture references to components

As Show referências de componente fornecem uma maneira de fazer referência a uma instância de componente para que você possa emitir comandos para essa Resetinstância, como ou.Component references provide a way to reference a component instance so that you can issue commands to that instance, such as Show or Reset. Para capturar uma referência de componente:To capture a component reference:

<MyLoginDialog @ref="loginDialog" @ref:suppressField ... />

@code {
    private MyLoginDialog loginDialog;

    private void OnSomething()
    {
        loginDialog.Show();
    }
}

Quando o componente é renderizado, loginDialog o campo é populado com a instância de MyLoginDialog componente filho.When the component is rendered, the loginDialog field is populated with the MyLoginDialog child component instance. Em seguida, você pode invocar os métodos .NET na instância do componente.You can then invoke .NET methods on the component instance.

Importante

A loginDialog variável é populada apenas depois que o componente é renderizado e MyLoginDialog sua saída inclui o elemento.The loginDialog variable is only populated after the component is rendered and its output includes the MyLoginDialog element. Até esse ponto, não há nada a fazer referência.Until that point, there's nothing to reference. Para manipular referências de componentes após a conclusão da renderização do componente, OnAfterRenderAsync use OnAfterRender os métodos ou.To manipulate components references after the component has finished rendering, use the OnAfterRenderAsync or OnAfterRender methods.

Embora a captura de referências de componente use uma sintaxe semelhante à captura de referências de elemento, ela não é um recurso de interoperabilidade do JavaScript .While capturing component references use a similar syntax to capturing element references, it isn't a JavaScript interop feature. As referências de componente não são passadas para o código—JavaScript que são usadas apenas no código .net.Component references aren't passed to JavaScript code—they're only used in .NET code.

Observação

Não use referências de componente para converter o estado dos componentes filho.Do not use component references to mutate the state of child components. Em vez disso, use parâmetros declarativos normais para passar dados para componentes filho.Instead, use normal declarative parameters to pass data to child components. O uso de parâmetros declarativos normais resulta em componentes filho que são reprocessados nos horários corretos automaticamente.Use of normal declarative parameters result in child components that rerender at the correct times automatically.

Use @a chave para controlar a preservação de elementos e componentesUse @key to control the preservation of elements and components

Ao renderizar uma lista de elementos ou componentes e, subsequentemente, os elementos ou componentes são alterados, o algoritmo de diferenciação do mais claro deve decidir quais elementos ou componentes anteriores podem ser mantidos e como os objetos de modelo devem ser mapeados para eles.When rendering a list of elements or components and the elements or components subsequently change, Blazor's diffing algorithm must decide which of the previous elements or components can be retained and how model objects should map to them. Normalmente, esse processo é automático e pode ser ignorado, mas há casos em que você talvez queira controlar o processo.Normally, this process is automatic and can be ignored, but there are cases where you may want to control the process.

Considere o exemplo a seguir:Consider the following example:

@foreach (var person in People)
{
    <DetailsEditor Details="@person.Details" />
}

@code {
    [Parameter]
    public IEnumerable<Person> People { get; set; }
}

O conteúdo da People coleção pode ser alterado com entradas inseridas, excluídas ou reordenadas.The contents of the People collection may change with inserted, deleted, or re-ordered entries. Quando o componente é rerenderizado, <DetailsEditor> o componente pode ser alterado para Details receber valores de parâmetro diferentes.When the component rerenders, the <DetailsEditor> component may change to receive different Details parameter values. Isso pode causar um reprocessamento mais complexo do que o esperado.This may cause more complex rerendering than expected. Em alguns casos, a rerenderização pode levar a diferenças de comportamento visíveis, como o foco de elemento perdido.In some cases, rerendering can lead to visible behavior differences, such as lost element focus.

O processo de mapeamento pode ser controlado com @key o atributo de diretiva.The mapping process can be controlled with the @key directive attribute. @keyfaz com que o algoritmo diff garanta a preservação de elementos ou componentes com base no valor da chave:@key causes the diffing algorithm to guarantee preservation of elements or components based on the key's value:

@foreach (var person in People)
{
    <DetailsEditor @key="@person" Details="@person.Details" />
}

@code {
    [Parameter]
    public IEnumerable<Person> People { get; set; }
}

Quando a People coleção é alterada, o algoritmo diff mantém a associação entre <DetailsEditor> instâncias e person instâncias:When the People collection changes, the diffing algorithm retains the association between <DetailsEditor> instances and person instances:

  • Se um Person for excluído People da lista, somente a instância correspondente <DetailsEditor> será removida da interface do usuário.If a Person is deleted from the People list, only the corresponding <DetailsEditor> instance is removed from the UI. Outras instâncias permanecem inalteradas.Other instances are left unchanged.
  • Se um Person for inserido em alguma posição na lista, uma nova <DetailsEditor> instância será inserida na posição correspondente.If a Person is inserted at some position in the list, one new <DetailsEditor> instance is inserted at that corresponding position. Outras instâncias permanecem inalteradas.Other instances are left unchanged.
  • Se Person as entradas forem reordenadas, as <DetailsEditor> instâncias correspondentes serão preservadas e reordenadas na interface do usuário.If Person entries are re-ordered, the corresponding <DetailsEditor> instances are preserved and re-ordered in the UI.

Em alguns cenários, o uso @key de minimiza a complexidade da rerenderização e evita possíveis problemas com partes com estado da alteração do dom, como a posição do foco.In some scenarios, use of @key minimizes the complexity of rerendering and avoids potential issues with stateful parts of the DOM changing, such as focus position.

Importante

As chaves são locais para cada elemento ou componente de contêiner.Keys are local to each container element or component. As chaves não são comparadas globalmente ao longo do documento.Keys aren't compared globally across the document.

Quando usar @a chaveWhen to use @key

Normalmente, faz sentido usar @key sempre que uma lista é renderizada (por exemplo, em um @foreach bloco) e um valor adequado existe para definir o. @keyTypically, it makes sense to use @key whenever a list is rendered (for example, in a @foreach block) and a suitable value exists to define the @key.

Você também pode usar @key o para evitar que o mais incrivelmente de preservar uma subárvore de elementos ou componentes quando um objeto for alterado:You can also use @key to prevent Blazor from preserving an element or component subtree when an object changes:

<div @key="@currentPerson">
    ... content that depends on @currentPerson ...
</div>

Se @currentPerson forem alteradas @key , a diretiva de atributo forçará o mais <div> incrivelmente a descartar todo e seus descendentes e recriar a subárvore dentro da interface do usuário com novos elementos e componentes.If @currentPerson changes, the @key attribute directive forces Blazor to discard the entire <div> and its descendants and rebuild the subtree within the UI with new elements and components. Isso pode ser útil se você precisar garantir que nenhum estado da interface do usuário seja @currentPerson preservado quando houver alterações.This can be useful if you need to guarantee that no UI state is preserved when @currentPerson changes.

Quando não usar @a chaveWhen not to use @key

Há um custo de desempenho ao comparar com @key.There's a performance cost when diffing with @key. O custo de desempenho não é grande, mas @key só especifica se controlar as regras de preservação de elementos ou componentes beneficiam o aplicativo.The performance cost isn't large, but only specify @key if controlling the element or component preservation rules benefit the app.

Mesmo que @key não seja usado, o mais grande preserva o elemento filho e as instâncias de componente o máximo possível.Even if @key isn't used, Blazor preserves child element and component instances as much as possible. A única vantagem de usar @key o é o controle sobre como as instâncias de modelo são mapeadas para as instâncias de componente preservadas, em vez do algoritmo diff, selecionando o mapeamento.The only advantage to using @key is control over how model instances are mapped to the preserved component instances, instead of the diffing algorithm selecting the mapping.

Quais valores usar para @a chaveWhat values to use for @key

Geralmente, faz sentido fornecer um dos seguintes tipos de valor para @key:Generally, it makes sense to supply one of the following kinds of value for @key:

  • Instâncias de objeto de modelo (por exemplo Person , uma instância como no exemplo anterior).Model object instances (for example, a Person instance as in the earlier example). Isso garante a preservação com base na igualdade de referência de objeto.This ensures preservation based on object reference equality.
  • Identificadores exclusivos (por exemplo, valores de chave primária do inttipo string, ou Guid).Unique identifiers (for example, primary key values of type int, string, or Guid).

Verifique se os valores usados @key para não conflitam.Ensure that values used for @key don't clash. Se os valores conflitantes forem detectados no mesmo elemento pai, o mais velho lançará uma exceção porque não pode mapear determinísticamente elementos ou componentes antigos para novos elementos ou componentes.If clashing values are detected within the same parent element, Blazor throws an exception because it can't deterministically map old elements or components to new elements or components. Use apenas valores distintos, como instâncias de objeto ou valores de chave primária.Only use distinct values, such as object instances or primary key values.

Métodos de ciclo de vidaLifecycle methods

OnInitializedAsynce OnInitialized execute o código para inicializar o componente.OnInitializedAsync and OnInitialized execute code to initialize the component. Para executar uma operação assíncrona, OnInitializedAsync use e await a palavra-chave na operação:To perform an asynchronous operation, use OnInitializedAsync and the await keyword on the operation:

protected override async Task OnInitializedAsync()
{
    await ...
}

Para uma operação síncrona, use OnInitialized:For a synchronous operation, use OnInitialized:

protected override void OnInitialized()
{
    ...
}

OnParametersSetAsynce OnParametersSet são chamados quando um componente recebe parâmetros de seu pai e os valores são atribuídos às propriedades.OnParametersSetAsync and OnParametersSet are called when a component has received parameters from its parent and the values are assigned to properties. Esses métodos são executados após a inicialização do componente e cada vez que o componente é renderizado:These methods are executed after component initialization and each time the component is rendered:

protected override async Task OnParametersSetAsync()
{
    await ...
}
protected override void OnParametersSet()
{
    ...
}

OnAfterRenderAsynce OnAfterRender são chamados após a conclusão da renderização de um componente.OnAfterRenderAsync and OnAfterRender are called after a component has finished rendering. Referências de elemento e componente são preenchidas neste ponto.Element and component references are populated at this point. Use este estágio para executar etapas de inicialização adicionais usando o conteúdo renderizado, como a ativação de bibliotecas JavaScript de terceiros que operam nos elementos DOM renderizados.Use this stage to perform additional initialization steps using the rendered content, such as activating third-party JavaScript libraries that operate on the rendered DOM elements.

protected override async Task OnAfterRenderAsync()
{
    await ...
}
protected override void OnAfterRender()
{
    ...
}

Tratar ações assíncronas incompletas no processamentoHandle incomplete async actions at render

Ações assíncronas executadas em eventos de ciclo de vida podem não ter sido concluídas antes que o componente seja renderizado.Asynchronous actions performed in lifecycle events may not have completed before the component is rendered. Os objetos podem null ser ou preenchidos incompletamente com dados enquanto o método de ciclo de vida está em execução.Objects might be null or incompletely populated with data while the lifecycle method is executing. Forneça a lógica de renderização para confirmar que os objetos são inicializados.Provide rendering logic to confirm that objects are initialized. Renderizar elementos de interface do usuário de espaço reservado (por exemplo, uma nullmensagem de carregamento) enquanto objetos são.Render placeholder UI elements (for example, a loading message) while objects are null.

No componente dos modelos mais claros, OnInitializedAsync é substituído para Asychronously receber dados de previsão (forecasts). FetchDataIn the FetchData component of the Blazor templates, OnInitializedAsync is overridden to asychronously receive forecast data (forecasts). Quando forecasts énull, uma mensagem de carregamento é exibida para o usuário.When forecasts is null, a loading message is displayed to the user. Depois que Task o retornado OnInitializedAsync por for concluído, o componente será rerenderizado com o estado atualizado.After the Task returned by OnInitializedAsync completes, the component is rerendered with the updated state.

Pages/FetchData.razor:Pages/FetchData.razor:

@page "/fetchdata"
@using MyBlazorApp.Data
@inject WeatherForecastService ForecastService

<h1>Weather forecast</h1>

<p>This component demonstrates fetching data from a service.</p>

@if (forecasts == null)
{
    <p><em>Loading...</em></p>
}
else
{
    <table class="table">
        <!-- forecast data in table element content -->
    </table>
}

@code {
    private WeatherForecast[] forecasts;

    protected override async Task OnInitializedAsync()
    {
        forecasts = await ForecastService.GetForecastAsync(DateTime.Now);
    }
}

Executar código antes que os parâmetros sejam definidosExecute code before parameters are set

SetParameterspode ser substituído para executar o código antes de os parâmetros serem definidos:SetParameters can be overridden to execute code before parameters are set:

public override void SetParameters(ParameterView parameters)
{
    ...

    base.SetParameters(parameters);
}

Se base.SetParameters não for invocado, o código personalizado poderá interpretar o valor dos parâmetros de entrada de qualquer forma necessária.If base.SetParameters isn't invoked, the custom code can interpret the incoming parameters value in any way required. Por exemplo, os parâmetros de entrada não precisam ser atribuídos às propriedades na classe.For example, the incoming parameters aren't required to be assigned to the properties on the class.

Suprimir a atualização da interface do usuárioSuppress refreshing of the UI

ShouldRenderpode ser substituído para suprimir a atualização da interface do usuário.ShouldRender can be overridden to suppress refreshing of the UI. Se a implementação retornar true, a interface do usuário será atualizada.If the implementation returns true, the UI is refreshed. Mesmo se ShouldRender for substituído, o componente sempre será renderizado inicialmente.Even if ShouldRender is overridden, the component is always initially rendered.

protected override bool ShouldRender()
{
    var renderUI = true;

    return renderUI;
}

Descarte de componentes com IDisposableComponent disposal with IDisposable

Se um componente implementa IDisposable, o método Dispose é chamado quando o componente é removido da interface do usuário.If a component implements IDisposable, the Dispose method is called when the component is removed from the UI. O componente a seguir @implements IDisposable usa o Dispose e o método:The following component uses @implements IDisposable and the Dispose method:

@using System
@implements IDisposable

...

@code {
    public void Dispose()
    {
        ...
    }
}

RoteamentoRouting

O roteamento no mais fácil é obtido fornecendo um modelo de rota para cada componente acessível no aplicativo.Routing in Blazor is achieved by providing a route template to each accessible component in the app.

Quando um arquivo Razor com uma @page diretiva é compilado, a classe gerada recebe um RouteAttribute especificando o modelo de rota.When a Razor file with an @page directive is compiled, the generated class is given a RouteAttribute specifying the route template. Em tempo de execução, o roteador procura classes de componentes RouteAttribute com um e renderiza qualquer componente que tenha um modelo de rota que corresponda à URL solicitada.At runtime, the router looks for component classes with a RouteAttribute and renders whichever component has a route template that matches the requested URL.

Vários modelos de rota podem ser aplicados a um componente.Multiple route templates can be applied to a component. O componente a seguir responde a solicitações /BlazorRoute para /DifferentBlazorRouteo e o:The following component responds to requests for /BlazorRoute and /DifferentBlazorRoute:

@page "/BlazorRoute"
@page "/DifferentBlazorRoute"

<h1>Blazor routing</h1>

Parâmetros de rotaRoute parameters

Os componentes podem receber parâmetros de rota do modelo de rota fornecido @page na diretiva.Components can receive route parameters from the route template provided in the @page directive. O roteador usa parâmetros de rota para preencher os parâmetros de componente correspondentes.The router uses route parameters to populate the corresponding component parameters.

Componente de parâmetro de rota:Route Parameter component:

@page "/RouteParameter"
@page "/RouteParameter/{text}"

<h1>Blazor is @Text!</h1>

@code {
    [Parameter]
    public string Text { get; set; }

    protected override void OnInitialized()
    {
        Text = Text ?? "fantastic";
    }
}

Não há suporte para parâmetros opcionais @page , portanto, duas diretivas são aplicadas no exemplo acima.Optional parameters aren't supported, so two @page directives are applied in the example above. O primeiro permite a navegação para o componente sem um parâmetro.The first permits navigation to the component without a parameter. A segunda @page diretiva usa o {text} parâmetro de rota e atribui o valor à Text propriedade.The second @page directive takes the {text} route parameter and assigns the value to the Text property.

Herança de classe base para uma experiência de "code-behind"Base class inheritance for a "code-behind" experience

Os arquivos de componente misturam C# o código de marcação e processamento HTML no mesmo arquivo.Component files mix HTML markup and C# processing code in the same file. A @inherits diretiva pode ser usada para fornecer aos aplicativos mais incrivelmente uma experiência de "code-behind" que separa a marcação de componente do código de processamento.The @inherits directive can be used to provide Blazor apps with a "code-behind" experience that separates component markup from processing code.

O aplicativo de exemplo mostra como um componente pode herdar uma classe BlazorRocksBasebase,, para fornecer as propriedades e os métodos do componente.The sample app shows how a component can inherit a base class, BlazorRocksBase, to provide the component's properties and methods.

Páginas/BlazorRocks. Razor:Pages/BlazorRocks.razor:

@page "/BlazorRocks"
@*
    The inherit directive provides the properties and methods
    of the BlazorRocksBase class to this component.
*@
@inherits BlazorRocksBase

<h1>@BlazorRocksText</h1> 

BlazorRocksBase.cs:BlazorRocksBase.cs:

using Microsoft.AspNetCore.Components;

namespace BlazorSample
{
    public class BlazorRocksBase : ComponentBase
    {
        public string BlazorRocksText { get; set; } = 
            "Blazor rocks the browser!";
    }
}

A classe base deve derivar ComponentBasede.The base class should derive from ComponentBase.

Importar componentesImport components

O namespace de um componente criado com o Razor se baseia em:The namespace of a component authored with Razor is based on:

  • O projeto RootNamespace.The project's RootNamespace.
  • O caminho da raiz do projeto para o componente.The path from the project root to the component. Por exemplo, ComponentsSample/Pages/Index.razor está no namespace. ComponentsSample.PagesFor example, ComponentsSample/Pages/Index.razor is in the namespace ComponentsSample.Pages. Os componentes C# seguem regras de associação de nome.Components follow C# name binding rules. No caso de index. Razor, todos os componentes na mesma pasta, páginase a pasta pai, ComponentsSample, estão no escopo.In the case of Index.razor, all components in the same folder, Pages, and the parent folder, ComponentsSample, are in scope.

Os componentes definidos em um namespace diferente podem ser trazidos para o escopo usando a diretiva @using do Razor.Components defined in a different namespace can be brought into scope using Razor's @using directive.

Se outro componente, NavMenu.razor, existir na pasta ComponentsSample/Shared/, o Index.razor componente poderá ser usado com a seguinte @using instrução:If another component, NavMenu.razor, exists in the folder ComponentsSample/Shared/, the component can be used in Index.razor with the following @using statement:

@using ComponentsSample.Shared

This is the Index page.

<NavMenu></NavMenu>

Os componentes também podem ser referenciados usando seus nomes totalmente qualificados, o que elimina a @ necessidade da diretiva de uso:Components can also be referenced using their fully qualified names, which removes the need for the @using directive:

This is the Index page.

<ComponentsSample.Shared.NavMenu></ComponentsSample.Shared.NavMenu>

Observação

Não global:: há suporte para a qualificação.The global:: qualification isn't supported.

Não há suporte para a using importação de componentes com instruções @using Foo = Barcom alias (por exemplo,).Importing components with aliased using statements (for example, @using Foo = Bar) isn't supported.

Não há suporte para nomes parcialmente qualificados.Partially qualified names aren't supported. Por exemplo, não @using ComponentsSample há suporte NavMenu.razor para <Shared.NavMenu></Shared.NavMenu> adicionar e referenciar com.For example, adding @using ComponentsSample and referencing NavMenu.razor with <Shared.NavMenu></Shared.NavMenu> isn't supported.

Atributos de elemento HTML condicionalConditional HTML element attributes

Os atributos de elemento HTML são processados condicionalmente com base no valor do .NET.HTML element attributes are conditionally rendered based on the .NET value. Se o valor for false ou null, o atributo não será renderizado.If the value is false or null, the attribute isn't rendered. Se o valor é true, o atributo é processado minimizado.If the value is true, the attribute is rendered minimized.

No exemplo a seguir, IsCompleted determina se checked é renderizado na marcação do elemento:In the following example, IsCompleted determines if checked is rendered in the element's markup:

<input type="checkbox" checked="@IsCompleted" />

@code {
    [Parameter]
    public bool IsCompleted { get; set; }
}

Se IsCompleted fortrue, a caixa de seleção será renderizada como:If IsCompleted is true, the check box is rendered as:

<input type="checkbox" checked />

Se IsCompleted forfalse, a caixa de seleção será renderizada como:If IsCompleted is false, the check box is rendered as:

<input type="checkbox" />

Para obter mais informações, consulte Referência da sintaxe Razor para ASP.NET Core.For more information, see Referência da sintaxe Razor para ASP.NET Core.

HTML brutoRaw HTML

Normalmente, as cadeias de caracteres são renderizadas usando nós de texto DOM, o que significa que qualquer marcação que ela possa conter será ignorada e tratada como texto literal.Strings are normally rendered using DOM text nodes, which means that any markup they may contain is ignored and treated as literal text. Para renderizar HTML bruto, empacote o conteúdo HTML em MarkupString um valor.To render raw HTML, wrap the HTML content in a MarkupString value. O valor é analisado como HTML ou SVG e inserido no DOM.The value is parsed as HTML or SVG and inserted into the DOM.

Aviso

O processamento de HTML bruto construído a partir de qualquer fonte não confiável é um risco à segurança e deve ser evitado!Rendering raw HTML constructed from any untrusted source is a security risk and should be avoided!

O exemplo a seguir mostra como MarkupString usar o tipo para adicionar um bloco de conteúdo HTML estático à saída renderizada de um componente:The following example shows using the MarkupString type to add a block of static HTML content to the rendered output of a component:

@((MarkupString)myMarkup)

@code {
    private string myMarkup = 
        "<p class='markup'>This is a <em>markup string</em>.</p>";
}

Componentes de modeloTemplated components

Componentes modelo são componentes que aceitam um ou mais modelos de interface do usuário como parâmetros, que podem ser usados como parte da lógica de renderização do componente.Templated components are components that accept one or more UI templates as parameters, which can then be used as part of the component's rendering logic. Os componentes de modelo permitem que você crie componentes de nível superior que são mais reutilizáveis do que os componentes normais.Templated components allow you to author higher-level components that are more reusable than regular components. Alguns exemplos incluem:A couple of examples include:

  • Um componente de tabela que permite que um usuário especifique modelos para o cabeçalho, as linhas e o rodapé da tabela.A table component that allows a user to specify templates for the table's header, rows, and footer.
  • Um componente de lista que permite que um usuário especifique um modelo para renderizar itens em uma lista.A list component that allows a user to specify a template for rendering items in a list.

Parâmetros do modeloTemplate parameters

Um componente modelo é definido especificando um ou mais parâmetros de componente do tipo RenderFragment ou. RenderFragment<T>A templated component is defined by specifying one or more component parameters of type RenderFragment or RenderFragment<T>. Um fragmento de renderização representa um segmento de interface do usuário a ser renderizado.A render fragment represents a segment of UI to render. RenderFragment<T>usa um parâmetro de tipo que pode ser especificado quando o fragmento de renderização é invocado.RenderFragment<T> takes a type parameter that can be specified when the render fragment is invoked.

TableTemplatecomponenteTableTemplate component:

@typeparam TItem

<table class="table">
    <thead>
        <tr>@TableHeader</tr>
    </thead>
    <tbody>
        @foreach (var item in Items)
        {
            <tr>@RowTemplate(item)</tr>
        }
    </tbody>
    <tfoot>
        <tr>@TableFooter</tr>
    </tfoot>
</table>

@code {
    [Parameter]
    public RenderFragment TableHeader { get; set; }

    [Parameter]
    public RenderFragment<TItem> RowTemplate { get; set; }

    [Parameter]
    public RenderFragment TableFooter { get; set; }

    [Parameter]
    public IReadOnlyList<TItem> Items { get; set; }
}

Ao usar um componente modelo, os parâmetros do modelo podem ser especificados usando elementos filho que correspondem aos nomes dos parâmetros (TableHeader e RowTemplate no exemplo a seguir):When using a templated component, the template parameters can be specified using child elements that match the names of the parameters (TableHeader and RowTemplate in the following example):

<TableTemplate Items="@pets">
    <TableHeader>
        <th>ID</th>
        <th>Name</th>
    </TableHeader>
    <RowTemplate>
        <td>@context.PetId</td>
        <td>@context.Name</td>
    </RowTemplate>
</TableTemplate>

Parâmetros de contexto de modeloTemplate context parameters

Argumentos de componente do RenderFragment<T> tipo passado como elementos têm um parâmetro implícito context chamado (por exemplo, @context.PetIddo exemplo de código anterior), mas você pode alterar o nome do parâmetro Context usando o atributo no filho elementos.Component arguments of type RenderFragment<T> passed as elements have an implicit parameter named context (for example from the preceding code sample, @context.PetId), but you can change the parameter name using the Context attribute on the child element. No exemplo a seguir, o RowTemplate atributo do Context elemento Especifica o pet parâmetro:In the following example, the RowTemplate element's Context attribute specifies the pet parameter:

<TableTemplate Items="@pets">
    <TableHeader>
        <th>ID</th>
        <th>Name</th>
    </TableHeader>
    <RowTemplate Context="pet">
        <td>@pet.PetId</td>
        <td>@pet.Name</td>
    </RowTemplate>
</TableTemplate>

Como alternativa, você pode especificar o Context atributo no elemento Component.Alternatively, you can specify the Context attribute on the component element. O atributo Context especificado se aplica a todos os parâmetros de modelo especificados.The specified Context attribute applies to all specified template parameters. Isso pode ser útil quando você deseja especificar o nome do parâmetro de conteúdo para conteúdo filho implícito (sem qualquer elemento filho de disposição).This can be useful when you want to specify the content parameter name for implicit child content (without any wrapping child element). No exemplo a seguir, o Context atributo aparece TableTemplate no elemento e se aplica a todos os parâmetros de modelo:In the following example, the Context attribute appears on the TableTemplate element and applies to all template parameters:

<TableTemplate Items="@pets" Context="pet">
    <TableHeader>
        <th>ID</th>
        <th>Name</th>
    </TableHeader>
    <RowTemplate>
        <td>@pet.PetId</td>
        <td>@pet.Name</td>
    </RowTemplate>
</TableTemplate>

Componentes de tipo genéricoGeneric-typed components

Os componentes modelo são geralmente digitados genericamente.Templated components are often generically typed. Por exemplo, um componente ListViewTemplate genérico pode ser usado para renderizar IEnumerable<T> valores.For example, a generic ListViewTemplate component can be used to render IEnumerable<T> values. Para definir um componente genérico, use a @typeparam diretiva para especificar parâmetros de tipo:To define a generic component, use the @typeparam directive to specify type parameters:

@typeparam TItem

<ul>
    @foreach (var item in Items)
    {
        @ItemTemplate(item)
    }
</ul>

@code {
    [Parameter]
    public RenderFragment<TItem> ItemTemplate { get; set; }

    [Parameter]
    public IReadOnlyList<TItem> Items { get; set; }
}

Ao usar componentes de tipos genéricos, o parâmetro de tipo é inferido, se possível:When using generic-typed components, the type parameter is inferred if possible:

<ListViewTemplate Items="@pets">
    <ItemTemplate Context="pet">
        <li>@pet.Name</li>
    </ItemTemplate>
</ListViewTemplate>

Caso contrário, o parâmetro de tipo deve ser especificado explicitamente usando um atributo que corresponda ao nome do parâmetro de tipo.Otherwise, the type parameter must be explicitly specified using an attribute that matches the name of the type parameter. No exemplo a seguir, TItem="Pet" especifica o tipo:In the following example, TItem="Pet" specifies the type:

<ListViewTemplate Items="@pets" TItem="Pet">
    <ItemTemplate Context="pet">
        <li>@pet.Name</li>
    </ItemTemplate>
</ListViewTemplate>

Valores e parâmetros em cascataCascading values and parameters

Em alguns cenários, é inconveniente fluir dados de um componente ancestral para um componente descendente usando parâmetros de componente, especialmente quando há várias camadas de componente.In some scenarios, it's inconvenient to flow data from an ancestor component to a descendent component using component parameters, especially when there are several component layers. Valores e parâmetros em cascata resolvem esse problema fornecendo uma maneira conveniente para um componente ancestral fornecer um valor para todos os seus componentes descendentes.Cascading values and parameters solve this problem by providing a convenient way for an ancestor component to provide a value to all of its descendent components. Valores e parâmetros em cascata também fornecem uma abordagem para que os componentes sejam coordenados.Cascading values and parameters also provide an approach for components to coordinate.

Exemplo de temaTheme example

No exemplo a seguir do aplicativo de exemplo, a ThemeInfo classe especifica as informações do tema para fluir para baixo na hierarquia do componente para que todos os botões de uma determinada parte do aplicativo compartilhem o mesmo estilo.In the following example from the sample app, the ThemeInfo class specifies the theme information to flow down the component hierarchy so that all of the buttons within a given part of the app share the same style.

UIThemeClasses/ThemeInfo.cs:UIThemeClasses/ThemeInfo.cs:

public class ThemeInfo
{
    public string ButtonClass { get; set; }
}

Um componente ancestral pode fornecer um valor em cascata usando o componente de valor em cascata.An ancestor component can provide a cascading value using the Cascading Value component. O CascadingValue componente encapsula uma subárvore da hierarquia do componente e fornece um único valor para todos os componentes dentro dessa subárvore.The CascadingValue component wraps a subtree of the component hierarchy and supplies a single value to all components within that subtree.

Por exemplo, o aplicativo de exemplo especifica informações deThemeInfotema () em um dos layouts do aplicativo como um parâmetro em cascata para todos os componentes que compõem o corpo @Body do layout da propriedade.For example, the sample app specifies theme information (ThemeInfo) in one of the app's layouts as a cascading parameter for all components that make up the layout body of the @Body property. ButtonClassé atribuído um valor de btn-success no componente layout.ButtonClass is assigned a value of btn-success in the layout component. Qualquer componente descendente pode consumir essa propriedade por meio ThemeInfo do objeto em cascata.Any descendent component can consume this property through the ThemeInfo cascading object.

CascadingValuesParametersLayoutcomponenteCascadingValuesParametersLayout component:

@inherits LayoutComponentBase
@using BlazorSample.UIThemeClasses

<div class="container-fluid">
    <div class="row">
        <div class="col-sm-3">
            <NavMenu />
        </div>
        <div class="col-sm-9">
            <CascadingValue Value="@theme">
                <div class="content px-4">
                    @Body
                </div>
            </CascadingValue>
        </div>
    </div>
</div>

@code {
    private ThemeInfo theme = new ThemeInfo { ButtonClass = "btn-success" };
}

Para fazer uso de valores em cascata, os componentes declaram parâmetros em [CascadingParameter] cascata usando o atributo ou com base em um valor de nome de cadeia de caracteres:To make use of cascading values, components declare cascading parameters using the [CascadingParameter] attribute or based on a string name value:

<CascadingValue Value=@PermInfo Name="UserPermissions">...</CascadingValue>

[CascadingParameter(Name = "UserPermissions")]
private PermInfo Permissions { get; set; }

A associação com um valor de nome de cadeia de caracteres será relevante se você tiver vários valores em cascata do mesmo tipo e precisar diferenciá-los na mesma subárvore.Binding with a string name value is relevant if you have multiple cascading values of the same type and need to differentiate them within the same subtree.

Os valores em cascata são associados a parâmetros em cascata por tipo.Cascading values are bound to cascading parameters by type.

No aplicativo de exemplo, o CascadingValuesParametersTheme componente associa o ThemeInfo valor em cascata a um parâmetro em cascata.In the sample app, the CascadingValuesParametersTheme component binds the ThemeInfo cascading value to a cascading parameter. O parâmetro é usado para definir a classe CSS para um dos botões exibidos pelo componente.The parameter is used to set the CSS class for one of the buttons displayed by the component.

CascadingValuesParametersThemecomponenteCascadingValuesParametersTheme component:

@page "/cascadingvaluesparameterstheme"
@layout CascadingValuesParametersLayout
@using BlazorSample.UIThemeClasses

<h1>Cascading Values & Parameters</h1>

<p>Current count: @currentCount</p>

<p>
    <button class="btn" @onclick="IncrementCount">
        Increment Counter (Unthemed)
    </button>
</p>

<p>
    <button class="btn @ThemeInfo.ButtonClass" @onclick="IncrementCount">
        Increment Counter (Themed)
    </button>
</p>

@code {
    private int currentCount = 0;

    [CascadingParameter]
    protected ThemeInfo ThemeInfo { get; set; }

    private void IncrementCount()
    {
        currentCount++;
    }
}

Exemplo de TabSetTabSet example

Os parâmetros em cascata também permitem que os componentes colaborem na hierarquia do componente.Cascading parameters also enable components to collaborate across the component hierarchy. Por exemplo, considere o exemplo de TabSet a seguir no aplicativo de exemplo.For example, consider the following TabSet example in the sample app.

O aplicativo de exemplo tem ITab uma interface que implementa as guias:The sample app has an ITab interface that tabs implement:

using Microsoft.AspNetCore.Components;

namespace BlazorSample.UIInterfaces
{
    public interface ITab
    {
        RenderFragment ChildContent { get; }
    }
}

O CascadingValuesParametersTabSet componente usa o TabSet componente, que contém vários Tab componentes:The CascadingValuesParametersTabSet component uses the TabSet component, which contains several Tab components:

<TabSet>
    <Tab Title="First tab">
        <h4>Greetings from the first tab!</h4>

        <label>
            <input type="checkbox" @bind="showThirdTab" />
            Toggle third tab
        </label>
    </Tab>
    <Tab Title="Second tab">
        <h4>The second tab says Hello World!</h4>
    </Tab>

    @if (showThirdTab)
    {
        <Tab Title="Third tab">
            <h4>Welcome to the disappearing third tab!</h4>
            <p>Toggle this tab from the first tab.</p>
        </Tab>
    }
</TabSet>

Os componentes Tab filho não são passados explicitamente como parâmetros TabSetpara.The child Tab components aren't explicitly passed as parameters to the TabSet. Em vez disso, Tab os componentes filho fazem parte do conteúdo filho TabSetdo.Instead, the child Tab components are part of the child content of the TabSet. No entanto TabSet , o ainda precisa saber sobre Tab cada componente para que ele possa renderizar os cabeçalhos e a guia ativa. Para habilitar essa coordenação sem a necessidade de código adicional, TabSet o componente pode fornecer a si mesmo como um valor em cascata que é então coletado Tab pelos componentes descendentes.However, the TabSet still needs to know about each Tab component so that it can render the headers and the active tab. To enable this coordination without requiring additional code, the TabSet component can provide itself as a cascading value that is then picked up by the descendent Tab components.

TabSetcomponenteTabSet component:

@using BlazorSample.UIInterfaces

<!-- Display the tab headers -->
<CascadingValue Value=this>
    <ul class="nav nav-tabs">
        @ChildContent
    </ul>
</CascadingValue>

<!-- Display body for only the active tab -->
<div class="nav-tabs-body p-4">
    @ActiveTab?.ChildContent
</div>

@code {
    [Parameter]
    public RenderFragment ChildContent { get; set; }

    public ITab ActiveTab { get; private set; }

    public void AddTab(ITab tab)
    {
        if (ActiveTab == null)
        {
            SetActivateTab(tab);
        }
    }

    public void RemoveTab(ITab tab)
    {
        if (ActiveTab == tab)
        {
            SetActivateTab(null);
        }
    }

    public void SetActivateTab(ITab tab)
    {
        if (ActiveTab != tab)
        {
            ActiveTab = tab;
            StateHasChanged();
        }
    }
}

Os componentes Tab descendentes capturam TabSet o que contém como um parâmetro em cascata Tab , de modo que os TabSet componentes se adicionam à coordenada e na qual a guia está ativa.The descendent Tab components capture the containing TabSet as a cascading parameter, so the Tab components add themselves to the TabSet and coordinate on which tab is active.

TabcomponenteTab component:

@using BlazorSample.UIInterfaces
@implements IDisposable
@implements ITab

<li>
    <a @onclick="Activate" class="nav-link @TitleCssClass" role="button">
        @Title
    </a>
</li>

@code {
    [CascadingParameter]
    public TabSet ContainerTabSet { get; set; }

    [Parameter]
    public string Title { get; set; }

    [Parameter]
    public RenderFragment ChildContent { get; set; }

    private string TitleCssClass => ContainerTabSet.ActiveTab == this ? "active" : null;

    protected override void OnInitialized()
    {
        ContainerTabSet.AddTab(this);
    }

    public void Dispose()
    {
        ContainerTabSet.RemoveTab(this);
    }

    private void Activate()
    {
        ContainerTabSet.SetActivateTab(this);
    }
}

Modelos do RazorRazor templates

Os fragmentos de renderização podem ser definidos usando a sintaxe de modelo Razor.Render fragments can be defined using Razor template syntax. Os modelos Razor são uma maneira de definir um trecho de interface do usuário e assumir o seguinte formato:Razor templates are a way to define a UI snippet and assume the following format:

@<{HTML tag}>...</{HTML tag}>

O exemplo a seguir ilustra como especificar RenderFragment e RenderFragment<T> valores e renderizar modelos diretamente em um componente.The following example illustrates how to specify RenderFragment and RenderFragment<T> values and render templates directly in a component. Os fragmentos de renderização também podem ser passados como argumentos para componentes de modelo.Render fragments can also be passed as arguments to templated components.

@timeTemplate

@petTemplate(new Pet { Name = "Rex" })

@code {
    private RenderFragment timeTemplate = @<p>The time is @DateTime.Now.</p>;
    private RenderFragment<Pet> petTemplate = 
        (pet) => @<p>Your pet's name is @pet.Name.</p>;

    private class Pet
    {
        public string Name { get; set; }
    }
}

Saída renderizada do código anterior:Rendered output of the preceding code:

<p>The time is 10/04/2018 01:26:52.</p>

<p>Your pet's name is Rex.</p>

Lógica RenderTreeBuilder manualManual RenderTreeBuilder logic

Microsoft.AspNetCore.Components.RenderTreefornece métodos para manipular componentes e elementos, incluindo a criação manual de componentes C# no código.Microsoft.AspNetCore.Components.RenderTree provides methods for manipulating components and elements, including building components manually in C# code.

Observação

O uso RenderTreeBuilder do para criar componentes é um cenário avançado.Use of RenderTreeBuilder to create components is an advanced scenario. Um componente malformado (por exemplo, uma marca de marcação não fechada) pode resultar em um comportamento indefinido.A malformed component (for example, an unclosed markup tag) can result in undefined behavior.

Considere o seguinte PetDetails componente, que pode ser compilado manualmente em outro componente:Consider the following PetDetails component, which can be manually built into another component:

<h2>Pet Details Component</h2>

<p>@PetDetailsQuote</p>

@code
{
    [Parameter]
    public string PetDetailsQuote { get; set; }
}

No exemplo a seguir, o loop no CreateComponent método gera três PetDetails componentes.In the following example, the loop in the CreateComponent method generates three PetDetails components. Ao chamar RenderTreeBuilder métodos para criar os componentes (OpenComponent e AddAttribute), os números de sequência são números de linha de código-fonte.When calling RenderTreeBuilder methods to create the components (OpenComponent and AddAttribute), sequence numbers are source code line numbers. O algoritmo de diferença mais grande do que se baseia nos números de sequência correspondentes a linhas distintas de código, não a invocações de chamada distintas.The Blazor difference algorithm relies on the sequence numbers corresponding to distinct lines of code, not distinct call invocations. Ao criar um componente com RenderTreeBuilder métodos, codifique os argumentos para números de sequência.When creating a component with RenderTreeBuilder methods, hardcode the arguments for sequence numbers. O uso de um cálculo ou contador para gerar o número de sequência pode levar a um desempenho insatisfatório.Using a calculation or counter to generate the sequence number can lead to poor performance. Para obter mais informações, consulte os números de sequência relacionados à seção números de linha de código e não ordem de execução .For more information, see the Sequence numbers relate to code line numbers and not execution order section.

BuiltContentcomponenteBuiltContent component:

@page "/BuiltContent"

<h1>Build a component</h1>

@CustomRender

<button type="button" @onclick="RenderComponent">
    Create three Pet Details components
</button>

@code {
    private RenderFragment CustomRender { get; set; }
    
    private RenderFragment CreateComponent() => builder =>
    {
        for (var i = 0; i < 3; i++) 
        {
            builder.OpenComponent(0, typeof(PetDetails));
            builder.AddAttribute(1, "PetDetailsQuote", "Someone's best friend!");
            builder.CloseComponent();
        }
    };    
    
    private void RenderComponent()
    {
        CustomRender = CreateComponent();
    }
}

Números de sequência se relacionam a números de linha de código e não a ordem de execuçãoSequence numbers relate to code line numbers and not execution order

.razor Arquivos mais poseriais são sempre compilados.Blazor .razor files are always compiled. Isso é potencialmente uma grande vantagem para .razor o porque a etapa de compilação pode ser usada para injetar informações que melhoram o desempenho do aplicativo em tempo de execução.This is potentially a great advantage for .razor because the compile step can be used to inject information that improve app performance at runtime.

Um exemplo importante desses aprimoramentos envolve números de sequência.A key example of these improvements involve sequence numbers. Os números de sequência indicam ao tempo de execução que as saídas vieram de quais linhas de código distintas e ordenadas.Sequence numbers indicate to the runtime which outputs came from which distinct and ordered lines of code. O tempo de execução usa essas informações para gerar comparações de árvore eficientes em tempo linear, o que é muito mais rápido do que normalmente é possível para um algoritmo de comparação de árvore geral.The runtime uses this information to generate efficient tree diffs in linear time, which is far faster than is normally possible for a general tree diff algorithm.

Considere o seguinte arquivo .razor simples:Consider the following simple .razor file:

@if (someFlag)
{
    <text>First</text>
}

Second

O código anterior é compilado para algo semelhante ao seguinte:The preceding code compiles to something like the following:

if (someFlag)
{
    builder.AddContent(0, "First");
}

builder.AddContent(1, "Second");

Quando o código é executado pela primeira vez, se someFlag for true, o Construtor receberá:When the code executes for the first time, if someFlag is true, the builder receives:

SequênciaSequence TipoType DadosData
00 Nó de textoText node FirstFirst
11 Nó de textoText node SegundoSecond

Imagine que someFlag se falsetorna e a marcação é renderizada novamente.Imagine that someFlag becomes false, and the markup is rendered again. Desta vez, o Construtor recebe:This time, the builder receives:

SequênciaSequence TipoType DadosData
11 Nó de textoText node SegundoSecond

Quando o tempo de execução executa uma comparação, ele vê que o item 0 na sequência foi removido e, portanto, gera o seguinte script de ediçãotrivial:When the runtime performs a diff, it sees that the item at sequence 0 was removed, so it generates the following trivial edit script:

  • Remova o primeiro nó de texto.Remove the first text node.

O que vai errado se você gerar números de sequência programaticamenteWhat goes wrong if you generate sequence numbers programmatically

Imagine, em vez disso, que você escreveu a seguinte lógica do construtor de árvore de renderização:Imagine instead that you wrote the following render tree builder logic:

var seq = 0;

if (someFlag)
{
    builder.AddContent(seq++, "First");
}

builder.AddContent(seq++, "Second");

Agora, a primeira saída é:Now, the first output is:

SequênciaSequence TipoType DadosData
00 Nó de textoText node FirstFirst
11 Nó de textoText node SegundoSecond

Esse resultado é idêntico ao caso anterior, portanto, não existem problemas negativos.This outcome is identical to the prior case, so no negative issues exist. someFlagestá false no segundo processamento e a saída é:someFlag is false on the second rendering, and the output is:

SequênciaSequence TipoType DadosData
00 Nó de textoText node SegundoSecond

Desta vez, o algoritmo diff vê que duas alterações ocorreram e o algoritmo gera o seguinte script de edição:This time, the diff algorithm sees that two changes have occurred, and the algorithm generates the following edit script:

  • Altere o valor do primeiro nó de texto para Second.Change the value of the first text node to Second.
  • Remova o segundo nó de texto.Remove the second text node.

A geração de números de sequência perdeu todas as informações úteis sobre onde if/else os branches e loops estavam presentes no código original.Generating the sequence numbers has lost all the useful information about where the if/else branches and loops were present in the original code. Isso resulta em uma comparação duas vezes mais longa do que antes.This results in a diff twice as long as before.

Esse é um exemplo trivial.This is a trivial example. Em casos mais realistas com estruturas complexas e profundamente aninhadas, e especialmente com loops, o custo de desempenho é mais grave.In more realistic cases with complex and deeply nested structures, and especially with loops, the performance cost is more severe. Em vez de identificar imediatamente quais blocos de loop ou ramificações foram inseridos ou removidos, o algoritmo diff precisa recorrer profundamente nas árvores de renderização e geralmente criar scripts de edição muito mais, pois ele é informado indiretamente sobre como as estruturas antigas e novas relacionar entre si.Instead of immediately identifying which loop blocks or branches have been inserted or removed, the diff algorithm has to recurse deeply into the render trees and usually build far longer edit scripts because it is misinformed about how the old and new structures relate to each other.

Diretrizes e conclusõesGuidance and conclusions

  • O desempenho do aplicativo será afetado se os números de sequência forem gerados dinamicamente.App performance suffers if sequence numbers are generated dynamically.
  • A estrutura não pode criar seus próprios números de sequência automaticamente em tempo de execução porque as informações necessárias não existem, a menos que sejam capturadas no momento da compilação.The framework can't create its own sequence numbers automatically at runtime because the necessary information doesn't exist unless it's captured at compile time.
  • Não grave blocos longos de lógica implementada RenderTreeBuilder manualmente.Don't write long blocks of manually-implemented RenderTreeBuilder logic. Prefira .razor arquivos e permita que o compilador lide com os números de sequência.Prefer .razor files and allow the compiler to deal with the sequence numbers.
  • Se os números de sequência forem codificados, o algoritmo diff só exigirá que os números de sequência aumentem de valor.If sequence numbers are hardcoded, the diff algorithm only requires that sequence numbers increase in value. O valor inicial e as lacunas são irrelevantes.The initial value and gaps are irrelevant. Uma opção legítima é usar o número de linha de código como o número de sequência, ou começar de zero e aumentar por um ou centenas (ou qualquer intervalo preferencial).One legitimate option is to use the code line number as the sequence number, or start from zero and increase by ones or hundreds (or any preferred interval).
  • O mais alto número de seqüências usa números de sequência, enquanto outras estruturas de interface do usuário de diferenciação de árvore não as usam.Blazor uses sequence numbers, while other tree-diffing UI frameworks don't use them. A comparação é muito mais rápida quando os números de sequência são usados, e o mais vantajoso tem a vantagem de uma etapa de compilação que lida com números de .razor sequência automaticamente para desenvolvedores que criam arquivos.Diffing is far faster when sequence numbers are used, and Blazor has the advantage of a compile step that deals with sequence numbers automatically for developers authoring .razor files.

LocalizaçãoLocalization

Os aplicativos mais no lado do servidor são localizados usando o middleware de localização.Blazor server-side apps are localized using Localization Middleware. O middleware seleciona a cultura apropriada para os usuários que solicitam recursos do aplicativo.The middleware selects the appropriate culture for users requesting resources from the app.

A cultura pode ser definida usando uma das seguintes abordagens:The culture can be set using one of the following approaches:

Para obter mais informações e exemplos, consulte Globalização e localização no ASP.NET Core.For more information and examples, see Globalização e localização no ASP.NET Core.

CookiesCookies

Um cookie de cultura de localização pode persistir a cultura do usuário.A localization culture cookie can persist the user's culture. O cookie é criado pelo OnGet método da página host do aplicativo (pages/host. cshtml. cs).The cookie is created by the OnGet method of the app's host page (Pages/Host.cshtml.cs). O middleware de localização lê o cookie em solicitações subsequentes para definir a cultura do usuário.The Localization Middleware reads the cookie on subsequent requests to set the user's culture.

O uso de um cookie garante que a conexão WebSocket possa propagar corretamente a cultura.Use of a cookie ensures that the WebSocket connection can correctly propagate the culture. Se os esquemas de localização forem baseados no caminho da URL ou na cadeia de caracteres de consulta, o esquema pode não ser capaz de trabalhar com WebSockets, portanto, falha ao persistir a cultura.If localization schemes are based on the URL path or query string, the scheme might not be able to work with WebSockets, thus fail to persist the culture. Portanto, o uso de um cookie de cultura de localização é a abordagem recomendada.Therefore, use of a localization culture cookie is the recommended approach.

Qualquer técnica pode ser usada para atribuir uma cultura se a cultura persistir em um cookie de localização.Any technique can be used to assign a culture if the culture is persisted in a localization cookie. Se o aplicativo já tiver um esquema de localização estabelecido para ASP.NET Core do lado do servidor, continue a usar a infraestrutura de localização existente do aplicativo e defina o cookie de cultura de localização no esquema do aplicativo.If the app already has an established localization scheme for server-side ASP.NET Core, continue to use the app's existing localization infrastructure and set the localization culture cookie within the app's scheme.

O exemplo a seguir mostra como definir a cultura atual em um cookie que pode ser lido pelo middleware de localização.The following example shows how to set the current culture in a cookie that can be read by the Localization Middleware. Crie um arquivo pages/host. cshtml. cs com o seguinte conteúdo no aplicativo mais novo do servidor:Create a Pages/Host.cshtml.cs file with the following contents in the Blazor server-side app:

public class HostModel : PageModel
{
    public void OnGet()
    {
        HttpContext.Response.Cookies.Append(
            CookieRequestCultureProvider.DefaultCookieName,
            CookieRequestCultureProvider.MakeCookieValue(
                new RequestCulture(
                    CultureInfo.CurrentCulture,
                    CultureInfo.CurrentUICulture)));
    }
}

A localização é manipulada no aplicativo:Localization is handled in the app:

  1. O navegador envia uma solicitação HTTP inicial para o aplicativo.The browser sends an initial HTTP request to the app.
  2. A cultura é atribuída pelo middleware de localização.The culture is assigned by the Localization Middleware.
  3. O OnGet método em _Host. cshtml. cs persiste a cultura em um cookie como parte da resposta.The OnGet method in _Host.cshtml.cs persists the culture in a cookie as part of the response.
  4. O navegador abre uma conexão WebSocket para criar uma sessão do lado do servidor mais incrivelmente interativa.The browser opens a WebSocket connection to create an interactive Blazor server-side session.
  5. O middleware de localização lê o cookie e atribui a cultura.The Localization Middleware reads the cookie and assigns the culture.
  6. A sessão mais incrivelmente no lado do servidor começa com a cultura correta.The Blazor server-side session begins with the correct culture.

Fornecer interface do usuário para escolher a culturaProvide UI to choose the culture

Para fornecer à interface do usuário a fim de permitir a seleção de uma cultura, é recomendável uma abordagem baseada em redirecionamento.To provide UI to allow a user to select a culture, a redirect-based approach is recommended. O processo é semelhante ao que acontece em um aplicativo Web quando um usuário tenta acessar um recurso—seguro que o usuário é redirecionado para uma página de entrada e, em seguida, Redirecionado de volta para o recurso original.The process is similar to what happens in a web app when a user attempts to access a secure resource—the user is redirected to a sign-in page and then redirected back to the original resource.

O aplicativo persiste a cultura selecionada do usuário por meio de um redirecionamento para um controlador.The app persists the user's selected culture via a redirect to a controller. O controlador define a cultura selecionada do usuário em um cookie e redireciona o usuário de volta para o URI original.The controller sets the user's selected culture into a cookie and redirects the user back to the original URI.

Estabeleça um ponto de extremidade HTTP no servidor para definir a cultura selecionada do usuário em um cookie e execute o redirecionamento de volta para o URI original:Establish an HTTP endpoint on the server to set the user's selected culture in a cookie and perform the redirect back to the original URI:

[Route("[controller]/[action]")]
public class CultureController : Controller
{
    public IActionResult SetCulture(string culture, string redirectUri)
    {
        if (culture != null)
        {
            HttpContext.Response.Cookies.Append(
                CookieRequestCultureProvider.DefaultCookieName,
                CookieRequestCultureProvider.MakeCookieValue(
                    new RequestCulture(culture)));
        }

        return LocalRedirect(redirectUri);
    }
}

Aviso

Use o LocalRedirect resultado da ação para evitar ataques de redirecionamento abertos.Use the LocalRedirect action result to prevent open redirect attacks. Para obter mais informações, consulte Impedir ataques de redirecionamento aberto no ASP.NET Core.For more information, see Impedir ataques de redirecionamento aberto no ASP.NET Core.

O componente a seguir mostra um exemplo de como executar o redirecionamento inicial quando o usuário seleciona uma cultura:The following component shows an example of how to perform the initial redirection when the user selects a culture:

@inject IUriHelper UriHelper

<h3>Select your language</h3>

<select @onchange="OnSelected">
    <option>Select...</option>
    <option value="en-US">English</option>
    <option value="fr-FR">Français</option>
</select>

@code {
    private double textNumber;

    private void OnSelected(UIChangeEventArgs e)
    {
        var culture = (string)e.Value;
        var uri = new Uri(UriHelper.GetAbsoluteUri())
            .GetComponents(UriComponents.PathAndQuery, UriFormat.Unescaped);
        var query = $"?culture={Uri.EscapeDataString(culture)}&" +
            $"redirectUri={Uri.EscapeDataString(uri)}";

        UriHelper.NavigateTo("/Culture/SetCulture" + query, forceLoad: true);
    }
}

Usar cenários de localização do .NET em aplicativos mais IncrivelmenteosUse .NET localization scenarios in Blazor apps

Nos aplicativos mais poseriais, os seguintes cenários de localização e globalização do .NET estão disponíveis:Inside Blazor apps, the following .NET localization and globalization scenarios are available:

  • . Sistema de recursos da rede.NET's resources system
  • Formatação de número e data específicos da culturaCulture-specific number and date formatting

A funcionalidade de @bind mais de uma das mais recentes realiza a globalização com base na cultura atual do usuário.Blazor's @bind functionality performs globalization based on the user's current culture. Para obter mais informações, consulte a seção ligação de dados .For more information, see the Data binding section.

No momento, há suporte para um conjunto limitado de cenários de localização de ASP.NET Core:A limited set of ASP.NET Core's localization scenarios are currently supported:

  • IStringLocalizer<>tem suporte em aplicativos mais incrivelmenteos.IStringLocalizer<> is supported in Blazor apps.
  • IHtmlLocalizer<>, IViewLocalizer<>, e a localização de anotações de dados são ASP.NET Core cenários MVC e não têm suporte em aplicativos mais incrivelmenteos.IHtmlLocalizer<>, IViewLocalizer<>, and Data Annotations localization are ASP.NET Core MVC scenarios and not supported in Blazor apps.

Para obter mais informações, consulte Globalização e localização no ASP.NET Core.For more information, see Globalização e localização no ASP.NET Core.