title	author	description	monikerRange	ms.author	ms.custom	ms.date	uid
ASP.NET Core Razor component lifecycle	guardrex	Learn about the ASP.NET Core Razor component lifecycle and how to use lifecycle events.	>= aspnetcore-3.1	riande	mvc	02/22/2024	blazor/components/lifecycle

ASP.NET Core Razor component lifecycle

[!INCLUDE]

This article explains the ASP.NET Core Razor component lifecycle and how to use lifecycle events.

Lifecycle events

The Razor component processes Razor component lifecycle events in a set of synchronous and asynchronous lifecycle methods. The lifecycle methods can be overridden to perform additional operations in components during component initialization and rendering.

This article simplifies component lifecycle event processing in order to clarify complex framework logic and doesn't cover every change that was made over the years. You may need to access the ComponentBase reference source to integrate custom event processing with Blazor's lifecycle event processing. Code comments in the reference source include additional remarks on lifecycle event processing that don't appear in this article or in the API documentation.

[!INCLUDE]

The following simplified diagrams illustrate Razor component lifecycle event processing. The C# methods associated with the lifecycle events are defined with examples in the following sections of this article.

Component lifecycle events:

If the component is rendering for the first time on a request:
- Create the component's instance.
- Perform property injection.
- Call OnInitialized{Async}. If an incomplete xref:System.Threading.Tasks.Task is returned, the xref:System.Threading.Tasks.Task is awaited and then the component is rerendered. The synchronous method is called prior to the asynchronous method.
Call OnParametersSet{Async}. If an incomplete xref:System.Threading.Tasks.Task is returned, the xref:System.Threading.Tasks.Task is awaited and then the component is rerendered. The synchronous method is called prior to the asynchronous method.
Render for all synchronous work and complete xref:System.Threading.Tasks.Tasks.

Note

Asynchronous actions performed in lifecycle events might not complete before a component is rendered. For more information, see the Handle incomplete async actions at render section later in this article.

A parent component renders before its children components because rendering is what determines which children are present. If synchronous parent component initialization is used, the parent initialization is guaranteed to complete first. If asynchronous parent component initialization is used, the completion order of parent and child component initialization can't be determined because it depends on the initialization code running.

DOM event processing:

The event handler is run.
If an incomplete xref:System.Threading.Tasks.Task is returned, the xref:System.Threading.Tasks.Task is awaited and then the component is rerendered.
Render for all synchronous work and complete xref:System.Threading.Tasks.Tasks.

The Render lifecycle:

Avoid further rendering operations on the component when both of the following conditions are met:
- It is not the first render.
- ShouldRender returns false.
Build the render tree diff (difference) and render the component.
Await the DOM to update.
Call OnAfterRender{Async}. The synchronous method is called prior to the asynchronous method.

Developer calls to StateHasChanged result in a rerender. For more information, see xref:blazor/components/rendering#statehaschanged.

When parameters are set (`SetParametersAsync`)

xref:Microsoft.AspNetCore.Components.ComponentBase.SetParametersAsync%2A sets parameters supplied by the component's parent in the render tree or from route parameters.

The method's xref:Microsoft.AspNetCore.Components.ParameterView parameter contains the set of component parameter values for the component each time xref:Microsoft.AspNetCore.Components.ComponentBase.SetParametersAsync%2A is called. By overriding the xref:Microsoft.AspNetCore.Components.ComponentBase.SetParametersAsync%2A method, developer code can interact directly with xref:Microsoft.AspNetCore.Components.ParameterView's parameters.

The default implementation of xref:Microsoft.AspNetCore.Components.ComponentBase.SetParametersAsync%2A sets the value of each property with the [Parameter] or [CascadingParameter] attribute that has a corresponding value in the xref:Microsoft.AspNetCore.Components.ParameterView. Parameters that don't have a corresponding value in xref:Microsoft.AspNetCore.Components.ParameterView are left unchanged.

Generally, your code should call the base class method (await base.SetParametersAsync(parameters);) when overriding xref:Microsoft.AspNetCore.Components.ComponentBase.SetParametersAsync%2A. In advanced scenarios, developer code can interpret the incoming parameters' values in any way required by not invoking the base class method. For example, there's no requirement to assign the incoming parameters to the properties of the class. However, you must refer to the ComponentBase reference source when structuring your code without calling the base class method because it calls other lifecycle methods and triggers rendering in a complex fashion.

[!INCLUDE]

If you want to rely on the initialization and rendering logic of xref:Microsoft.AspNetCore.Components.ComponentBase.SetParametersAsync%2A?displayProperty=nameWithType but not process incoming parameters, you have the option of passing an empty xref:Microsoft.AspNetCore.Components.ParameterView to the base class method:

await base.SetParametersAsync(ParameterView.Empty);

If event handlers are provided in developer code, unhook them on disposal. For more information, see the Component disposal with IDisposable and IAsyncDisposable section.

