Nikcio.UHeadless.Members
4.2.1
See the version list below for details.
dotnet add package Nikcio.UHeadless.Members --version 4.2.1
NuGet\Install-Package Nikcio.UHeadless.Members -Version 4.2.1
<PackageReference Include="Nikcio.UHeadless.Members" Version="4.2.1" />
paket add Nikcio.UHeadless.Members --version 4.2.1
#r "nuget: Nikcio.UHeadless.Members, 4.2.1"
// Install Nikcio.UHeadless.Members as a Cake Addin #addin nuget:?package=Nikcio.UHeadless.Members&version=4.2.1 // Install Nikcio.UHeadless.Members as a Cake Tool #tool nuget:?package=Nikcio.UHeadless.Members&version=4.2.1
Nikcio.UHeadless
Welcome to Nikcio.UHeadless, a powerful package that enables you to create a headless GraphQL interface for your Umbraco CMS. This package provides an easy to setup solution for exposing your data and offers a wide range of extensibility options to tailor the headless functionality to your specific needs.
Compatibility
The Nikcio.UHeadless package is compatible with the following Umbraco versions:
Umbraco version | Supported Version |
---|---|
Umbraco 10 | v3.x.x |
Umbraco 12 | v4.x.x |
Umbraco 13 | v4.2.x+ |
For more information, please refer to the Versioning section.
Setup
Installation
To install the Nikcio.UHeadless package, run the following command:
dotnet add Nikcio.UHeadless
You can also find the package on NuGet.
Integration
To integrate the package into your project, follow these steps:
Open your
Startup.cs
file.Add the following using statement:
using Nikcio.UHeadless.Extensions;
In the
ConfigureServices
method, add the following code:public void ConfigureServices(IServiceCollection services) { services.AddUmbraco(_env, _config) /* Code omitted for clarity */ .AddUHeadless() /* Code omitted for clarity */ }
In the
Configure
method, add the following code:public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { /* Code omitted for clarity */ app.UseUHeadlessGraphQLEndpoint(); app.UseUmbraco() /* etc... */ }
With these configurations in place, your content will be available at /graphql
. To get started, try adding some content to the root and run the following query:
{
contentAtRoot {
nodes {
id,
name
}
}
}
Documentation
For detailed documentation and usage instructions, please refer to the Nikcio.UHeadless Documentation.
Extending Packages
Nikcio.UHeadless offers various packages for extending its functionality. The following table lists the available packages and their current status:
Package Name | Status |
---|---|
Nikcio.UHeadless.Content | Included* |
Nikcio.UHeadless.Media | Included* |
Nikcio.UHeadless.ContentTypes | Included* |
Nikcio.UHeadless.Members | Available |
Nikcio.UHeadless.DataTypes | Not started |
Nikcio.UHeadless.Dictionary | Not started |
Nikcio.UHeadless.MediaTypes | Not started |
Nikcio.UHeadless.MemberTypes | Not started |
*Included indicates that the package is included in the Nikcio.UHeadless NuGet package.
**Preview indicates that the package is available in a preview version.
Please note that if a Nikcio.UHeadless.* package is not listed above, it either means that the package is not ready for use or it is a core/base package used in the packages mentioned above.
Versioning
Nikcio.UHeadless follows the principles of Semantic Versioning to ensure consistency. The version numbers have the following meaning:
vX.Y.Z
- X (Major): Indicates a breaking change.
- Y (Minor): Signifies a feature change.
- Z (Patch): Represents bug fixes.
Full version table
Umbraco version | Supported Versions | Development |
---|---|---|
Umbraco 9 | v1.x.x & v2.x.x | No development |
Umbraco 10 | v2.x.x & v3.x.x | Only reported issues for v3.x.x |
Umbraco 11 | v3.x.x & v4.x.x | No development |
Umbraco 12 | v4.x.x | Only reported issues for v4.x.x |
Umbraco 13 | v4.2.x+ | Active branch |
Contributing
We welcome contributions to Nikcio.UHeadless. Please refer to the Contributing Guide for more information on how to get involved.
Sponsor Nikcio.UHeadless Development
If you find Nikcio.UHeadless valuable and would like to support its ongoing development, consider sponsoring the project through GitHub Sponsors. Your sponsorship helps ensure the continued improvement and maintenance of this package. Thank you for your support!
Product | Versions 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. |
-
net7.0
- Nikcio.UHeadless.Base (>= 4.2.1)
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 | |
---|---|---|---|
5.0.0-preview001 | 109 | 9/4/2023 | |
4.2.2 | 79 | 8/29/2024 | |
4.2.1 | 119 | 4/9/2024 | |
4.2.0 | 97 | 4/6/2024 | |
4.2.0-preview002 | 73 | 3/7/2024 | |
4.1.1 | 177 | 8/2/2023 | |
4.1.0 | 151 | 7/2/2023 | |
4.0.0 | 141 | 6/12/2023 | |
4.0.0-preview002 | 94 | 6/7/2023 | |
4.0.0-preview001 | 103 | 6/6/2023 | |
3.3.1 | 135 | 6/2/2023 | |
3.3.0 | 397 | 1/18/2023 | |
3.2.0 | 322 | 11/22/2022 | |
3.1.0 | 323 | 11/16/2022 | |
3.0.6 | 368 | 11/3/2022 | |
3.0.5 | 367 | 10/18/2022 | |
3.0.4 | 395 | 10/5/2022 | |
3.0.3 | 381 | 10/5/2022 | |
3.0.2 | 438 | 9/19/2022 | |
3.0.1 | 433 | 9/3/2022 | |
3.0.0 | 466 | 8/3/2022 | |
3.0.0-preview003 | 133 | 8/3/2022 | |
3.0.0-preview002 | 190 | 7/16/2022 |