daohualiuxiang
/
AspNetCore.Docs
mirror of https://github.com/dotnet/AspNetCore.Docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
AspNetCore.Docs/aspnetcore/razor-pages/ui-class.md

17 KiB
Raw Blame History

title author description ms.author ms.date ms.custom no-loc uid
Reusable Razor UI in class libraries with ASP.NET Core Rick-Anderson Explains how to create reusable Razor UI using partial views in a class library in ASP.NET Core. riande 01/25/2020 mvc, seodec18
ASP.NET Core Identity
cookie
Cookie
Blazor
Blazor Server
Blazor WebAssembly
Identity
Let's Encrypt
Razor
SignalR
razor-pages/ui-class

Create reusable UI using the Razor class library project in ASP.NET Core

By Rick Anderson

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

Razor views, pages, controllers, page models, Razor components, View components, and data models can be built into a Razor class library (RCL). The RCL can be packaged and reused. Applications can include the RCL and override the views and pages it contains. When a view, partial view, or Razor Page is found in both the web app and the RCL, the Razor markup (.cshtml file) in the web app takes precedence.

View or download sample code (how to download)

Create a class library containing Razor UI

Visual Studio

  • From Visual Studio select Create new a new project.
  • Select Razor Class Library > Next.
  • Name the library (for example, "RazorClassLib"), > Create. To avoid a file name collision with the generated view library, ensure the library name doesn't end in .Views.
  • Select Support pages and views if you need to support views. By default, only Razor Pages are supported. Select Create.

The Razor class library (RCL) template defaults to Razor component development by default. The Support pages and views option supports pages and views.

.NET Core CLI

From the command line, run dotnet new razorclasslib. For example:

dotnet new razorclasslib -o RazorUIClassLib

The Razor class library (RCL) template defaults to Razor component development by default. Pass the --support-pages-and-views option (dotnet new razorclasslib --support-pages-and-views) to provide support for pages and views.

For more information, see dotnet new. To avoid a file name collision with the generated view library, ensure the library name doesn't end in .Views.

Add Razor files to the RCL.

The ASP.NET Core templates assume the RCL content is in the Areas folder. See RCL Pages layout to create an RCL that exposes content in ~/Pages rather than ~/Areas/Pages.

Reference RCL content

The RCL can be referenced by:

Override views, partial views, and pages

When a view, partial view, or Razor Page is found in both the web app and the RCL, the Razor markup (.cshtml file) in the web app takes precedence. For example, add WebApp1/Areas/MyFeature/Pages/Page1.cshtml to WebApp1, and Page1 in the WebApp1 will take precedence over Page1 in the RCL.

In the sample download, rename WebApp1/Areas/MyFeature2 to WebApp1/Areas/MyFeature to test precedence.

Copy the RazorUIClassLib/Areas/MyFeature/Pages/Shared/_Message.cshtml partial view to WebApp1/Areas/MyFeature/Pages/Shared/_Message.cshtml. Update the markup to indicate the new location. Build and run the app to verify the app's version of the partial is being used.

RCL Pages layout

To reference RCL content as though it is part of the web app's Pages folder, create the RCL project with the following file structure:

  • RazorUIClassLib/Pages
  • RazorUIClassLib/Pages/Shared

Suppose RazorUIClassLib/Pages/Shared contains two partial files: _Header.cshtml and _Footer.cshtml. The <partial> tags could be added to _Layout.cshtml file:

<body>
  <partial name="_Header">
  @RenderBody()
  <partial name="_Footer">
</body>

Create an RCL with static assets

An RCL may require companion static assets that can be referenced by either the RCL or the consuming app of the RCL. ASP.NET Core allows creating RCLs that include static assets that are available to a consuming app.

To include companion assets as part of an RCL, create a wwwroot folder in the class library and include any required files in that folder.

When packing an RCL, all companion assets in the wwwroot folder are automatically included in the package.

Use the dotnet pack command rather than the NuGet.exe version nuget pack.

Exclude static assets

To exclude static assets, add the desired exclusion path to the $(DefaultItemExcludes) property group in the project file. Separate entries with a semicolon (;).

In the following example, the lib.css stylesheet in the wwwroot folder isn't considered a static asset and isn't included in the published RCL:

<PropertyGroup>
  <DefaultItemExcludes>$(DefaultItemExcludes);wwwroot\lib.css</DefaultItemExcludes>
</PropertyGroup>

Typescript integration

