ChameleonForms 技术文档

1. 安装指南

ChameleonForms 是一个用于 ASP.NET Core MVC 的表单构建库，旨在减少构建表单时的重复劳动。以下是安装指南：

1. 使用 NuGet 包管理器安装 ChameleonForms。在您的项目中执行以下命令：

   Install-Package ChameleonForms -pre
   

   注意：当前版本标记为预发布版本，因此需要包含 -pre 标志。

2. 在 Startup.cs 文件中注册 ChameleonForms：

   public void ConfigureServices(IServiceCollection services)
   {
       ...
       services.AddMvc(...);
       ...
       services.AddChameleonForms();
   }
   

3. 在 _ViewImports.cshtml 文件中添加以下内容：

   @using ChameleonForms
   @using ChameleonForms.Enums
   @using ChameleonForms.Component
   
   @addTagHelper ChameleonForms.TagHelpers.*, ChameleonForms
   
   @* 可选：*
   @addTagHelper ChameleonForms.Templates.TwitterBootstrap3.*, ChameleonForms
   

2. 项目的使用说明

ChameleonForms 通过模型驱动默认值、扩展 ASP.NET Core MVC 的最佳特性、DRY（Don't Repeat Yourself）原则、一致性、声明式语法、优雅的 API 和可扩展性等哲学来简化表单的构建过程。

以下是一个创建表单的基本示例：

~/Controllers/MyFormController.cs：

using System;
using System.ComponentModel.DataAnnotations;
using Microsoft.AspNetCore.Mvc;

namespace MyWebApp.Controllers
{
    public class MyFormViewModel
    {
        [Required]
        public string Name { get; set; }

        public int FavouriteNumber { get; set; }

        [DisplayFormat(DataFormatString = "{0:d/M/yyyy}", ApplyFormatInEditMode = true)]
        public DateTime DateOfBirth { get; set; }
    }
    public class MyFormController : Controller
    {
        public IActionResult Index()
        {
            return View();
        }

        [HttpPost]
        public IActionResult Index(MyFormViewModel vm)
        {
            if (ModelState.IsValid)
            {
                // 执行操作
                return RedirectToAction("Index");
            }
            return View(vm);
        }
    }
}

~/Views/MyForm/Index.cshtml：

@model MyWebApp.Controllers.ViewModel
 @{
    ViewData["Title"] = "我的表单";
 }

 <chameleon-form>
    <form-section heading="关于你">
        <field for="Name" />
        <field for="FavouriteNumber" />
        <field for="DateOfBirth" />
    </form-section>
    <form-navigation>
        <submit-button label="提交" />
    </form-navigation>
 </chameleon-form>

 @section Scripts
 {
     <partial name="_ValidationScriptsPartial" />
     @* ... 或相关的等效内容 *@
 }

3. 项目API使用文档

ChameleonForms 提供了一套丰富的 API，用于创建和管理表单。以下是一些核心 API 的使用示例：

• BeginChameleonForm()：开始创建一个 ChameleonForms 表单。
• BeginSection(string heading)：开始一个表单区域，可以设置标题。
• FieldFor<TProperty>(Expression<Func<TModel, TProperty>> expression)：创建一个表单字段，基于模型属性。
• SubmitButton(string label)：创建一个提交按钮。

更多 API 文档和示例，请参考官方文档。

4. 项目安装方式

除了通过 NuGet 包管理器安装外，您还可以通过以下方式安装 ChameleonForms：

• 手动下载并引用 DLL 文件。
• 使用包管理工具，如 Paket 或其他兼容的工具。

确保在安装后正确配置 _ViewImports.cshtml 文件，并按照上述步骤注册 ChameleonForms。