Muokkaa

Jaa

ASP.NET Core Blazor fundamentals

  • Artikkeli

Note

This isn't the latest version of this article. For the current release, see the .NET 9 version of this article.

Warning

This version of ASP.NET Core is no longer supported. For more information, see the .NET and .NET Core Support Policy. For the current release, see the .NET 9 version of this article.

Important

This information relates to a pre-release product that may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

For the current release, see the .NET 9 version of this article.

Fundamentals articles provide guidance on foundational Blazor concepts. Some of the concepts are connected to a basic understanding of Razor components, which are described further in the next section of this article and covered in detail in the Components articles.

Static and interactive rendering concepts

Razor components are either statically rendered or interactively rendered.

Static or static rendering is a server-side scenario that means the component is rendered without the capacity for interplay between the user and .NET/C# code. JavaScript and HTML DOM events remain unaffected, but no user events on the client can be processed with .NET running on the server.

Interactive or interactive rendering means that the component has the capacity to process .NET events via C# code. The .NET events are either processed on the server by the ASP.NET Core runtime or in the browser on the client by the WebAssembly-based Blazor runtime.

Important

When using a Blazor Web App, most of the Blazor documentation example components require interactivity to function and demonstrate the concepts covered by the articles. When you test an example component provided by an article, make sure that either the app adopts global interactivity or the component adopts an interactive render mode.

More information on these concepts and how to control static and interactive rendering is found in the ASP.NET Core Blazor render modes article later in the Blazor documentation.

Client and server rendering concepts

Throughout the Blazor documentation, activity that takes place on the user's system is said to occur on the client or client-side. Activity that takes place on a server is said to occur on the server or server-side.

The term rendering means to produce the HTML markup that browsers display.

  • Client-side rendering (CSR) means that the final HTML markup is generated by the .NET WebAssembly runtime on the client. No HTML for the app's client-generated UI is sent from a server to the client for this type of rendering. User interactivity with the page is assumed. There's no such concept as static client-side rendering. CSR is assumed to be interactive, so "interactive client-side rendering" and "interactive CSR" aren't used by the industry or in the Blazor documentation.

  • Server-side rendering (SSR) means that the final HTML markup is generated by the ASP.NET Core runtime on the server. The HTML is sent to the client over a network for display by the client's browser. No HTML for the app's server-generated UI is created by the client for this type of rendering. SSR can be of two varieties:

    • Static SSR: The server produces static HTML that doesn't provide for user interactivity or maintaining Razor component state.
    • Interactive SSR: Blazor events permit user interactivity and Razor component state is maintained by the Blazor framework.

  • Prerendering is the process of initially rendering page content on the server without enabling event handlers for rendered controls. The server outputs the HTML UI of the page as soon as possible in response to the initial request, which makes the app feel more responsive to users. Prerendering can also improve Search Engine Optimization (SEO) by rendering content for the initial HTTP response that search engines use to calculate page rank. Prerendering is always followed by final rendering, either on the server or the client.

Razor components

Blazor apps are based on Razor components, often referred to as just components. A component is an element of UI, such as a page, dialog, or data entry form. Components are .NET C# classes built into .NET assemblies.

Razor refers to how components are usually written in the form of a Razor markup page for client-side UI logic and composition. Razor is a syntax for combining HTML markup with C# code designed for developer productivity. Razor files use the .razor file extension.

Although some Blazor developers and online resources use the term "Blazor components," the documentation avoids that term and universally uses "Razor components" or "components."