In the following example, xref:Microsoft.AspNetCore.Components.ParameterView.TryGetValue%2A?displayProperty=nameWithType assigns the Param parameter's value to value if parsing a route parameter for Param is successful. When value isn't null, the value is displayed by the component.

Although route parameter matching is case insensitive, xref:Microsoft.AspNetCore.Components.ParameterView.TryGetValue%2A only matches case-sensitive parameter names in the route template. The following example requires the use of /{Param?} in the route template in order to get the value with xref:Microsoft.AspNetCore.Components.ParameterView.TryGetValue%2A, not /{param?}. If /{param?} is used in this scenario, xref:Microsoft.AspNetCore.Components.ParameterView.TryGetValue%2A returns false and message isn't set to either message string.

SetParamsAsync.razor:

:::moniker range=">= aspnetcore-9.0"

:::code language="razor" source="~/../blazor-samples/9.0/BlazorSample_BlazorWebApp/Components/Pages/SetParamsAsync.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-8.0 < aspnetcore-9.0"

:::code language="razor" source="~/../blazor-samples/8.0/BlazorSample_BlazorWebApp/Components/Pages/SetParamsAsync.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/lifecycle/SetParamsAsync.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/lifecycle/SetParamsAsync.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/lifecycle/SetParamsAsync.razor":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/lifecycle/SetParamsAsync.razor":::

:::moniker-end

Component initialization (`OnInitialized{Async}`)

xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitialized%2A and xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitializedAsync%2A are used exclusively to initialize a component for the entire lifetime of the component instance. Parameter values and parameter value changes shouldn't affect the initialization performed in these methods. For example, loading static options into a dropdown list that doesn't change for the lifetime of the component and that isn't dependent on parameter values is performed in one of these lifecycle methods. If parameter values or changes in parameter values affect component state, use OnParametersSet{Async} instead.

These methods are invoked when the component is initialized after having received its initial parameters in xref:Microsoft.AspNetCore.Components.ComponentBase.SetParametersAsync%2A. The synchronous method is called prior to the asynchronous method.

If synchronous parent component initialization is used, the parent initialization is guaranteed to complete before child component initialization. If asynchronous parent component initialization is used, the completion order of parent and child component initialization can't be determined because it depends on the initialization code running.

For a synchronous operation, override xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitialized%2A:

OnInit.razor:

:::moniker range=">= aspnetcore-9.0"

:::code language="razor" source="~/../blazor-samples/9.0/BlazorSample_BlazorWebApp/Components/Pages/OnInit.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-8.0 < aspnetcore-9.0"

:::code language="razor" source="~/../blazor-samples/8.0/BlazorSample_BlazorWebApp/Components/Pages/OnInit.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/lifecycle/OnInit.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/lifecycle/OnInit.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/lifecycle/OnInit.razor":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/lifecycle/OnInit.razor":::

:::moniker-end

To perform an asynchronous operation, override xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitializedAsync%2A and use the await operator:

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

If a custom base class is used with custom initialization logic, call xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitializedAsync%2A on the base class:

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

    await base.OnInitializedAsync();
}

It isn't necessary to call xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitializedAsync%2A?displayProperty=nameWithType unless a custom base class is used with custom logic. For more information, see the Base class lifecycle methods section.

Blazor apps that prerender their content on the server call xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitializedAsync%2A twice:

Once when the component is initially rendered statically as part of the page.
A second time when the browser renders the component.

:::moniker range=">= aspnetcore-8.0"

To prevent developer code in xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitializedAsync%2A from running twice when prerendering, see the Stateful reconnection after prerendering section. The content in the section focuses on Blazor Web Apps and stateful SignalR reconnection. To preserve state during the execution of initialization code while prerendering, see xref:blazor/components/prerender#persist-prerendered-state.

:::moniker-end

:::moniker range="< aspnetcore-8.0"

To prevent developer code in xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitializedAsync%2A from running twice when prerendering, see the Stateful reconnection after prerendering section. Although the content in the section focuses on Blazor Server and stateful SignalR reconnection, the scenario for prerendering in hosted Blazor WebAssembly solutions (xref:Microsoft.AspNetCore.Mvc.Rendering.RenderMode.WebAssemblyPrerendered) involves similar conditions and approaches to prevent executing developer code twice. To preserve state during the execution of initialization code while prerendering, see xref:blazor/components/integration#persist-prerendered-state.

:::moniker-end

While a Blazor app is prerendering, certain actions, such as calling into JavaScript (JS interop), aren't possible. Components may need to render differently when prerendered. For more information, see the Prerendering with JavaScript interop section.

If event handlers are provided in developer code, unhook them on disposal. For more information, see the Component disposal with IDisposable IAsyncDisposable section.

::: moniker range=">= aspnetcore-8.0"

Use streaming rendering with static server-side rendering (static SSR) or prerendering to improve the user experience for components that perform long-running asynchronous tasks in xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitializedAsync%2A to fully render. For more information, see xref:blazor/components/rendering#streaming-rendering.

:::moniker-end

After parameters are set (`OnParametersSet{Async}`)

