Kontrolowanie <head> zawartości w aplikacjach ASP.NET Core Blazor

Notatka

Nie jest to najnowsza wersja tego artykułu. Aby zapoznać się z bieżącą wersją, zobacz wersję .NET 11 tego artykułu.

Ostrzeżenie

Ta wersja ASP.NET Core nie jest już obsługiwana. Aby uzyskać więcej informacji, zobacz Zasady pomocy technicznej dla platform .NET i .NET Core. Aby zapoznać się z aktualną wersją, zobacz artykuł w wersji .NET 10.

Razor składniki mogą modyfikować zawartość elementu HTML <head> strony, w tym ustawiać tytuł strony (<title> element) i modyfikować metadane (<meta> elementy).

Sterowanie <head> zawartością w składniku Razor

Określ tytuł strony za pomocą składnika PageTitle, który umożliwia renderowanie elementu HTML <title> do składnika HeadOutlet.

Określ zawartość elementu <head> za pomocą komponentu HeadContent, który udostępnia zawartość komponentowi HeadOutlet.

Poniższy przykład ustawia tytuł i opis strony za pomocą Razor.

ControlHeadContent.razor:

@page "/control-head-content"

<PageTitle>@title</PageTitle>

<h1>Control <head> Content Example</h1>

<p>
    Title: @title
</p>

<p>
    Description: @description
</p>

<HeadContent>
    <meta name="description" content="@description">
</HeadContent>

@code {
    private string description = "This description is set by the component.";
    private string title = "Control <head> Content";
}
@page "/control-head-content"

<PageTitle>@title</PageTitle>

<h1>Control <head> Content Example</h1>

<p>
    Title: @title
</p>

<p>
    Description: @description
</p>

<HeadContent>
    <meta name="description" content="@description">
</HeadContent>

@code {
    private string description = "This description is set by the component.";
    private string title = "Control <head> Content";
}
@page "/control-head-content"

<h1>Control <head> content</h1>

<p>
    Title: @title
</p>

<p>
    Description: @description
</p>

<PageTitle>@title</PageTitle>

<HeadContent>
    <meta name="description" content="@description">
</HeadContent>

@code {
    private string description = "Description set by component";
    private string title = "Title set by component";
}
@page "/control-head-content"

<h1>Control <head> content</h1>

<p>
    Title: @title
</p>

<p>
    Description: @description
</p>

<PageTitle>@title</PageTitle>

<HeadContent>
    <meta name="description" content="@description">
</HeadContent>

@code {
    private string description = "Description set by component";
    private string title = "Title set by component";
}

Kontrolować zawartość <head> podczas prerenderingu

Ta sekcja dotyczy wstępnie wstępnie utworzonych Blazor WebAssembly aplikacji i Blazor Server aplikacji.

Gdy komponenty Razor są renderowane wstępnie, użycie strony układu (_Layout.cshtml) jest wymagane do kontrolowania zawartości <head> za pomocą komponentów PageTitle i HeadContent. Powodem tego wymagania jest to, że komponenty kontrolujące zawartość <head> muszą być renderowane przed układem z komponentem HeadOutlet. Ta kolejność renderowania jest wymagana do kontrolowania zawartości nagłówka.

Jeśli udostępniony plik _Layout.cshtml nie ma pomocnika tagów składników dla składnika HeadOutlet, dodaj go do elementów <head>.

W wymaganym, współdzielonym _Layout.cshtml pliku aplikacji Blazor Server lub Razor aplikacji Pages/MVC, która osadza składniki na stronach lub widokach:

<component type="typeof(HeadOutlet)" render-mode="ServerPrerendered" />

W wymaganym, współdzielonym _Layout.cshtml pliku wstępnie renderowanej hostowanej Blazor WebAssembly aplikacji:

<component type="typeof(HeadOutlet)" render-mode="WebAssemblyPrerendered" />

Ustawianie tytułu strony dla komponentów za pośrednictwem układu

Ustaw tytuł strony w składniku układu:

@inherits LayoutComponentBase

<PageTitle>Page Title</PageTitle>

<div class="page">
    ...  
</div>

HeadOutlet komponent

Składnik HeadOutlet renderuje zawartość dostarczaną przez komponenty PageTitle i HeadContent.

W elemencie Blazor Web App utworzonym na podstawie szablonu projektu składnik HeadOutlet w App.razor renderuje zawartość <head>:

<head>
    ...
    <HeadOutlet />
</head>

W aplikacjach Blazor Server, utworzonych na podstawie szablonu projektu Blazor Server, pomocnik tagów składnika renderuje zawartość <head> dla składnika HeadOutlet w Pages/_Host.cshtml:

<head>
    ...
    <component type="typeof(HeadOutlet)" render-mode="ServerPrerendered" />
</head>

W aplikacjach Blazor Server, utworzonych na podstawie szablonu projektu Blazor Server, pomocnik tagów składnika renderuje zawartość <head> dla składnika HeadOutlet w Pages/_Layout.cshtml:

<head>
    ...
    <component type="typeof(HeadOutlet)" render-mode="ServerPrerendered" />
</head>

W aplikacji utworzonej na podstawie szablonu projektu Blazor WebAssembly składnik HeadOutlet jest dodawany do kolekcji RootComponents w elemencie WebAssemblyHostBuilder w pliku Program po stronie klienta:

builder.RootComponents.Add<HeadOutlet>("head::after");

Po określeniu ::after pseudo-selektora zawartość składnika głównego jest dołączana do istniejącej zawartości elementu head zamiast zastępowania zawartości. Dzięki temu aplikacja może zachować statyczną zawartość sekcji head w wwwroot/index.html bez konieczności powtarzania tej zawartości w komponentach Razor aplikacji.

Ustaw domyślny tytuł strony w obiekcie Blazor Web App

Ustaw tytuł strony w składniku App (App.razor):

<head>
    ...
    <HeadOutlet />
    <PageTitle>Page Title</PageTitle>
</head>

Nie znaleziony tytuł strony w aplikacji Blazor WebAssembly

W aplikacjach Blazor utworzonych na podstawie szablonu projektu Blazor WebAssembly Aplikacja autonomiczna szablon składnika NotFound w pliku składnika App (App.razor) ustawia tytuł strony na wartość Not found.

W aplikacjach utworzonych z szablonu projektu Blazor, NotFound szablon składnika w składniku App (App.razor) ustawia tytuł strony na Not found.

App.razor:

<NotFound>
    <PageTitle>Not found</PageTitle>
    ...
</NotFound>

Dokumentacja Mozilla MDN Web Docs: