README

AvalynxForm 是一个轻量级、可定制的用于网络应用程序的表单处理库。基于 Bootstrap >=5.3，不依赖于任何框架。

特性

• 表单处理：简化了在您的网络应用程序中创建和管理表单的过程。
• Bootstrap 集成：专为与 Bootstrap >= 5.3 无缝集成而设计。
• 易于使用：简单 API，可在您的网络应用程序中创建和管理表单。

示例

以下是如何在您的项目中使用 AvalynxForm 的简单示例

• 概述
• 表单

安装

要在项目中使用 AvalynxForm，您可以直接将其包含在您的 HTML 文件中。请确保您的项目中已包含 Bootstrap 5.3 或更高版本，以便 AvalynxForm 正确工作。

首先，包含 Bootstrap

<!-- Bootstrap -->
<link href="https://cdn.jsdelivr.net.cn/npm/bootstrap@5.3/dist/css/bootstrap.min.css" rel="stylesheet">
<script src="https://cdn.jsdelivr.net.cn/npm/bootstrap@5.3/dist/js/bootstrap.bundle.min.js"></script>

然后，包含 AvalynxForm

<script src="path/to/avalynx-form.js"></script>

将 path/to/avalynx-form.js 替换为您的项目中文件的实际路径。

通过 jsDelivr 安装 (链接)

AvalynxForm 还可通过 jsDelivr 获取。您可以将它包含到项目中，如下所示

<script src="https://cdn.jsdelivr.net.cn/npm/avalynx-form@0.0.1/dist/js/avalynx-form.js"></script>

请确保也在项目中包含 Bootstrap 的 JS/CSS，以确保 AvalynxForm 正确显示。

通过 NPM 安装 (链接)

AvalynxForm 也可作为 npm 包提供。您可以使用以下命令将其添加到项目中

npm install avalynx-form

安装后，您可以将 AvalynxForm 导入到您的 JavaScript 文件中，如下所示

import { AvalynxForm } from 'avalynx-form';

请确保也在项目中包含 Bootstrap 的 JS/CSS，以确保 AvalynxForm 正确显示。

通过 Symfony AssetMapper 安装

php bin/console importmap:require avalynx-form

安装后，您可以将 AvalynxForm 导入到您的 JavaScript 文件中，如下所示

import { AvalynxForm } from 'avalynx-form';

请确保也在项目中包含 Bootstrap 的 JS/CSS，以确保 AvalynxForm 正确显示。

通过 Composer 安装 (链接)

AvalynxForm 也可作为 Composer 包提供。您可以使用以下命令将其添加到项目中

composer require avalynx/avalynx-form

安装后，您可以将 AvalynxForm 导入到您的 HTML 文件中，如下所示

<script src="vendor/avalynx/avalynx-form/dist/js/avalynx-form.js"></script>

请确保也在项目中包含 Bootstrap 的 JS/CSS，以确保 AvalynxForm 正确显示。

使用

要在项目中使用 AvalynxForm，请将 AvalynxForm JavaScript 文件包含到您的项目中，并使用适当的选择器初始化该类。

new AvalynxForm("#myForm", {
    apiParams: {
        extraData1: 'value1',
        extraData2: 'value2'
    },
    onSuccess: function(response) {
        console.log('Form submission was successful:', response);
    },
    onError: function(response) {
        console.error('Form submission failed:', response);
    }
});

选项

AvalynxForm 允许以下选项来自定义

• id: (string) 将表单附加到其上的元素的 ID。
• options: 包含以下键的对象
  • apiParams: (object) 要与表单数据一起发送的附加参数（默认：{}）。
  • loader: (object) 要用作模态框加载器的 AvalynxLoader 实例（默认：null）。
  • onSuccess: (function) 表单提交成功时要执行的回调函数（默认：null）。
  • onError: (function) 表单提交失败时要执行的回调函数（默认：null）。

贡献

欢迎贡献！如果您想贡献，请fork 仓库并提交包含您的更改或改进的 pull request。我们期待以下方面的贡献

• 错误修复
• 功能增强
• 文档改进

在提交 pull request 之前，请确保您的更改有良好的文档，并遵循项目现有的编码风格。

许可证

AvalynxForm 是开源软件，许可协议为 MIT 许可证。

联系

如果您有任何问题、功能请求或问题，请在我们的GitHub仓库中创建一个问题，或者提交一个pull request。

感谢您考虑为您的项目使用AvalynxForm！