xref:Microsoft.AspNetCore.Components.ComponentBase.OnParametersSet%2A or xref:Microsoft.AspNetCore.Components.ComponentBase.OnParametersSetAsync%2A are called:

After the component is initialized in xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitialized%2A or xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitializedAsync%2A.
When the parent component rerenders and supplies:
- Known or primitive immutable types when at least one parameter has changed.
- Complex-typed parameters. The framework can't know whether the values of a complex-typed parameter have mutated internally, so the framework always treats the parameter set as changed when one or more complex-typed parameters are present.
For more information on rendering conventions, see xref:blazor/components/rendering#rendering-conventions-for-componentbase.

The synchronous method is called prior to the asynchronous method.

The methods can be invoked even if the parameter values haven't changed. This behavior underscores the need for developers to implement additional logic within the methods to check whether parameter values have indeed changed before re-initializing data or state dependent on those parameters.

For the following example component, navigate to the component's page at a URL:

With a start date that's received by StartDate: /on-parameters-set/2021-03-19
Without a start date, where StartDate is assigned a value of the current local time: /on-parameters-set

:::moniker range=">= aspnetcore-5.0"

Note

In a component route, it isn't possible to both constrain a xref:System.DateTime parameter with the route constraint datetime and make the parameter optional. Therefore, the following OnParamsSet component uses two @page directives to handle routing with and without a supplied date segment in the URL.

:::moniker-end

OnParamsSet.razor:

:::moniker range=">= aspnetcore-9.0"

:::code language="razor" source="~/../blazor-samples/9.0/BlazorSample_BlazorWebApp/Components/Pages/OnParamsSet.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-8.0 < aspnetcore-9.0"

:::code language="razor" source="~/../blazor-samples/8.0/BlazorSample_BlazorWebApp/Components/Pages/OnParamsSet.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/lifecycle/OnParamsSet.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/lifecycle/OnParamsSet.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/lifecycle/OnParamsSet.razor":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/lifecycle/OnParamsSet.razor":::

:::moniker-end

Asynchronous work when applying parameters and property values must occur during the xref:Microsoft.AspNetCore.Components.ComponentBase.OnParametersSetAsync%2A lifecycle event:

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

If a custom base class is used with custom initialization logic, call xref:Microsoft.AspNetCore.Components.ComponentBase.OnParametersSetAsync%2A on the base class:

protected override async Task OnParametersSetAsync()
{
    await ...

    await base.OnParametersSetAsync();
}

It isn't necessary to call xref:Microsoft.AspNetCore.Components.ComponentBase.OnParametersSetAsync%2A?displayProperty=nameWithType unless a custom base class is used with custom logic. For more information, see the Base class lifecycle methods section.

If event handlers are provided in developer code, unhook them on disposal. For more information, see the Component disposal with IDisposable IAsyncDisposable section.

For more information on route parameters and constraints, see xref:blazor/fundamentals/routing.

For an example of implementing SetParametersAsync manually to improve performance in some scenarios, see xref:blazor/performance#implement-setparametersasync-manually.

After component render (`OnAfterRender{Async}`)

:::moniker range=">= aspnetcore-8.0"

xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRender%2A and xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync%2A are invoked after a component has rendered interactively and the UI has finished updating (for example, after elements are added to the browser DOM). Element and component references are populated at this point. Use this stage to perform additional initialization steps with the rendered content, such as JS interop calls that interact with the rendered DOM elements. The synchronous method is called prior to the asynchronous method.

These methods aren't invoked during prerendering or static server-side rendering (static SSR) on the server because those processes aren't attached to a live browser DOM and are already complete before the DOM is updated.

For xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync%2A, the component doesn't automatically rerender after the completion of any returned Task to avoid an infinite render loop.

:::moniker-end

:::moniker range="< aspnetcore-8.0"

xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRender%2A and xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync%2A are called after a component has finished rendering. Element and component references are populated at this point. Use this stage to perform additional initialization steps with the rendered content, such as JS interop calls that interact with the rendered DOM elements. The synchronous method is called prior to the asynchronous method.

These methods aren't invoked during prerendering because prerendering isn't attached to a live browser DOM and is already complete before the DOM is updated.

For xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync%2A, the component doesn't automatically rerender after the completion of any returned Task to avoid an infinite render loop.

:::moniker-end

The firstRender parameter for xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRender%2A and xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync%2A:

Is set to true the first time that the component instance is rendered.
Can be used to ensure that initialization work is only performed once.

AfterRender.razor:

:::moniker range=">= aspnetcore-9.0"

:::code language="razor" source="~/../blazor-samples/9.0/BlazorSample_BlazorWebApp/Components/Pages/AfterRender.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-8.0 < aspnetcore-9.0"

:::code language="razor" source="~/../blazor-samples/8.0/BlazorSample_BlazorWebApp/Components/Pages/AfterRender.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/lifecycle/AfterRender.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/lifecycle/AfterRender.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/lifecycle/AfterRender.razor":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/lifecycle/AfterRender.razor":::

:::moniker-end

The AfterRender.razor sample produces following output to console when the page is loaded and the button is selected:

:::no-loc text="OnAfterRender: firstRender = True":::
:::no-loc text="HandleClick called":::
:::no-loc text="OnAfterRender: firstRender = False":::

Asynchronous work immediately after rendering must occur during the xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync%2A lifecycle event:

protected override async Task OnAfterRenderAsync(bool firstRender)
{
    ...
}

If a custom base class is used with custom initialization logic, call xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync%2A on the base class:

protected override async Task OnAfterRenderAsync(bool firstRender)
{
    ...

    await base.OnAfterRenderAsync(firstRender);
}

It isn't necessary to call xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync%2A?displayProperty=nameWithType unless a custom base class is used with custom logic. For more information, see the Base class lifecycle methods section.

Even if you return a xref:System.Threading.Tasks.Task from xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync%2A, the framework doesn't schedule a further render cycle for your component once that task completes. This is to avoid an infinite render loop. This is different from the other lifecycle methods, which schedule a further render cycle once a returned xref:System.Threading.Tasks.Task completes.

xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRender%2A and xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync%2A aren't called during the prerendering process on the server. The methods are called when the component is rendered interactively after prerendering. When the app prerenders:

The component executes on the server to produce some static HTML markup in the HTTP response. During this phase, xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRender%2A and xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync%2A aren't called.
When the Blazor script (blazor.{server|webassembly|web}.js) starts in the browser, the component is restarted in an interactive rendering mode. After a component is restarted, xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRender%2A and xref:Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync%2A are called because the app isn't in the prerendering phase any longer.

If event handlers are provided in developer code, unhook them on disposal. For more information, see the Component disposal with IDisposable IAsyncDisposable section.

Base class lifecycle methods

When overriding Blazor's lifecycle methods, it isn't necessary to call base class lifecycle methods for xref:Microsoft.AspNetCore.Components.ComponentBase. However, a component should call an overridden base class lifecycle method in the following situations:

When overriding xref:Microsoft.AspNetCore.Components.ComponentBase.SetParametersAsync%2A?displayProperty=nameWithType, await base.SetParametersAsync(parameters); is usually invoked because the base class method calls other lifecycle methods and triggers rendering in a complex fashion. For more information, see the When parameters are set (SetParametersAsync) section.
If the base class method contains logic that must be executed. Library consumers usually call base class lifecycle methods when inheriting a base class because library base classes often have custom lifecycle logic to execute. If the app uses a base class from a library, consult the library's documentation for guidance.

In the following example, base.OnInitialized(); is called to ensure that the base class's OnInitialized method is executed. Without the call, BlazorRocksBase2.OnInitialized doesn't execute.

BlazorRocks2.razor:

:::moniker range=">= aspnetcore-9.0"

:::code language="razor" source="~/../blazor-samples/9.0/BlazorSample_BlazorWebApp/Components/Pages/BlazorRocks2.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-8.0 < aspnetcore-9.0"

:::code language="razor" source="~/../blazor-samples/8.0/BlazorSample_BlazorWebApp/Components/Pages/BlazorRocks2.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/index/BlazorRocks2.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/index/BlazorRocks2.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/index/BlazorRocks2.razor":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/index/BlazorRocks2.razor":::

:::moniker-end

BlazorRocksBase2.cs:

:::moniker range=">= aspnetcore-9.0"

:::code language="csharp" source="~/../blazor-samples/9.0/BlazorSample_BlazorWebApp/BlazorRocksBase2.cs":::

:::moniker-end

:::moniker range=">= aspnetcore-8.0 < aspnetcore-9.0"

:::code language="csharp" source="~/../blazor-samples/8.0/BlazorSample_BlazorWebApp/BlazorRocksBase2.cs":::

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="csharp" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/BlazorRocksBase2.cs":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="csharp" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/BlazorRocksBase2.cs":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="csharp" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/BlazorRocksBase2.cs":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="csharp" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/BlazorRocksBase2.cs":::

:::moniker-end

State changes (`StateHasChanged`)

xref:Microsoft.AspNetCore.Components.ComponentBase.StateHasChanged%2A notifies the component that its state has changed. When applicable, calling xref:Microsoft.AspNetCore.Components.ComponentBase.StateHasChanged%2A enqueues a rerender that occurs when the app's main thread is free.

xref:Microsoft.AspNetCore.Components.ComponentBase.StateHasChanged%2A is called automatically for xref:Microsoft.AspNetCore.Components.EventCallback methods. For more information on event callbacks, see xref:blazor/components/event-handling#eventcallback.

For more information on component rendering and when to call xref:Microsoft.AspNetCore.Components.ComponentBase.StateHasChanged%2A, including when to invoke it with xref:Microsoft.AspNetCore.Components.ComponentBase.InvokeAsync%2A?displayProperty=nameWithType, see xref:blazor/components/rendering.

Handle incomplete async actions at render

