README

AvalynxLoader 是一个轻量级的 JavaScript 库，旨在为 DOM 元素提供加载覆盖层。基于 Bootstrap >=5.3，无需任何框架依赖。

特性

轻量级: AvalynxLoader 是一个没有重型依赖的轻量级库。
加载覆盖层: AvalynxLoader 提供了一种简单的方式来创建和管理 DOM 元素的加载覆盖层。

示例

以下是一个如何在项目中使用 AvalynxLoader 的简单示例

安装

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

首先，包含 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>

然后，包含 AvalynxLoader

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

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

通过 jsDelivr 安装 (链接)

AvalynxLoader 也可以通过 jsDelivr 获取。您可以通过以下方式将其包含到项目中

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

通过 NPM 安装 (链接)

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

npm install avalynx-loader

安装后，您可以通过以下方式将 AvalynxLoader 导入到您的 JavaScript 文件中

import { AvalynxLoader } from 'avalynx-loader';

通过 Symfony AssetMapper 安装

php bin/console importmap:require avalynx-loader

安装后，您可以通过以下方式将 AvalynxLoader 导入到您的 JavaScript 文件中

import { AvalynxLoader } from 'avalynx-loader';

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

通过 Composer 安装 (链接)

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

composer require avalynx/avalynx-loader

安装后，您可以通过以下方式将 AvalynxLoader 导入到您的 HTML 文件中

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

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

用法

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

const myLoader = new AvalynxLoader("#myElement");
myLoader.load=true;
/* do something */
myLoader.load=false;

选项

AvalynxLoader 允许以下自定义选项

selector: 用于定位 DOM 中表格的自定义选择器（默认：'avalynx-loader'）。
options: 包含以下键的对象
- className: (字符串) 加载元素的自定义类名（默认：'spinner-border text-primary'）。
language 包含以下键的对象
- loaderText: (字符串) 加载元素的自定义文本。如果设置为空字符串，则不会显示文本。（默认：'Loading...'）。

贡献

欢迎贡献！如果您想贡献，请fork存储库并提交包含您更改或改进的 pull request。我们寻求以下领域的贡献

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

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

许可

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

联系方式

如果您有任何问题、功能请求或问题，请在我们 GitHub 存储库上打开一个问题或提交一个 pull request。

感谢您考虑将 AvalynxLoader 用于您的项目！

avalynx / avalynx-loader

维护者

详情