Blazor documentation adopts several conventions for showing and discussing components:

  • Generally, examples adhere to ASP.NET Core/C# coding conventions and engineering guidelines. For more information see the following resources:
  • Project code, file paths and names, project template names, and other specialized terms are in United States English and usually code-fenced.
  • Components are usually referred to by their C# class name (Pascal case) followed by the word "component." For example, a typical file upload component is referred to as the "FileUpload component."
  • Usually, a component's C# class name is the same as its file name.
  • Routable components usually set their relative URLs to the component's class name in kebab-case. For example, a FileUpload component includes routing configuration to reach the rendered component at the relative URL /file-upload. Routing and navigation is covered in ASP.NET Core Blazor routing and navigation.
  • When multiple versions of a component are used, they're numbered sequentially. For example, the FileUpload3 component is reached at /file-upload-3.
  • Razor directives at the top of a component definition (.razor file) are placed in the following order: @page, @rendermode (.NET 8 or later), @using statements, other directives in alphabetical order.
  • Although not required for private members, access modifiers are used in article examples and sample apps. For example, private is stated for declaring a field named maxAllowedFiles as private int maxAllowedFiles = 3;.
  • Component parameter values lead with a Razor reserved @ symbol, but it isn't required. Literals (for example, boolean values), keywords (for example, this), and null as component parameter values aren't prefixed with @, but this is also merely a documentation convention. Your own code can prefix literals with @ if you wish.
  • C# classes use the this keyword and avoid prefixing fields with an underscore (_) that are assigned to in constructors, which differs from the ASP.NET Core framework engineering guidelines.
  • In examples that use primary constructors (C# 12 or later), primary constructor parameters are typically used directly by class members. In article examples, code lines are split to reduce horizontal scrolling. These breaks don't affect execution but can be removed when pasting into your project.

Additional information on Razor component syntax is provided in the Razor syntax section of ASP.NET Core Razor components.

The following is an example counter component and part of an app created from a Blazor project template. Detailed components coverage is found in the Components articles later in the documentation. The following example demonstrates component concepts seen in the Fundamentals articles before reaching the Components articles later in the documentation.

Counter.razor:

The component assumes that an interactive render mode is inherited from a parent component or applied globally to the app.

@page "/counter"

<PageTitle>Counter</PageTitle>

<h1>Counter</h1>

<p role="status">Current count: @currentCount</p>

<button class="btn btn-primary" @onclick="IncrementCount">Click me</button>

@code {
    private int currentCount = 0;

    private void IncrementCount() => currentCount++;
}

The component assumes that an interactive render mode is inherited from a parent component or applied globally to the app.

@page "/counter"

<PageTitle>Counter</PageTitle>

<h1>Counter</h1>

<p role="status">Current count: @currentCount</p>

<button class="btn btn-primary" @onclick="IncrementCount">Click me</button>

@code {
    private int currentCount = 0;

    private void IncrementCount() => currentCount++;
}

@page "/counter"

<PageTitle>Counter</PageTitle>

<h1>Counter</h1>

<p role="status">Current count: @currentCount</p>

<button class="btn btn-primary" @onclick="IncrementCount">Click me</button>

@code {
    private int currentCount = 0;

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

@page "/counter"

<PageTitle>Counter</PageTitle>

<h1>Counter</h1>

<p role="status">Current count: @currentCount</p>

<button class="btn btn-primary" @onclick="IncrementCount">Click me</button>

@code {
    private int currentCount = 0;

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

@page "/counter"

<h1>Counter</h1>

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

<button class="btn btn-primary" @onclick="IncrementCount">Click me</button>

@code {
    private int currentCount = 0;

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

@page "/counter"

<h1>Counter</h1>

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

<button class="btn btn-primary" @onclick="IncrementCount">Click me</button>

@code {
    private int currentCount = 0;

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

The preceding Counter component:

  • Sets its route with the @page directive in the first line.
  • Sets its page title and heading.
  • Renders the current count with @currentCount. currentCount is an integer variable defined in the C# code of the @code block.
  • Displays a button to trigger the IncrementCount method, which is also found in the @code block and increases the value of the currentCount variable.

Render modes

Articles in the Fundamentals node make reference to the concept of render modes. This subject is covered in detail in the ASP.NET Core Blazor render modes article in the Components node, which appears after the Fundamentals node of articles.

For the early references in this node of articles to render mode concepts, merely note the following at this time:

Every component in a Blazor Web App adopts a render mode to determine the hosting model that it uses, where it's rendered, and whether or not it's rendered statically on the server, rendered with for user interactivity on the server, or rendered for user interactivity on the client (usually with prerendering on the server).

Blazor Server and Blazor WebAssembly apps for ASP.NET Core releases prior to .NET 8 remain fixated on hosting model concepts, not render modes. Render modes are conceptually applied to Blazor Web Apps in .NET 8 or later.

The following table shows the available render modes for rendering Razor components in a Blazor Web App. Render modes are applied to components with the @rendermode directive on the component instance or on the component definition. It's also possible to set a render mode for the entire app.

Name Description Render location Interactive
Static Server Static server-side rendering (static SSR) Server
Interactive Server Interactive server-side rendering (interactive SSR) using Blazor Server Server
Interactive WebAssembly Client-side rendering (CSR) using Blazor WebAssembly† Client
Interactive Auto Interactive SSR using Blazor Server initially and then CSR on subsequent visits after the Blazor bundle is downloaded Server, then client

†Client-side rendering (CSR) is assumed to be interactive. "Interactive client-side rendering" and "interactive CSR" aren't used by the industry or in the Blazor documentation.

The preceding information on render modes is all that you need to know to understand the Fundamentals node articles. If you're new to Blazor and reading Blazor articles in order down the table of contents, you can delay consuming in-depth information on render modes until you reach the ASP.NET Core Blazor render modes article in the Components node.

Document Object Model (DOM)

References to the Document Object Model use the abbreviation DOM.

For more information, see the following resources:

Subset of .NET APIs for Blazor WebAssembly apps

A curated list of specific .NET APIs that are supported on the browser for Blazor WebAssembly isn't available. However, you can manually search for a list of .NET APIs annotated with [UnsupportedOSPlatform("browser")] to discover .NET APIs that aren't supported in WebAssembly.

Note

Documentation links to .NET reference source usually load the repository's default branch, which represents the current development for the next release of .NET. To select a tag for a specific release, use the Switch branches or tags dropdown list. For more information, see How to select a version tag of ASP.NET Core source code (dotnet/AspNetCore.Docs #26205).

For more information, see the following resources:

Sample apps

Documentation sample apps are available for inspection and download:

Blazor samples GitHub repository (dotnet/blazor-samples)

Locate a sample app by first selecting the version folder that matches the version of .NET that you're working with.

Samples apps in the repository:

Samples apps in the repository:

The sample repo contains two types of samples:

  • Snippet sample apps provide the code examples that appear in articles. These apps compile but aren't necessarily runnable apps. These apps are useful for merely obtaining example code that appears in articles.
  • Samples apps to accompany Blazor articles compile and run for the following scenarios:
    • Blazor Server with EF Core
    • Blazor Server and Blazor WebAssembly with SignalR
    • Blazor WebAssembly scopes-enabled logging

For more information, a list of the samples in the repository, and download instructions, see the Blazor samples GitHub repository README file.

The ASP.NET Core repository's Basic Test App is also a helpful set of samples for various Blazor scenarios:

BasicTestApp in ASP.NET Core reference source (dotnet/aspnetcore)

Note

Documentation links to .NET reference source usually load the repository's default branch, which represents the current development for the next release of .NET. To select a tag for a specific release, use the Switch branches or tags dropdown list. For more information, see How to select a version tag of ASP.NET Core source code (dotnet/AspNetCore.Docs #26205).

Byte multiples

.NET byte sizes use metric prefixes for non-decimal multiples of bytes based on powers of 1024.

Name (abbreviation) Size Example
Kilobyte (KB) 1,024 bytes 1 KB = 1,024 bytes
Megabyte (MB) 1,0242 bytes 1 MB = 1,048,576 bytes
Gigabyte (GB) 1,0243 bytes 1 GB = 1,073,741,824 bytes

Support requests

Only documentation-related issues are appropriate for the dotnet/AspNetCore.Docs repository. For product support, don't open a documentation issue. Seek assistance through one or more of the following support channels:

For a potential bug in the framework or product feedback, open an issue for the ASP.NET Core product unit at dotnet/aspnetcore issues. Bug reports usually require the following:

  • Clear explanation of the problem: Follow the instructions in the GitHub issue template provided by the product unit when opening the issue.
  • Minimal repro project: Place a project on GitHub for the product unit engineers to download and run. Cross-link the project into the issue's opening comment.

For a potential problem with a Blazor article, open a documentation issue. To open a documentation issue, use the Open a documentation issue feedback link at the bottom of the article. Metadata added to your issue provides tracking data and automatically pings the author of the article. If the subject was discussed with the product unit prior to opening the documentation issue, place a cross-link to the engineering issue in the documentation issue's opening comment.

For problems or feedback on Visual Studio, use the Report a Problem or Suggest a Feature gestures from within Visual Studio, which open internal issues for Visual Studio. For more information, see Visual Studio Feedback.

For problems with Visual Studio Code, ask for support on community support forums. For bug reports and product feedback, open an issue on the microsoft/vscode GitHub repo.

GitHub issues for Blazor documentation are automatically marked for triage on the Blazor.Docs project (dotnet/AspNetCore.Docs GitHub repository). Please wait a short while for a response, especially over weekends and holidays. Usually, documentation authors respond within 24 hours on weekdays.

For a collection of links to Blazor resources maintained by the community, visit Awesome Blazor.

Note

Microsoft doesn't own, maintain, or support Awesome Blazor and most of the community products and services described and linked there.