Asynchronous actions performed in lifecycle events might not have completed before the component is rendered. Objects might be null or incompletely populated with data while the lifecycle method is executing. Provide rendering logic to confirm that objects are initialized. Render placeholder UI elements (for example, a loading message) while objects are null.

In the following component, xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitializedAsync%2A is overridden to asynchronously provide movie rating data (movies). When movies is null, a loading message is displayed to the user. After the Task returned by xref:Microsoft.AspNetCore.Components.ComponentBase.OnInitializedAsync%2A completes, the component is rerendered with the updated state.

<h1>Sci-Fi Movie Ratings</h1>

@if (movies == null)
{
    <p><em>Loading...</em></p>
}
else
{
    <ul>
        @foreach (var movie in movies)
        {
            <li>@movie.Title &mdash; @movie.Rating</li>
        }
    </ul>
}

@code {
    private Movies[]? movies;

    protected override async Task OnInitializedAsync()
    {
        movies = await GetMovieRatings(DateTime.Now);
    }
}

Handle errors

For information on handling errors during lifecycle method execution, see xref:blazor/fundamentals/handle-errors.

Stateful reconnection after prerendering

When prerendering on the server, a component is initially rendered statically as part of the page. Once the browser establishes a SignalR connection back to the server, the component is rendered again and interactive. If the OnInitialized{Async} lifecycle method for initializing the component is present, the method is executed twice:

When the component is prerendered statically.
After the server connection has been established.

This can result in a noticeable change in the data displayed in the UI when the component is finally rendered. To avoid this behavior, pass in an identifier to cache the state during prerendering and to retrieve the state after prerendering.

The following code demonstrates a WeatherForecastService that avoids the change in data display due to prerendering. The awaited xref:System.Threading.Tasks.Task.Delay%2A (await Task.Delay(...)) simulates a short delay before returning data from the GetForecastAsync method.

Add xref:Microsoft.Extensions.Caching.Memory.IMemoryCache services with xref:Microsoft.Extensions.DependencyInjection.MemoryCacheServiceCollectionExtensions.AddMemoryCache%2A on the service collection in the app's Program file:

builder.Services.AddMemoryCache();

WeatherForecastService.cs:

:::moniker range=">= aspnetcore-9.0"

:::code language="csharp" source="~/../blazor-samples/9.0/BlazorSample_BlazorWebApp/WeatherForecastService.cs":::

:::moniker-end

:::moniker range=">= aspnetcore-8.0 < aspnetcore-9.0"

:::code language="csharp" source="~/../blazor-samples/8.0/BlazorSample_BlazorWebApp/WeatherForecastService.cs":::

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="csharp" source="~/../blazor-samples/7.0/BlazorSample_Server/lifecycle/WeatherForecastService.cs":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="csharp" source="~/../blazor-samples/6.0/BlazorSample_Server/lifecycle/WeatherForecastService.cs":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="csharp" source="~/../blazor-samples/5.0/BlazorSample_Server/lifecycle/WeatherForecastService.cs":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="csharp" source="~/../blazor-samples/3.1/BlazorSample_Server/lifecycle/WeatherForecastService.cs":::

:::moniker-end

For more information on the xref:Microsoft.AspNetCore.Mvc.TagHelpers.ComponentTagHelper.RenderMode, see xref:blazor/fundamentals/signalr#server-side-render-mode.

:::moniker range=">= aspnetcore-8.0"

The content in this section focuses on Blazor Web Apps and stateful SignalR reconnection. To preserve state during the execution of initialization code while prerendering, see xref:blazor/components/prerender#persist-prerendered-state.

:::moniker-end

:::moniker range="< aspnetcore-8.0"

Although the content in this section focuses on Blazor Server and stateful SignalR reconnection, the scenario for prerendering in hosted Blazor WebAssembly solutions (xref:Microsoft.AspNetCore.Mvc.Rendering.RenderMode.WebAssemblyPrerendered) involves similar conditions and approaches to prevent executing developer code twice. To preserve state during the execution of initialization code while prerendering, see xref:blazor/components/integration#persist-prerendered-state.

:::moniker-end

Prerendering with JavaScript interop

[!INCLUDE]

Component disposal with `IDisposable` and `IAsyncDisposable`

If a component implements xref:System.IDisposable or xref:System.IAsyncDisposable, the framework calls for resource disposal when the component is removed from the UI. Don't rely on the exact timing of when these methods are executed. For example, xref:System.IAsyncDisposable can be triggered before or after an asynchronous xref:System.Threading.Tasks.Task awaited in OnInitalizedAsync is called or completes. Also, object disposal code shouldn't assume that objects created during initialization or other lifecycle methods exist.

Components shouldn't need to implement xref:System.IDisposable and xref:System.IAsyncDisposable simultaneously. If both are implemented, the framework only executes the asynchronous overload.

Developer code must ensure that xref:System.IAsyncDisposable implementations don't take a long time to complete.

Disposal of JavaScript interop object references

