EasyAbp.DynamicForm.Application.Contracts

An ABP module helps users to define and use dynamic forms at runtime.


Keywords
abp, dynamic, dynamicform, easyabp, form, input, module
License
MIT
Install
Install-Package EasyAbp.DynamicForm.Application.Contracts -Version 1.7.0

Documentation

DynamicForm

ABP version NuGet NuGet Download Discord online GitHub stars

An ABP module helps users to define and use dynamic forms at runtime.

Installation

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

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

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

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

Usage

  1. Configure the module.

    Configure<DynamicFormOptions>(options =>
    {
        options.AddOrUpdateFormDefinition(new FormDefinition("InternalForm", "Internal Form"));
    });
    
    Configure<DynamicFormCoreOptions>(options =>
    {
        options.AddTextBoxFormItemType();
        options.AddOptionButtonsFormItemType();
        // Add any type you want, including your custom types....
    });
  2. (Optional) Create a custom FormTemplateOperationAuthorizationHandler to determine who can create/read/update/delete the form templates. ( see sample) Users who have EasyAbp.DynamicForm.FormTemplate.Manage permission can skip the check.

  3. (Optional) Create a custom FormOperationAuthorizationHandler to determine who can create/read/update/delete the forms. ( see sample) Users who have EasyAbp.DynamicForm.Form.Manage permission can skip the check.

  4. Try to create a form template.

  5. Try to create a form.

FormTemplates FormItemTemplates CreateFormItemTemplate Forms

Use the Dynamic Form Core Only

This way, we don't install the whole dynamic form module (no extra entities installed). Instead, we enhance the existing entities to support the dynamic forms feature.

  1. Install only the following modules:

    • EasyAbp.DynamicForm.Domain.Core
    • EasyAbp.DynamicForm.Domain.Shared
    • EasyAbp.DynamicForm.EntityFrameworkCore.Shared
  2. Make your entities contain the form item information.

    public class BookRental : AggregateRoot<Guid>
    {
        public string BookName { get; set; }
        public List<BookRentalFormItem> FormItems { get; set; } = new();
    }
    
    public class BookRentalFormItem : Entity, IFormItemMetadata
    {
        // properties...
    } 
    public class BookRentalRequest : AggregateRoot<Guid>
    {
        public Guid BookRentalId { get; set; }
        public Guid RenterUserId { get; set; }
        public List<BookRentalRequestFormItem> FormItems { get; set; } = new();
    }
    
    public class BookRentalRequestFormItem : Entity, IFormItem // implement IFormItemMetadata if need
    {
        // properties...
    } 
    protected override void OnModelCreating(ModelBuilder builder)
    {
        // ...
        builder.Entity<BookRentalFormItem>(b =>
        {
            b.ToTable(MyProjectConsts.DbTablePrefix + "BookRentalFormItems", MyProjectConsts.DbSchema);
            b.TryConfigureAvailableValues(); // add this configuration.
            b.ConfigureByConvention();
            b.HasKey(x => new { x.BookRentalId, x.Name });
        });
    }
  3. Validate when changing the form item templates.

    await dynamicFormValidator.ValidateTemplatesAsync(bookRental.FormItems);
  4. Validate when changing the form items.

    await dynamicFormValidator.ValidateValuesAsync(bookRental.FormItems, bookRentalRequest.FormItems);

Roadmap

  • Number input form item type.
  • Checkbox form item type.
  • Date picker form item type.
  • Listbox form item type.
  • Drop-down listbox form item type.