To include TypeScript files in an RCL:

  1. Place the TypeScript files (.ts) outside of the wwwroot folder. For example, place the files in a Client folder.

  2. Configure the TypeScript build output for the wwwroot folder. Set the TypescriptOutDir property inside of a PropertyGroup in the project file:

    <TypescriptOutDir>wwwroot</TypescriptOutDir>

  3. Include the TypeScript target as a dependency of the ResolveCurrentProjectStaticWebAssets target by adding the following target inside of a PropertyGroup in the project file:

    <ResolveCurrentProjectStaticWebAssetsInputsDependsOn>
  CompileTypeScript;
  $(ResolveCurrentProjectStaticWebAssetsInputs)
</ResolveCurrentProjectStaticWebAssetsInputsDependsOn>

Consume content from a referenced RCL

The files included in the wwwroot folder of the RCL are exposed to either the RCL or the consuming app under the prefix _content/{LIBRARY NAME}/. For example, a library named Razor.Class.Lib results in a path to static content at _content/Razor.Class.Lib/. When producing a NuGet package and the assembly name isn't the same as the package ID, use the package ID for {LIBRARY NAME}.

The consuming app references static assets provided by the library with <script>, <style>, <img>, and other HTML tags. The consuming app must have static file support enabled in Startup.Configure:

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    ...

    app.UseStaticFiles();

    ...
}

When running the consuming app from build output (dotnet run), static web assets are enabled by default in the Development environment. To support assets in other environments when running from build output, call UseStaticWebAssets on the host builder in Program.cs:

using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStaticWebAssets();
                webBuilder.UseStartup<Startup>();
            });
}

Calling UseStaticWebAssets isn't required when running an app from published output (dotnet publish).

Multi-project development flow

When the consuming app runs:

  • The assets in the RCL stay in their original folders. The assets aren't moved to the consuming app.
  • Any change within the RCL's wwwroot folder is reflected in the consuming app after the RCL is rebuilt and without rebuilding the consuming app.

When the RCL is built, a manifest is produced that describes the static web asset locations. The consuming app reads the manifest at runtime to consume the assets from referenced projects and packages. When a new asset is added to an RCL, the RCL must be rebuilt to update its manifest before a consuming app can access the new asset.

Publish

When the app is published, the companion assets from all referenced projects and packages are copied into the wwwroot folder of the published app under _content/{LIBRARY NAME}/.

::: moniker-end

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

Razor views, pages, controllers, page models, Razor components, View components, and data models can be built into a Razor class library (RCL). The RCL can be packaged and reused. Applications can include the RCL and override the views and pages it contains. When a view, partial view, or Razor Page is found in both the web app and the RCL, the Razor markup (.cshtml file) in the web app takes precedence.

View or download sample code (how to download)

Create a class library containing Razor UI

Visual Studio

  • From the Visual Studio File menu, select New > Project.
  • Select ASP.NET Core Web Application.
  • Name the library (for example, "RazorClassLib") > OK. To avoid a file name collision with the generated view library, ensure the library name doesn't end in .Views.
  • Verify ASP.NET Core 2.1 or later is selected.
  • Select Razor Class Library > OK.

An RCL has the following project file:

[!code-xml]

.NET Core CLI

From the command line, run dotnet new razorclasslib. For example:

dotnet new razorclasslib -o RazorUIClassLib

For more information, see dotnet new. To avoid a file name collision with the generated view library, ensure the library name doesn't end in .Views.

Add Razor files to the RCL.

The ASP.NET Core templates assume the RCL content is in the Areas folder. See RCL Pages layout to create an RCL that exposes content in ~/Pages rather than ~/Areas/Pages.

Reference RCL content

The RCL can be referenced by:

Walkthrough: Create an RCL project and use from a Razor Pages project

You can download the complete project and test it rather than creating it. The sample download contains additional code and links that make the project easy to test. You can leave feedback in this GitHub issue with your comments on download samples versus step-by-step instructions.

Test the download app

If you haven't downloaded the completed app and would rather create the walkthrough project, skip to the next section.

Visual Studio

Open the .sln file in Visual Studio. Run the app.

.NET Core CLI

From a command prompt in the cli directory, build the RCL and web app.

dotnet build

Move to the WebApp1 directory and run the app:

dotnet run

Follow the instructions in Test WebApp1

Create an RCL

In this section, an RCL is created. Razor files are added to the RCL.

Visual Studio