Examples throughout the JavaScript (JS) interop articles demonstrate typical object disposal patterns:

When calling JS from .NET, as described in xref:blazor/js-interop/call-javascript-from-dotnet, dispose any created xref:Microsoft.JSInterop.IJSObjectReference/xref:Microsoft.JSInterop.IJSInProcessObjectReference/xref:Microsoft.JSInterop.Implementation.JSObjectReference either from .NET or from JS to avoid leaking JS memory.
When calling .NET from JS, as described in xref:blazor/js-interop/call-dotnet-from-javascript, dispose of a created xref:Microsoft.JSInterop.DotNetObjectReference either from .NET or from JS to avoid leaking .NET memory.

JS interop object references are implemented as a map keyed by an identifier on the side of the JS interop call that creates the reference. When object disposal is initiated from either the .NET or JS side, Blazor removes the entry from the map, and the object can be garbage collected as long as no other strong reference to the object is present.

At a minimum, always dispose objects created on the .NET side to avoid leaking .NET managed memory.

DOM cleanup tasks during component disposal

For more information, see xref:blazor/js-interop/index#dom-cleanup-tasks-during-component-disposal.

For guidance on xref:Microsoft.JSInterop.JSDisconnectedException when a circuit is disconnected, see xref:blazor/js-interop/index#javascript-interop-calls-without-a-circuit. For general JavaScript interop error handling guidance, see the JavaScript interop section in xref:blazor/fundamentals/handle-errors#javascript-interop.

Synchronous `IDisposable`

For synchronous disposal tasks, use xref:System.IDisposable.Dispose%2A?displayProperty=nameWithType.

The following component:

Implements xref:System.IDisposable with the @implements Razor directive.
Disposes of obj, which is a type that implements xref:System.IDisposable.
A null check is performed because obj is created in a lifecycle method (not shown).

@implements IDisposable

...

@code {
    ...

    public void Dispose()
    {
        obj?.Dispose();
    }
}

If a single object requires disposal, a lambda can be used to dispose of the object when xref:System.IDisposable.Dispose%2A is called. The following example appears in the xref:blazor/components/rendering#receiving-a-call-from-something-external-to-the-blazor-rendering-and-event-handling-system article and demonstrates the use of a lambda expression for the disposal of a xref:System.Timers.Timer.

:::moniker range=">= aspnetcore-9.0"

TimerDisposal1.razor:

:::code language="razor" source="~/../blazor-samples/9.0/BlazorSample_BlazorWebApp/Components/Pages/TimerDisposal1.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-8.0 < aspnetcore-9.0"

TimerDisposal1.razor:

:::code language="razor" source="~/../blazor-samples/8.0/BlazorSample_BlazorWebApp/Components/Pages/TimerDisposal1.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

CounterWithTimerDisposal1.razor:

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/lifecycle/CounterWithTimerDisposal1.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

CounterWithTimerDisposal1.razor:

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/lifecycle/CounterWithTimerDisposal1.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

CounterWithTimerDisposal1.razor:

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/lifecycle/CounterWithTimerDisposal1.razor":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

CounterWithTimerDisposal1.razor:

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/lifecycle/CounterWithTimerDisposal1.razor":::

:::moniker-end

Note

In the preceding example, the call to xref:Microsoft.AspNetCore.Components.ComponentBase.StateHasChanged%2A is wrapped by a call to xref:Microsoft.AspNetCore.Components.ComponentBase.InvokeAsync%2A?displayProperty=nameWithType because the callback is invoked outside of Blazor's synchronization context. For more information, see xref:blazor/components/rendering#receiving-a-call-from-something-external-to-the-blazor-rendering-and-event-handling-system.

If the object is created in a lifecycle method, such as OnInitialized{Async}, check for null before calling Dispose.

:::moniker range=">= aspnetcore-9.0"

TimerDisposal2.razor:

:::code language="razor" source="~/../blazor-samples/9.0/BlazorSample_BlazorWebApp/Components/Pages/TimerDisposal2.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-8.0 < aspnetcore-9.0"

TimerDisposal2.razor:

:::code language="razor" source="~/../blazor-samples/8.0/BlazorSample_BlazorWebApp/Components/Pages/TimerDisposal2.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

CounterWithTimerDisposal2.razor:

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/lifecycle/CounterWithTimerDisposal2.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

CounterWithTimerDisposal2.razor:

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/lifecycle/CounterWithTimerDisposal2.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

CounterWithTimerDisposal2.razor:

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/lifecycle/CounterWithTimerDisposal2.razor":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

CounterWithTimerDisposal2.razor:

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/lifecycle/CounterWithTimerDisposal2.razor":::

:::moniker-end

For more information, see:

Cleaning up unmanaged resources (.NET documentation)
Null-conditional operators ?. and ?[]

Asynchronous `IAsyncDisposable`

For asynchronous disposal tasks, use xref:System.IAsyncDisposable.DisposeAsync%2A?displayProperty=nameWithType.

The following component:

