README

edwrodrig\js

用于简单页面的小型JavaScript前端库

我的使用案例

我是一个后端开发者，但无法避免处理网页。我讨厌当前的JavaScript前端开发技术，特别是javascript，这种语言的贾斯汀·比伯。但你可以避开它，它是浏览器语言！对我来说，越少的javascript越好。

我不想在我的代码中包含这些庞大的javascript库来完成简单任务。
我不想花时间去寻找在某个花哨框架中完成某事的最佳方式。
我不想在我的开发机器上安装nodejs或npm。
我想尽可能保持简单。

以下是该库包含的功能

客户端读取URL参数。
将HTML元素如输入或简单的div序列化为json，反之亦然。同时考虑嵌套结构。
淡入元素。
制作模态窗口。
加载HTML模板，考虑javascript和样式资源。
使针对我特定的json服务格式的ajax json请求更容易。
此库必须尽可能不侵入。

我在Ubuntu 16.04上的Firefox Quantum 60和我的Android设备上的Chrome移动版中测试了所有代码。我没有在其他平台上进行太多测试。我忽略了与旧浏览器（如IE）的向后兼容性。Safari是一个目标，但我没有针对它进行测试，因为我没有苹果电脑。我有时会使用其他基于webkit的浏览器，如Midori来复制报告的错误。

关于我的json请求

我的格式非常特殊。我不是RESTful的粉丝，因为它将json负载与HTTP状态和动词混合在一起。我喜欢所有信息都只以一种格式存在，这使你想要实施其他通信方式时（如原始TCP套接字）更容易。简单来说，我的格式只是在json中放入与HTTP状态对应的一些状态。下面是一个例子

{
    "status" : 1,
    "data" : {
      "name" : "Edwin",
      "surname" : "Rodriguez"
    }
}

我的请求实现仅进行POST调用，并方便地处理状态码以检索数据。这是我特定的情况，我认为没有人会使用它，但这是我的库。

文档

源代码使用jsDoc风格进行文档编写，因此如果您使用类似PhpStorm的IDE，它应该会很好地弹出。

示例

Composer

composer require edwrodrig/js

包含

鉴于这是一个JavaScript库，Composer只将文件下载到供应商目录。如何使用它在你的HTML页面中由你决定。我使用这个库的基本方法是创建到符号链接的链接到src文件夹，这样我就可以在目标HTML页面中包含这些文件。例如，请参见示例文件夹，其中包含到源文件夹的符号链接。

测试

测试是用QUnit构建的。我不知道它们是否可以自动化，但如果你只是运行测试页面，你将看到单元测试报告。这比没有好，而且在许多方面对我来说已经足够了。

许可证

MIT许可证。按照你自己的风险使用它。

关于语言

我不是一个英语母语者，所以文本中可能有大量的语法和拼写错误，我只是尽力而为。但请随意纠正我的语言，任何贡献都受欢迎，对我来说它们都是学习的实例。

edwrodrig / js

维护者

详细信息