Skip to content

Commit 8cf6c1f

Browse files
committed
Update README.md with info about the v4 alpha
1 parent 5fd25e8 commit 8cf6c1f

1 file changed

Lines changed: 31 additions & 5 deletions

File tree

README.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,41 @@ Umbraco 14+ no longer supports Nested Content and the Backoffice is completely r
2727

2828
The next major version of ContentBlocks - `v4` - will transition from Nested Content as the underlying data storage to Umbraco's Block Editor technology which is used in Block List + Block Grid. In addition we will migrate the property editor UI in the Backoffice from AngularJS to Web Components. ContentBlocks v4 will no longer support Umbraco v10-v13.
2929

30-
Because Umbraco is planning to introduce [Block Level Variations in v15](https://github.com/umbraco/Announcements/issues/16) which requires breaking changes to the Block data structure and other Block related code ContentBlocks v4 will target Umbraco v15 or v16, skipping v14 entirely. The current (unstable) state of v14 contributes to this idea too as it is unlikely many companies want to use v14 in production at the moment.
30+
Because Umbraco is planning to introduce [Block Level Variations in v15](https://github.com/umbraco/Announcements/issues/16) which requires breaking changes to the Block data structure and other Block related code ContentBlocks v4 will target Umbraco v16+, skipping v14 entirely. The current (unstable) state of v14 contributes to this idea too as it is unlikely many companies want to use v14 in production at the moment.
3131

32-
ContentBlocks v4 will automatically migrate property data of ContentBlocks v1 - v3 to v4. This is necessary for any websites that upgrade from Umbraco 8-13 to 15+ and have existing ContentBlocks property data. This data needs to be migrated from the Nested Content format to the new Block Editor format. Both editors use Element Types which means the actual property data is the same but they use a different wrapper structure around it so that will have to be migrated.
32+
ContentBlocks v4 will automatically migrate property data of ContentBlocks v1 - v3 to v4. This is necessary for any websites that upgrade from Umbraco 8-13 to 16+ and have existing ContentBlocks property data. This data needs to be migrated from the Nested Content format to the new Block Editor format. Both editors use Element Types which means the actual property data is the same but they use a different wrapper structure around it so that will have to be migrated.
3333

34-
Until ContentBlocks v4 is out Umbraco 15+ is not supported.
34+
Until ContentBlocks v4 is out Umbraco 16+ is not supported.
3535

36-
ContentBlocks v4 was originally scheduled for release at the end of 2024 but we need more time.
36+
ContentBlocks v4 was originally scheduled for release at the end of 2024 but we need more time.
3737

38-
When we have more information about a release date it will be posted here.
38+
### Update @ 2025-12-10
39+
40+
Version 4 is currently in alpha. The core features are implemented and the editor is usable. Content from a v13 or older installation is migrated when you run the v16+ website for the first time in v4. There are still some issues in the Lit backoffice UI code which is why there is no stable release out on NuGet. However, at Perplex we are using the latest alpha in our v16 and v17 websites that are in development without any major issues.
41+
42+
#### Get the alpha
43+
44+
If you want to test the alpha version you can build the NuGet packages from the source code.
45+
46+
Make sure `npm` is installed on your machine.
47+
48+
Then run this in **PowerShell**:
49+
50+
```
51+
git clone https://github.com/PerplexDigital/Perplex.ContentBlocks.git -b feature/v4
52+
cd .\Perplex.ContentBlocks\pkg
53+
.\pack.ps1
54+
explorer .
55+
```
56+
57+
This will open the "pkg" directory with the 3 NuGet files.
58+
Publish the resulting `.nupkg` files on an internal NuGet feed to be able to install them. It is also possible to create a NuGet feed in a directory on your local computer if you just want to test it locally:
59+
60+
`dotnet nuget add source D:\LocalNuGet -n LocalNuGet`
61+
62+
Put any `.nupkg` files in that directory and you can install them like any other NuGet packages in your websites.
63+
64+
Read about the API changes in v4 [in the preliminary v4 Release Notes](https://github.com/PerplexDigital/Perplex.ContentBlocks/blob/feature/v4/RELEASE_NOTES.md#v400---tbd).
3965

4066
## Umbraco 10+ / .NET 6+
4167

0 commit comments

Comments
 (0)