Implements xref:System.IAsyncDisposable with the @implements Razor directive.
Disposes of obj, which is an unmanaged type that implements xref:System.IAsyncDisposable.
A null check is performed because obj is created in a lifecycle method (not shown).

@implements IAsyncDisposable

...

@code {
    ...

    public async ValueTask DisposeAsync()
    {
        if (obj is not null)
        {
            await obj.DisposeAsync();
        }
    }
}

For more information, see:

Cleaning up unmanaged resources (.NET documentation)
Null-conditional operators ?. and ?[]

Assignment of `null` to disposed objects

Usually, there's no need to assign null to disposed objects after calling xref:System.IDisposable.Dispose%2A/xref:System.IAsyncDisposable.DisposeAsync%2A. Rare cases for assigning null include the following:

If the object's type is poorly implemented and doesn't tolerate repeat calls to xref:System.IDisposable.Dispose%2A/xref:System.IAsyncDisposable.DisposeAsync%2A, assign null after disposal to gracefully skip further calls to xref:System.IDisposable.Dispose%2A/xref:System.IAsyncDisposable.DisposeAsync%2A.
If a long-lived process continues to hold a reference to a disposed object, assigning null allows the garbage collector to free the object in spite of the long-lived process holding a reference to it.

These are unusual scenarios. For objects that are implemented correctly and behave normally, there's no point in assigning null to disposed objects. In the rare cases where an object must be assigned null, we recommend documenting the reason and seeking a solution that prevents the need to assign null.

`StateHasChanged`

Note

Calling xref:Microsoft.AspNetCore.Components.ComponentBase.StateHasChanged%2A in Dispose and DisposeAsync isn't supported. xref:Microsoft.AspNetCore.Components.ComponentBase.StateHasChanged%2A might be invoked as part of tearing down the renderer, so requesting UI updates at that point isn't supported.

Event handlers

Always unsubscribe event handlers from .NET events. The following Blazor form examples show how to unsubscribe an event handler in the Dispose method:

Private field and lambda approach

@implements IDisposable

<EditForm ... EditContext="editContext" ...>
    ...
    <button type="submit" disabled="@formInvalid">Submit</button>
</EditForm>

@code {
    ...

    private EventHandler<FieldChangedEventArgs>? fieldChanged;

    protected override void OnInitialized()
    {
        editContext = new(model);

        fieldChanged = (_, __) =>
        {
            ...
        };

        editContext.OnFieldChanged += fieldChanged;
    }

    public void Dispose()
    {
        editContext.OnFieldChanged -= fieldChanged;
    }
}

Private method approach

@implements IDisposable

<EditForm ... EditContext="editContext" ...>
    ...
    <button type="submit" disabled="@formInvalid">Submit</button>
</EditForm>

@code {
    ...

    protected override void OnInitialized()
    {
        editContext = new(model);
        editContext.OnFieldChanged += HandleFieldChanged;
    }

    private void HandleFieldChanged(object sender, FieldChangedEventArgs e)
    {
        ...
    }

    public void Dispose()
    {
        editContext.OnFieldChanged -= HandleFieldChanged;
    }
}

For more information, see the Component disposal with IDisposable and IAsyncDisposable section.

For more information on the xref:Microsoft.AspNetCore.Components.Forms.EditForm component and forms, see xref:blazor/forms/index and the other forms articles in the Forms node.

Anonymous functions, methods, and expressions

When anonymous functions, methods, or expressions, are used, it isn't necessary to implement xref:System.IDisposable and unsubscribe delegates. However, failing to unsubscribe a delegate is a problem when the object exposing the event outlives the lifetime of the component registering the delegate. When this occurs, a memory leak results because the registered delegate keeps the original object alive. Therefore, only use the following approaches when you know that the event delegate disposes quickly. When in doubt about the lifetime of objects that require disposal, subscribe a delegate method and properly dispose the delegate as the earlier examples show.

Anonymous lambda method approach (explicit disposal not required):

private void HandleFieldChanged(object sender, FieldChangedEventArgs e)
{
    formInvalid = !editContext.Validate();
    StateHasChanged();
}

protected override void OnInitialized()
{
    editContext = new(starship);
    editContext.OnFieldChanged += (s, e) => HandleFieldChanged((editContext)s, e);
}

Anonymous lambda expression approach (explicit disposal not required):

private ValidationMessageStore? messageStore;

[CascadingParameter]
private EditContext? CurrentEditContext { get; set; }

protected override void OnInitialized()
{
    ...

    messageStore = new(CurrentEditContext);

    CurrentEditContext.OnValidationRequested += (s, e) => messageStore.Clear();
    CurrentEditContext.OnFieldChanged += (s, e) => 
        messageStore.Clear(e.FieldIdentifier);
}

The full example of the preceding code with anonymous lambda expressions appears in the xref:blazor/forms/validation#validator-components article.

For more information, see Cleaning up unmanaged resources and the topics that follow it on implementing the Dispose and DisposeAsync methods.

Cancelable background work

