jQuery ProfanityFilter 使用教程

jQuery ProfanityFilter 使用教程

jQuery.ProfanityFilterfilter out profane words on the client项目地址:https://gitcode.com/gh_mirrors/jq/jQuery.ProfanityFilter

1. 项目的目录结构及介绍

jQuery.ProfanityFilter/
├── LICENSE
├── README.md
├── bower.json
├── jquery.profanityfilter.js
├── jquery.profanityfilter.min.js
├── package.json
└── swearWords.json

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• bower.json: Bower 包管理配置文件。
• jquery.profanityfilter.js: 插件的主文件，包含完整的源代码。
• jquery.profanityfilter.min.js: 插件的压缩版本，用于生产环境。
• package.json: npm 包管理配置文件。
• swearWords.json: 包含需要过滤的脏话列表。

2. 项目的启动文件介绍

项目的启动文件是 jquery.profanityfilter.js 和 jquery.profanityfilter.min.js。这两个文件是 jQuery 插件的主文件，分别包含完整的源代码和压缩版本。

使用方法

在 HTML 文件中引入 jQuery 和 jquery.profanityfilter.js 或 jquery.profanityfilter.min.js：

<script src="https://code.jquery.com/jquery-1.7.1.min.js"></script>
<script src="jquery.profanityfilter.min.js"></script>

然后，在 JavaScript 代码中初始化插件：

$(document).ready(function() {
    $('#SomeElement').profanityFilter({
        customSwears: ['shit'],
        externalSwears: '/Path/To/Json/Swears/'
    });
});

3. 项目的配置文件介绍

项目的配置文件主要是 bower.json 和 package.json。

bower.json

bower.json 是 Bower 包管理工具的配置文件，包含项目的基本信息和依赖项：

{
  "name": "jquery-profanityfilter",
  "version": "1.0.0",
  "main": "jquery.profanityfilter.js",
  "dependencies": {
    "jquery": ">=1.7.1"
  }
}

package.json

package.json 是 npm 包管理工具的配置文件，包含项目的基本信息和依赖项：

{
  "name": "jquery-profanityfilter",
  "version": "1.0.0",
  "main": "jquery.profanityfilter.js",
  "dependencies": {
    "jquery": ">=1.7.1"
  }
}

这两个文件主要用于项目的依赖管理和版本控制。

---

以上是 jQuery ProfanityFilter 插件的基本使用教程，包括项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

jQuery.ProfanityFilterfilter out profane words on the client项目地址:https://gitcode.com/gh_mirrors/jq/jQuery.ProfanityFilter