Our.Umbraco.BlockPreview 1.0.0

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Our.Umbraco.BlockPreview --version 1.0.0                

                    
                

            
NuGet\Install-Package Our.Umbraco.BlockPreview -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Our.Umbraco.BlockPreview" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Our.Umbraco.BlockPreview --version 1.0.0                

                    
                

            
#r "nuget: Our.Umbraco.BlockPreview, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Our.Umbraco.BlockPreview as a Cake Addin
#addin nuget:?package=Our.Umbraco.BlockPreview&version=1.0.0

// Install Our.Umbraco.BlockPreview as a Cake Tool
#tool nuget:?package=Our.Umbraco.BlockPreview&version=1.0.0

Our.Umbraco.BlockPreview

Platform NuGet GitHub

Our.Umbraco.BlockPreview enables easy to use rich HTML previews for the Umbraco Block List and Block Grid editors.

Todo

  • Support for BlockList or BlockGrid with settings models
  • Add support for ModelsBuilder modes other than SourceCodeManual/SourceCodeAuto
  • Add support for areas
  • Get it working with the Umbraco Block Grid Example Website

Installation

The Umbraco 10.4+ version of this package is available via NuGet.

To install the package, you can use either .NET CLI:

dotnet add package Our.Umbraco.BlockPreview --version 1.0.0

or the older NuGet Package Manager:

Install-Package Our.Umbraco.BlockPreview -Version 1.0.0

Usage

This package installs a custom Angular preview for both the Block List and Block Grid editors.

When setting up a block to be part of the List or Grid, setting the 'Custom View' property to the appropriate block-[grid|list]-preview.html file will generate preview HTML based on the respective partial view found in /Views/Partials/blocklist/Components or /Views/Partials/blockgrid/Components.

How to select the custom views when creating a Block List/Grid: Screenshot

Before and after of how components look within the Block Grid: Screenshot2

Grid-specific setup

When using the new Block Grid, replace the references below in your Grid template partial views

Default Umbraco usage BlockPreview usage
@await Html.GetBlockGridItemAreasHtmlAsync(Model) @await Html.GetPreviewBlockGridItemAreasHtmlAsync(Model)
@await GetBlockGridItemAreaHtmlAsync(Model) @await GetPreviewBlockGridItemAreaHtmlAsync(Model)
@await GetBlockGridItemsHtmlAsync(Model) @await GetPreviewBlockGridItemsHtmlAsync(Model)

All of these extensions can be found in the namespace Our.Umbraco.BlockPreview.Extensions. This ensures that the grid editors correctly load in the back office.

Credits

This package is entirely based on the amazing work done by Dave Woestenborghs for 24days in Umbraco 2021. His code has been extended to support the new Block Grid editor in v10.4/v11 and turned into this package.

Matthew Wise also wrote a great article for 24days in Umbraco 2022 which added the ability to surface ViewComponents and has allowed his code to be contributed.

License

Copyright © 2022-2023 Rick Butterfield, and other contributors.

Licensed under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.3.1 228 6/26/2023 1.3.1 is deprecated because it is no longer maintained.
1.3.0 325 6/20/2023
1.2.3 334 5/24/2023
1.2.2 144 5/24/2023
1.2.1 683 4/12/2023
1.2.0 188 4/12/2023
1.1.2 271 3/14/2023
1.1.1 218 3/7/2023
1.1.0 248 2/25/2023
1.0.1 362 2/3/2023
1.0.0 311 1/24/2023
1.0.0-rc2 170 1/5/2023
1.0.0-rc1 155 12/22/2022
1.0.0-alpha005 185 12/7/2022
1.0.0-alpha004 160 12/5/2022
1.0.0-alpha003 146 12/2/2022
1.0.0-alpha002 146 12/2/2022
1.0.0-alpha001 183 12/2/2022