Giter Club home page Giter Club logo

abp.entityui's Introduction

Abp.EntityUi

ABP version NuGet NuGet Download Discord online GitHub stars

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

Installation

  1. Follow the document to install the dependent Abp.DynamicMenu module.

  2. 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
  3. Add DependsOn(typeof(AbpEntityUiXxxModule)) attribute to configure the module dependencies. (see how)

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

  5. 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.

abp.entityui's People

Contributors

gdlcf88 avatar hueifeng avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

abp.entityui's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.