Create the RCL project:

  • From the Visual Studio File menu, select New > Project.
  • Select ASP.NET Core Web Application.
  • Name the app RazorUIClassLib > OK.
  • Verify ASP.NET Core 2.1 or later is selected.
  • Select Razor Class Library > OK.
  • Add a Razor partial view file named RazorUIClassLib/Areas/MyFeature/Pages/Shared/_Message.cshtml.

.NET Core CLI

From the command line, run the following:

dotnet new razorclasslib -o RazorUIClassLib
dotnet new page -n _Message -np -o RazorUIClassLib/Areas/MyFeature/Pages/Shared
dotnet new viewstart -o RazorUIClassLib/Areas/MyFeature/Pages

The preceding commands:

  • Creates the RazorUIClassLib RCL.
  • Creates a Razor _Message page, and adds it to the RCL. The -np parameter creates the page without a PageModel.
  • Creates a _ViewStart.cshtml file and adds it to the RCL.

The _ViewStart.cshtml file is required to use the layout of the Razor Pages project (which is added in the next section).

Add Razor files and folders to the project

  • Replace the markup in RazorUIClassLib/Areas/MyFeature/Pages/Shared/_Message.cshtml with the following code:

    [!code-cshtml]

  • Replace the markup in RazorUIClassLib/Areas/MyFeature/Pages/Page1.cshtml with the following code:

    [!code-cshtml]

    @addTagHelper *, Microsoft.AspNetCore.Mvc.TagHelpers is required to use the partial view (<partial name="_Message" />). Rather than including the @addTagHelper directive, you can add a _ViewImports.cshtml file. For example:

    dotnet new viewimports -o RazorUIClassLib/Areas/MyFeature/Pages

    For more information on _ViewImports.cshtml, see Importing Shared Directives

  • Build the class library to verify there are no compiler errors:

    dotnet build RazorUIClassLib

The build output contains RazorUIClassLib.dll and RazorUIClassLib.Views.dll. RazorUIClassLib.Views.dll contains the compiled Razor content.

Use the Razor UI library from a Razor Pages project

Visual Studio

Create the Razor Pages web app:

  • From Solution Explorer, right-click the solution > Add > New Project.

  • Select ASP.NET Core Web Application.

  • Name the app WebApp1.

  • Verify ASP.NET Core 2.1 or later is selected.

  • Select Web Application > OK.

  • From Solution Explorer, right-click on WebApp1 and select Set as StartUp Project.

  • From Solution Explorer, right-click on WebApp1 and select Build Dependencies > Project Dependencies.

  • Check RazorUIClassLib as a dependency of WebApp1.

  • From Solution Explorer, right-click on WebApp1 and select Add > Reference.

  • In the Reference Manager dialog, check RazorUIClassLib > OK.

Run the app.

.NET Core CLI

Create a Razor Pages web app and a solution file containing the Razor Pages app and the RCL:

dotnet new webapp -o WebApp1
dotnet new sln
dotnet sln add WebApp1
dotnet sln add RazorUIClassLib
dotnet add WebApp1 reference RazorUIClassLib

Build and run the web app:

cd WebApp1
dotnet run

Test WebApp1

Browse to /MyFeature/Page1 to verify that the Razor UI class library is in use.

Override views, partial views, and pages

When a view, partial view, or Razor Page is found in both the web app and the RCL, the Razor markup (.cshtml file) in the web app takes precedence. For example, add WebApp1/Areas/MyFeature/Pages/Page1.cshtml to WebApp1, and Page1 in the WebApp1 will take precedence over Page1 in the RCL.

In the sample download, rename WebApp1/Areas/MyFeature2 to WebApp1/Areas/MyFeature to test precedence.

Copy the RazorUIClassLib/Areas/MyFeature/Pages/Shared/_Message.cshtml partial view to WebApp1/Areas/MyFeature/Pages/Shared/_Message.cshtml. Update the markup to indicate the new location. Build and run the app to verify the app's version of the partial is being used.

RCL Pages layout

To reference RCL content as though it is part of the web app's Pages folder, create the RCL project with the following file structure:

  • RazorUIClassLib/Pages
  • RazorUIClassLib/Pages/Shared

Suppose RazorUIClassLib/Pages/Shared contains two partial files: _Header.cshtml and _Footer.cshtml. The <partial> tags could be added to _Layout.cshtml file:

<body>
  <partial name="_Header">
  @RenderBody()
  <partial name="_Footer">
</body>

::: moniker-end

Additional resources