ASP.NET Core Blazor templates

By Daniel Roth and Luke Latham

Important

Blazor WebAssembly in preview

Blazor Server is supported in ASP.NET Core 3.0. Blazor WebAssembly is in preview for ASP.NET Core 3.1.

The Blazor framework provides templates to develop apps for each of the Blazor hosting models:

  • Blazor WebAssembly (blazorwasm)
  • Blazor Server (blazorserver)

For more information on Blazor's hosting models, see ASP.NET Core Blazor hosting models.

For step-by-step instructions on creating a Blazor app from a template, see Get started with ASP.NET Core Blazor.

Blazor project structure

The following files and folders make up a Blazor app generated from a Blazor template:

  • Program.cs – The app's entry point that sets up the ASP.NET Core host. The code in this file is common to all ASP.NET Core apps generated from ASP.NET Core templates.

  • Startup.cs – Contains the app's startup logic. The Startup class defines two methods:

    • ConfigureServices – Configures the app's dependency injection (DI) services. In Blazor Server apps, services are added by calling AddServerSideBlazor, and the WeatherForecastService is added to the service container for use by the example FetchData component.
    • Configure – Configures the app's request handling pipeline:
      • Blazor WebAssembly – Adds the App component (specified as the app DOM element to the AddComponent method), which is the root component of the app.
      • Blazor Server
        • MapBlazorHub is called to set up an endpoint for the real-time connection with the browser. The connection is created with SignalR, which is a framework for adding real-time web functionality to apps.
        • MapFallbackToPage("/_Host") is called to set up the root page of the app (Pages/_Host.cshtml) and enable navigation.
  • wwwroot/index.html (Blazor WebAssembly) – The root page of the app implemented as an HTML page:

    • When any page of the app is initially requested, this page is rendered and returned in the response.
    • The page specifies where the root App component is rendered. The App component (App.razor) is specified as the app DOM element to the AddComponent method in Startup.Configure.
    • The _framework/blazor.webassembly.js JavaScript file is loaded, which:
      • Downloads the .NET runtime, the app, and the app's dependencies.
      • Initializes the runtime to run the app.
  • Pages/_Host.cshtml (Blazor Server) – The root page of the app implemented as a Razor Page:

    • When any page of the app is initially requested, this page is rendered and returned in the response.
    • The _framework/blazor.server.js JavaScript file is loaded, which sets up the real-time SignalR connection between the browser and the server.
    • The Host page specifies where the root App component (App.razor) is rendered.
  • App.razor – The root component of the app that sets up client-side routing using the Router component. The Router component intercepts browser navigation and renders the page that matches the requested address.

  • Pages folder – Contains the routable components/pages (.razor) that make up the Blazor app. The route for each page is specified using the @page directive. The template includes the following components:

    • Index (Index.razor) – Implements the Home page.
    • Counter (Counter.razor) – Implements the Counter page.
    • Error (Error.razor, Blazor Server app only) – Rendered when an unhandled exception occurs in the app.
    • FetchData (FetchData.razor) – Implements the Fetch data page.
  • Shared folder – Contains other UI components (.razor) used by the app:

    • MainLayout (MainLayout.razor) – The app's layout component.
    • NavMenu (NavMenu.razor) – Implements sidebar navigation. Includes the NavLink component (NavLink), which renders navigation links to other Razor components. The NavLink component automatically indicates a selected state when its component is loaded, which helps the user understand which component is currently displayed.
  • _Imports.razor – Includes common Razor directives to include in the app's components (.razor), such as @using directives for namespaces.

  • Data folder (Blazor Server) – Contains the WeatherForecast class and implementation of the WeatherForecastService that provide example weather data to the app's FetchData component.

  • wwwroot – The Web Root folder for the app containing the app's public static assets.

  • appsettings.json (Blazor Server) – Configuration settings for the app.