Nikcio.UHeadless 3.0.0-preview001

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
This is a prerelease version of Nikcio.UHeadless.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Nikcio.UHeadless --version 3.0.0-preview001
                    


                    

                
NuGet\Install-Package Nikcio.UHeadless -Version 3.0.0-preview001
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="Nikcio.UHeadless" Version="3.0.0-preview001" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Nikcio.UHeadless" Version="3.0.0-preview001" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Nikcio.UHeadless" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Nikcio.UHeadless --version 3.0.0-preview001
                    


                    

                
#r "nuget: Nikcio.UHeadless, 3.0.0-preview001"
#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. 
#addin nuget:?package=Nikcio.UHeadless&version=3.0.0-preview001&prerelease
                    


                            Install Nikcio.UHeadless as a Cake Addin
                        

                    

                
#tool nuget:?package=Nikcio.UHeadless&version=3.0.0-preview001&prerelease
                    


                            Install Nikcio.UHeadless as a Cake Tool

Nikcio.UHeadless

Logo

Codacy Badge Maintainability Build UHeadless Nuget Downloads Nuget Version Nuget (with prereleases)

This repository creates an easy setup solution for making Umbraco headless. It comes with a wide range of extensibility options that can be tailored to your needs.

Works on

  • Umbraco 9 (v1.x.x & v2.x.x)
  • Umbraco 10 (v2.x.x & v3.x.x)

See more under Versioning

Setup

To get started, add the following to your Startup.cs.

using Nikcio.UHeadless.Extensions;

public void ConfigureServices(IServiceCollection services)
        {
            services.AddUmbraco(_env, _config)
                /* Code obmitted for clarity */
                .AddUHeadless()
                /* Code obmitted for clarity */
        }

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    /* Code obmitted for clarity */

    app.UseUHeadlessGraphQLEndpoint();

    app.UseUmbraco()
    /* etc... */
}

Now your content will be avalible at /graphql

To get started try adding some content to the root and run the following query:

{
  contentAtRoot {
    nodes {
      id,
      name
    }
  }
}

Documentation

Find the docs here

Versioning

UHeadless following to the best of abillity Semantic Versioning. This means that the version numbers have the following meaning

vX.Y.Z

  • X (Major - Breaking change)
  • Y (Minor - Feature change)
  • Z (Patch - Bug fixes)

This also means that versions doesn't follow Umbracos major versions. To avoid supporting to many major versions the following versioning tactic has been choosen.

Versioning tactic

Each Umbraco LTS version will have a accompanying LTS UHeadless version. All other UHeadless majors not marked as LTS will stop support when a new major is released. In this way you as a developer can choose how often you expect to be updating UHeadless and Umbraco.

The two versioning tracks can be found in the table here:

Track UHeadless version Supported Umbraco version
LTS v3.x.x v10.x.x
Edge v3.x.x v10.x.x
Current stable v2.x.x v9.x.x & v10.x.x

Do note that LTS versions will not actively get new featues but will be bugfixed when a newer major is present

Contributing

This package is very much open for contribution see the Contributing Guide

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Nikcio.UHeadless:

Package Downloads
Nikcio.UHeadless.Defaults

Default models for the Nikcio.UHeadless package

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.0.0 165 3/22/2025
8.0.0-preview001 94 2/12/2025
7.1.0 508 2/14/2025
7.0.1 153 12/30/2024
6.0.0 135 11/20/2024
6.0.0-preview001 102 8/29/2024
5.1.0 347 11/20/2024
5.0.0 711 6/26/2024
5.0.0-preview005 101 6/9/2024
5.0.0-preview004 134 5/6/2024
5.0.0-preview003 125 4/12/2024
4.2.2 199 8/29/2024
4.2.1 1,858 4/9/2024
4.2.0 130 4/6/2024
4.2.0-preview002 120 3/7/2024
4.1.1 5,604 8/2/2023
4.1.0 457 7/2/2023
4.0.0 3,407 6/12/2023
4.0.0-preview002 152 6/7/2023
4.0.0-preview001 130 6/6/2023
3.3.1 965 6/2/2023
3.3.0 4,835 1/18/2023
3.2.0 5,369 11/22/2022
3.1.0 411 11/16/2022
3.0.6 538 11/3/2022
3.0.5 529 10/18/2022
3.0.4 784 10/5/2022
3.0.3 455 10/5/2022
3.0.2 506 9/19/2022
3.0.1 504 9/3/2022
3.0.0 873 8/3/2022
3.0.0-preview003 193 8/3/2022
3.0.0-preview002 210 7/16/2022
3.0.0-preview001 192 7/16/2022
2.3.1 274 6/2/2023
2.3.0 691 7/6/2022
2.2.1 562 6/19/2022
2.2.0 829 6/6/2022
2.1.1 559 5/22/2022
2.1.0 598 5/10/2022
2.0.2 533 5/9/2022
2.0.1 538 5/4/2022
2.0.0 590 5/1/2022
2.0.0-preview.3 146 4/26/2022
2.0.0-preview.2 144 4/26/2022
2.0.0-preview.1 172 4/24/2022
2.0.0-preview.0 149 4/14/2022
1.3.0 710 3/5/2022
1.2.0 626 3/1/2022
1.1.0 587 2/26/2022
1.0.0 669 2/6/2022
0.1.7-beta 181 2/5/2022
0.1.6-beta 193 2/5/2022
0.1.5-beta 195 2/4/2022
0.1.4-beta 209 1/27/2022
0.1.3-beta 213 1/27/2022
0.1.2-alpha 204 1/25/2022