Components often perform long-running background work, such as making network calls (xref:System.Net.Http.HttpClient) and interacting with databases. It's desirable to stop the background work to conserve system resources in several situations. For example, background asynchronous operations don't automatically stop when a user navigates away from a component.

Other reasons why background work items might require cancellation include:

An executing background task was started with faulty input data or processing parameters.
The current set of executing background work items must be replaced with a new set of work items.
The priority of currently executing tasks must be changed.
The app must be shut down for server redeployment.
Server resources become limited, necessitating the rescheduling of background work items.

To implement a cancelable background work pattern in a component:

Use a xref:System.Threading.CancellationTokenSource and xref:System.Threading.CancellationToken.
On disposal of the component and at any point cancellation is desired by manually canceling the token, call CancellationTokenSource.Cancel to signal that the background work should be cancelled.
After the asynchronous call returns, call xref:System.Threading.CancellationToken.ThrowIfCancellationRequested%2A on the token.

In the following example:

await Task.Delay(5000, cts.Token); represents long-running asynchronous background work.
BackgroundResourceMethod represents a long-running background method that shouldn't start if the Resource is disposed before the method is called.

BackgroundWork.razor:

:::moniker range=">= aspnetcore-9.0"

:::code language="razor" source="~/../blazor-samples/9.0/BlazorSample_BlazorWebApp/Components/Pages/BackgroundWork.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-8.0 < aspnetcore-9.0"

:::code language="razor" source="~/../blazor-samples/8.0/BlazorSample_BlazorWebApp/Components/Pages/BackgroundWork.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-7.0 < aspnetcore-8.0"

:::code language="razor" source="~/../blazor-samples/7.0/BlazorSample_WebAssembly/Pages/lifecycle/BackgroundWork.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-6.0 < aspnetcore-7.0"

:::code language="razor" source="~/../blazor-samples/6.0/BlazorSample_WebAssembly/Pages/lifecycle/BackgroundWork.razor":::

:::moniker-end

:::moniker range=">= aspnetcore-5.0 < aspnetcore-6.0"

:::code language="razor" source="~/../blazor-samples/5.0/BlazorSample_WebAssembly/Pages/lifecycle/BackgroundWork.razor":::

:::moniker-end

:::moniker range="< aspnetcore-5.0"

:::code language="razor" source="~/../blazor-samples/3.1/BlazorSample_WebAssembly/Pages/lifecycle/BackgroundWork.razor":::

:::moniker-end

Blazor Server reconnection events

The component lifecycle events covered in this article operate separately from server-side reconnection event handlers. When the SignalR connection to the client is lost, only UI updates are interrupted. UI updates are resumed when the connection is re-established. For more information on circuit handler events and configuration, see xref:blazor/fundamentals/signalr.

Additional resources

Handle caught exceptions outside of a Razor component's lifecycle

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lifecycle.md

lifecycle.md

ASP.NET Core Razor component lifecycle

Lifecycle events

When parameters are set (`SetParametersAsync`)

Component initialization (`OnInitialized{Async}`)

After parameters are set (`OnParametersSet{Async}`)

After component render (`OnAfterRender{Async}`)

Base class lifecycle methods

State changes (`StateHasChanged`)

Handle incomplete async actions at render

Handle errors

Stateful reconnection after prerendering

Prerendering with JavaScript interop

Component disposal with `IDisposable` and `IAsyncDisposable`

Disposal of JavaScript interop object references

DOM cleanup tasks during component disposal

Synchronous `IDisposable`

Asynchronous `IAsyncDisposable`

Assignment of `null` to disposed objects

`StateHasChanged`

Event handlers

Anonymous functions, methods, and expressions

Cancelable background work

Blazor Server reconnection events

Additional resources

Files

lifecycle.md

Latest commit

History

lifecycle.md

File metadata and controls

ASP.NET Core Razor component lifecycle

Lifecycle events

When parameters are set (SetParametersAsync)

Component initialization (OnInitialized{Async})

After parameters are set (OnParametersSet{Async})

After component render (OnAfterRender{Async})

Base class lifecycle methods

State changes (StateHasChanged)

Handle incomplete async actions at render

Handle errors

Stateful reconnection after prerendering

Prerendering with JavaScript interop

Component disposal with IDisposable and IAsyncDisposable

Disposal of JavaScript interop object references

DOM cleanup tasks during component disposal

Synchronous IDisposable

Asynchronous IAsyncDisposable

Assignment of null to disposed objects

StateHasChanged

Event handlers

Anonymous functions, methods, and expressions

Cancelable background work

Blazor Server reconnection events

Additional resources

When parameters are set (`SetParametersAsync`)

Component initialization (`OnInitialized{Async}`)

After parameters are set (`OnParametersSet{Async}`)

After component render (`OnAfterRender{Async}`)

State changes (`StateHasChanged`)

Component disposal with `IDisposable` and `IAsyncDisposable`

Synchronous `IDisposable`

Asynchronous `IAsyncDisposable`

Assignment of `null` to disposed objects

`StateHasChanged`