NestingContently.Umbraco 12.0.0

dotnet add package NestingContently.Umbraco --version 12.0.0
NuGet\Install-Package NestingContently.Umbraco -Version 12.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="NestingContently.Umbraco" Version="12.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NestingContently.Umbraco --version 12.0.0
#r "nuget: NestingContently.Umbraco, 12.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 NestingContently.Umbraco as a Cake Addin
#addin nuget:?package=NestingContently.Umbraco&version=12.0.0

// Install NestingContently.Umbraco as a Cake Tool
#tool nuget:?package=NestingContently.Umbraco&version=12.0.0

Depending on who you ask, a big gap in Umbraco's original Nested Content property editor was the ability to disable nested items (ie, keep them in the current editor, but turn 'em off on the front end).

There are workarounds, but for our Dear Editors, the best solution is an additional button in the header row for each nested item (Archetype fans, I see you nodding).

While the days of Nested Content are largely behind us, the same issue exists in Block Grid and Block List.

The latest versions of Nesting Contently support ONLY Block-based editors on Umbraco 10+, adding a toggle to the block header so your editors will forever be ... wait for it ... Nesting Contently.

Getting started

Installing and setting up the latest Nesting Contently version is straightforward:

  • Install via your CLI of choice:
    • dotnet add package NestingContently.Umbraco
    • Install-Package NestingContently.Umbraco
  • Add a true/false property to the block element (settings or content, either is fine)
  • The property alias MUST be umbracoNaviHide
  • Done. That's it. No more.
  • Amaze your editors with the added flexibility

There's no longer a property editor to install, just some helpful Javascript to manage injecting the button and syncing the value change back to the block.

Nesting Contently v10+ ships with property value converters for Block List and Block Grid, to remove any hidden blocks before rendering.

For Block Grid, this works with infinitely nested blocks, so feel free to create disgusting levels of nesting (don't really, your editors will hate you).

There's no need to read any further, the rest is just a history lesson, but you can jump straight to the good part and the follow up good part.

What about the old Umbraco versions?

Nesting Contently originally supported Umbraco v7 (Nesting Contently v1), and only supported the Nested Content editor.

Support for v8+ (Nesting Contently v4+) came later.

v4 eventually supported Umbraco 8 and 9, with support for Nested Content and Block List.

Installing the wrong version won't blow up your site, it just won't do anything. That said, there's no plans to support anything other than the latest version.

Introducing Nesting Contently III - with a vengeance

Umbraco 8.7 introduced the Block List editor (can you believe it was that long ago?), which takes all the best bits of Nested Content, the Grid, Doc Type Grid Editor and others, mixes in a bit of unicorn snot to stick it all together and creates a new editing paradigm. Only thing missing? A native disable button for blocks.

Fear not! Nesting Contently III got your back, friend. NC III works its magic on the Block List, to make disabling blocks as easy as something really easy. NC III also supports nested Nested Content, if you're into that kinda thing. Probably supports nested nested Nested Content too, you pervert.

NC III is a big old change of approach with respect to updating model values - it's a lot simpler, to better work with (around?) Nested Content's interesting (odd?) approach to model syncing. For Block List, it's super straight forward, which is nice, and allows NC III to support both editors from the same implementation.

Hell, you shouldn't be reading this far. Don't install this version, go away and upgrade your Umbraco websites and enjoy all the features and improvements added since Block List arrived in 8.7 way back in September 2020.

Get it

  • via Nuget ⇒ Install-Package NestingContently.Umbraco

Setup

  • Install this package (derp)
  • Create a new data type using the Nesting Contently editor
  • Add the data type to the Nested Content document type
  • Name it whatever you like, but ideally set the alias to umbracoNaviHide to be able to use the .IsVisible() extension when iterating the nested items. Using any other alias means you'll need to check the property value when rendering
  • Stun your content editors with your brilliance

The editor itself is not displayed when editing the nested items - it only exists to create the property on the document type.

The button is displayed in header rows for nested items containing the Nesting Contently editor, so we can have items with the disable/enable toggle, and others without, in the same Nested Content / Block List property. Cool, right?

Toggling the button modifies the parent's parent's parent's (maybe another parent) model value, and all is well.

There's no need to touch any core files, so no worries with upgrade paths being borked. Some of the implementation is a little bit dirty, but this is essentially a hack anyway, so sue me (don't though).

Extra setup bit if you don't want to install the property converters package (if not, why not?)

The above bits said, Models Builder doesn't play nice with Nesting Contently given the absence of a property value converter. Rather than adding an assembly to the package simply to deliver 8 lines of code, it's included below instead.

Depending on your setup, this may not matter - using umbracoNaviHide and .IsVisible() will work fine without the converter - .IsVisible() explicitly uses Umbraco's built-in boolean converter, and is nicely declarative so makes your code more readable.

Add this somewhere to your solution to keep Models Builder happy (for v7, and v8, respectively):

[PropertyValueType(typeof(bool))]
[PropertyValueCache(PropertyCacheValue.All, PropertyCacheLevel.Content)]
public class NestingContentlyValueConverter : Umbraco.Core.PropertyEditors.ValueConverters.YesNoValueConverter
{
    public override bool IsConverter(PublishedPropertyType propertyType)
    {
        return propertyType.PropertyEditorAlias == "NestingContently";
    }
}    
using Umbraco.Core.Models.PublishedContent;

public class NestingContentlyValueConverter : Umbraco.Core.PropertyEditors.ValueConverters.YesNoValueConverter
{
   public override bool IsConverter(IPublishedPropertyType propertyType)
      => propertyType.EditorAlias == "NestingContently";
}

Drama Cabana

It's a long read, but this thread provides some background context around why this feature is (or isn't, depending on your persective) needed in the core.

It's also an interesting insight into product and community management, contributing to OSS and the investment plenty of people have in the Umbraco ecosystem.

There may or may not be a similar thread debating the merits of a disable button in the Block List, but don't waste your time debating it, just install this bad boy and get on with your day.

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
12.0.0 3,659 9/4/2023
11.0.2 150 9/4/2023
11.0.1 3,436 4/28/2023
11.0.0 157 4/28/2023
10.0.2 737 9/4/2023
10.0.1 708 4/28/2023
10.0.0 156 4/28/2023
4.0.0 19,981 9/28/2021
4.0.0-rc-004 273 9/24/2021
3.1.4 9,020 10/7/2020
3.1.3 445 10/7/2020
3.0.0 546 9/14/2020
2.1.2 6,156 4/20/2020
2.1.1 2,226 1/10/2020
2.1.0 549 12/16/2019
2.0.2 2,279 7/16/2019
2.0.1 499 6/27/2019
1.0.7 2,270 3/14/2019
1.0.6 1,425 9/7/2018
1.0.5 873 8/27/2018
1.0.4 921 8/26/2018
1.0.3 885 8/26/2018
1.0.2 855 8/26/2018
1.0.1 874 8/26/2018
1.0.0 853 8/26/2018