Skip to content
main
Switch branches/tags
Code

Abp.EntityUi

ABP version NuGet NuGet Download GitHub stars

An abp module that dynamically generates management UI for entities in runtime.

Online Demo

We have launched an online demo for this module: https://entityui.samples.easyabp.io

Installation

  1. Install the following NuGet packages. (see how)

    • EasyAbp.Abp.EntityUi.Application
    • EasyAbp.Abp.EntityUi.Application.Contracts
    • EasyAbp.Abp.EntityUi.Domain
    • EasyAbp.Abp.EntityUi.Domain.Shared
    • EasyAbp.Abp.EntityUi.EntityFrameworkCore
    • EasyAbp.Abp.EntityUi.HttpApi
    • EasyAbp.Abp.EntityUi.HttpApi.Client
    • EasyAbp.Abp.EntityUi.Web
  2. Add DependsOn(typeof(AbpEntityUiXxxModule)) attribute to configure the module dependencies. (see how)

  3. Add builder.ConfigureAbpEntityUi(); to the OnModelCreating() method in MyProjectMigrationsDbContext.cs.

  4. Add EF Core migrations and update your database. See: ABP document.

Usage

  1. Configure for the modules (or an app itself) you want to use EntityUi.

    public class MyProjectDomainModule : AbpModule
    {
        public override void ConfigureServices(ServiceConfigurationContext context)
        {
            // ...
    
            Configure<AbpEntityUiOptions>(options =>
            {
                options.Modules.Add("MyProject", new AbpEntityUiModuleOptions(typeof(MyProjectDomainModule)));
            });
    
            // ...
        }
    }
  2. Run the DbMigrator project, the EntityUi seed contributor will discovery the entities and seed the metadata.

  3. Run the app and log in as the admin user, you can see the "Entity UI" menu item, try to open it and change some entity configuration.

    EntityList

  4. Use the management pages for the entities you just configured:

    BookList EditBook

Q&A

How to package the EntityUi configurations for a module

  1. Export the configurations with the http API: /api/abp/entity-ui/integration/module/{moduleName} (GET).

  2. Create a JSON file like EntityUiSeed.json in your module project to save the exported data (see the demo) and set it as an EmbeddedResource.

  3. Configure the EntityUi to use it:

    public class MyProjectDomainModule : AbpModule
    {
        public override void PreConfigureServices(ServiceConfigurationContext context)
        {
            Configure<AbpEntityUiOptions>(options =>
            {
                options.Modules.Add(
                    "MyProject",
                    new AbpEntityUiModuleOptions(typeof(MyProjectDomainModule), "/EntityUiSeed.json")
                );
            });
            
            Configure<AbpVirtualFileSystemOptions>(options =>
            {
                options.FileSets.AddEmbedded<MyProjectDomainModule>();
            });
        }
    }

Entity UI for dynamic entities?

See the Entity UI dynamic entity provider document.

Road map

  • Detail modal.
  • Support dynamic entities.
  • Support the MVC template.
  • Support the Blazor template.
  • Support the Angular template.

About

An abp module that dynamically generates management UI for entities in runtime.

Resources

License