WiredViews.Xperience.PageBuilderModeTagHelper 2.0.0

Xperience Page Builder Mode Tag Helper

This library provides an ASP.NET Core Tag Helper for Kentico Xperience 13.0 that adds to the existing set.

Dependencies

This package is compatible with ASP.NET Core 3.1 → ASP.NET Core 5 and is designed to be used with the Xperience 13.0 Content Delivery (MVC) application running on ASP.NET Core.

How to Use?

1. First, install the NuGet package in your ASP.NET Core project

   dotnet add package WiredViews.Xperience.PageBuilderModeTagHelper
   

2. Add the required types to the DI container in your Startup.cs file

   public void ConfigureServices(IServiceCollection services)
   {
       services.AddSingleton<IPageBuilderContext, XperiencePageBuilderContext>();
   }
   

3. Include the tag builder namespace in the ~/Views/_ViewImports.cshtml

   @addTagHelper *, Xperience.PageBuilderModeTagHelper
   

4. Use the tag helper in your Razor views

   <page-builder-mode exclude="Live">
   
       <h1>Hello!</h1>
   </page-builder-mode>
   
   <page-builder-mode include="LivePreview, Edit">
   
       <h1>Hello!</h1>
   </page-builder-mode>
   

5. You can also use the IPageBuilderContext as a constructor dependency elsewhere in your application to more easily determine the state of the current request, without having to use IHttpContextAccessor and all the Kentico Xperience extension methods:

   public class ProductsController
   {
       private readonly IPageBuilderContext context;
   
       public ProductsController(IPageBuilderContext context)
       {
           this.context = context ?? throw new ArgumentNullException(nameof(context));
       }
   
       public ActionResult Index()
       {
           if (context.IsEditMode)
           {
               // ...
           }
   
           if (context.IsLivePreviewMode)
           {
               // ...
           }
   
           if (context.IsLiveMode)
           {
               // ...
           }
   
           if (context.IsPreviewMode)
           {
               // ...
           }
       }
   }
   

References

ASP.NET Core

• Using Tag Helpers
• Authoring Tag Helpers
• ASP.NET Core - Environment Tag Helper (source)

Kentico Xperience

• Using Xperience 13.0 Built-in Tag Helpers