DragonFly.BlockField.Core
0.9.14
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package DragonFly.BlockField.Core --version 0.9.14
NuGet\Install-Package DragonFly.BlockField.Core -Version 0.9.14
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="DragonFly.BlockField.Core" Version="0.9.14" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DragonFly.BlockField.Core --version 0.9.14
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: DragonFly.BlockField.Core, 0.9.14"
#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 DragonFly.BlockField.Core as a Cake Addin
#addin nuget:?package=DragonFly.BlockField.Core&version=0.9.14
// Install DragonFly.BlockField.Core as a Cake Tool
#tool nuget:?package=DragonFly.BlockField.Core&version=0.9.14
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
DragonFly - Headless CMS based on ASP.NET Core and Blazor
Package | Release |
---|---|
DragonFly.Core | |
DragonFly.AspNetCore | |
DragonFly.API | |
DragonFly.Client | |
DragonFly.BlockField | |
DragonFly.Proxy | |
DragonFly.ImageWizard | |
DragonFly.MongoDB | |
DragonFly.Identity | |
DragonFly.ApiKeys |
Getting started
Prerequisites
- .NET 7.0 SDK
- Visual Studio 2022
- MongoDB instance
Create a new project from template
To use the project template you need first to download and install it from NuGet.
dotnet new install DragonFly.Templates
After this you can create the project with:
dotnet new DragonFly
If you have a remote MongoDB instance, you need to add some appsettings:
"MongoDB": {
"Hostname": "localhost",
"Database": "DragonFly_App",
"Port": 27017,
"Username": "",
"Password": ""
},
DragonFly
Supported fields
- StringField
- FloatField
- BoolField
- AssetField
- ReferenceField
- ComponentField
- ArrayField
- DateField
- IntegerField
- ColorField
- GeoLocationField
- SlugField
- XmlField
- HtmlField
- BlockField (HeadingBlock, TextBlock, HtmlBlock, CodeBlock, ContainerBlock, ColumnBlock, AssetBlock, ReferenceBlock, GridBlock,..)
How to create new content schema and content item
IContentStorage contentStorage = ...;//use MongoStorage or ClientContentService (http client)
//create brand schema
ContentSchema schemaBrand = new ContentSchema("Brand")
.AddString("Name")
.AddSlug("Slug")
.AddTextArea("Description");
//Define schema for product
ContentSchema schemaProduct = new ContentSchema("Product")
.AddReference("Brand")
.AddString("Name", options => options.IsRequired = true)
.AddSlug("Slug")
.AddBool("IsAvailable", options => options.DefaultValue = true)
.AddFloat("Price")
.AddTextArea("Description", options => options.MaxLength = 255)
.AddArray("Attributes", options => options
.AddString("Name")
.AddString("Value"));
await contentStorage.CreateAsync(schemaProduct);
//create product by schema
ContentItem contentProduct = schemaProduct
.CreateContent()
.SetReference("Brand", new ContentItem(Guid.Parse(""), schemaBrand))
.SetString("Name", "ProductA")
.SetBool("IsAvailable", true)
.SetFloat("Price", 9.99)
.SetTextArea("Description", "...")
.AddArrayItem("Attributes", schemaProduct, item => item
.SetString("Name", "Size")
.SetString("Value", "M"));
await contentStorage.CreateAsync(contentProduct);
Create typed content
[ContentItem("BlogPost")]
public class BlogPostModel : EntityPageModel
{
[DateField(Required = true)]
public virtual DateTime? Date { get; set; }
[StringField(Required = true, Searchable = true, ListField = true, MinLength = 8, MaxLength = 512)]
public virtual string Title { get; set; }
[TextField]
public virtual string Description { get; set; }
[SlugField(Required = true, Index = true)]
public virtual string Slug { get; set; }
[AssetField(ListField = true, ShowPreview = true)]
public virtual AssetField Image { get; set; }
[BlockField]
public virtual BlockField MainContent { get; set; }
}
Register typed content
builder.Services.AddDragonFly()
.AddProxy(x => x.AddType<BlogPostModel>());
Use queries for typed content
//get first item
var first = await ContentStorage.FirstOrDefaultAsync<BlogPostModel>(x => x
.SlugQuery(x => x.Slug, slug));
//get all items
var result = await ContentStorage.QueryAsync<BlogPostModel>(x => x
.Published(true)
.Top(10)
.SlugQuery(x => x.Slug, slug));
BackgroundTask
For long running jobs you can use the BackgroundTaskManager.
IBackgroundTaskManager taskManager = app.Services.GetRequiredService<IBackgroundTaskManager>();
taskManager.Start("Test", async ctx => await Task.Delay(TimeSpan.FromSeconds(60), ctx.CancellationToken));
DragonFly.AspNetCore
builder.Services.Configure<DragonFlyOptions>(Configuration.GetSection("General"));
builder.Services.Configure<MongoDbOptions>(Configuration.GetSection("MongoDB"));
//add DragonFly services
builder.Services.AddDragonFly()
.AddImageWizard()
.AddRestApi()
.AddMongoDbStorage()
.AddMongoDbIdentity()
.AddBlockField()
.AddApiKeys();
var app = builder.Build();
//init DragonFly
await app.InitDragonFly();
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
app.UseWebAssemblyDebugging();
}
app.UseDragonFly(x => x
.MapImageWizard()
.MapApiKey()
.MapIdentity()
.MapRestApi()
.MapPermission());
app.UseDragonFlyManager();
app.UseRouting();
app.Run();
DragonFly.Client (Blazor)
var builder = WebAssemblyHostBuilder.CreateDefault(args);
builder.RootComponents.Add<DragonFly.App.Client.App>("app");
//Register DragonFly components
builder.AddDragonFly()
.AddRestApi()
.AddBlockField()
.AddIdentity()
.AddApiKeys();
WebAssemblyHost host = builder.Build();
await host.InitDragonFly();
await host.RunAsync();
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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net7.0
- DragonFly.Core (>= 0.9.14)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on DragonFly.BlockField.Core:
Package | Downloads |
---|---|
DragonFly.BlockField
Headless CMS based on ASP.NET Core and Blazor |
|
DragonFly.BlockField.Client
Headless CMS based on ASP.NET Core and Blazor |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.12 | 115 | 3/7/2024 |
1.0.11 | 123 | 3/7/2024 |
1.0.10 | 118 | 3/6/2024 |
1.0.9 | 135 | 3/3/2024 |
1.0.8 | 132 | 2/22/2024 |
1.0.7 | 158 | 2/7/2024 |
1.0.6 | 158 | 1/18/2024 |
1.0.5 | 228 | 12/18/2023 |
1.0.4 | 209 | 12/2/2023 |
1.0.3 | 168 | 11/30/2023 |
1.0.2 | 175 | 11/30/2023 |
1.0.1 | 167 | 11/30/2023 |
0.9.32 | 287 | 8/25/2023 |
0.9.31 | 296 | 7/27/2023 |
0.9.30 | 288 | 7/27/2023 |
0.9.22 | 304 | 6/30/2023 |
0.9.20 | 316 | 6/27/2023 |
0.9.19 | 332 | 6/22/2023 |
0.9.17 | 345 | 5/9/2023 |
0.9.16 | 357 | 4/28/2023 |
0.9.15 | 355 | 4/27/2023 |
0.9.14 | 345 | 4/27/2023 |
0.9.13 | 360 | 4/15/2023 |
0.9.12 | 400 | 3/19/2023 |
0.9.11 | 393 | 3/15/2023 |
0.9.10 | 408 | 3/5/2023 |
0.9.9 | 421 | 3/3/2023 |
0.9.8 | 404 | 3/2/2023 |
0.9.7 | 505 | 1/29/2023 |
0.9.6 | 479 | 1/27/2023 |
0.9.5 | 505 | 1/25/2023 |
0.9.3 | 484 | 1/2/2023 |
0.9.2 | 498 | 1/2/2023 |
0.9.0 | 498 | 12/28/2022 |