favicon.js 使用与技术文档

本文档将详细介绍如何安装、使用以及API调用方式来操作 favicon.js，这是一个用于改变网页图标的小型JavaScript库。

1. 安装指南

favicon.js 可以通过以下几种方式进行安装：

通过 CDN

直接在HTML文件中通过 <script> 标签引入最新开发版本或生产版本的 favicon.js：

<script src="https://unpkg.com/favicon.js"></script>
<!-- 或者 -->
<script src="https://unpkg.com/favicon.js/dist/favicon.min.js"></script>

通过 npm

在命令行中使用以下命令安装 favicon.js：

npm install favicon.js

或者使用 yarn：

yarn add favicon.js

2. 项目的使用说明

在页面中引入 favicon.js 之后，可以通过以下方式使用它来改变网页图标：

favicon.change(faviconUrl);
// 可以同时设置页面标题
favicon.change(faviconUrl, newTitle);

如果你想要动态切换多个图标，可以使用 animate 方法：

favicon.animate([array, of, urls]);
// 可以设置动画暂停时间
favicon.animate([array, of, urls], pauseLength); // 单位为毫秒

如果你想停止当前的动画，可以使用 stopAnimate 方法：

favicon.stopAnimate();

3. 项目API使用文档

以下为 favicon.js 的API文档：

• favicon.change(faviconUrl, [newTitle])：改变当前页面的favicon。可选的第二个参数可以用来同时设置新的页面标题。
• favicon.animate([array, of, urls], [pauseLength])：循环切换数组中的favicon URLs。可选的第二个参数用来设置每个图标显示的暂停时间（毫秒）。
• favicon.defaultPause：设置动画的默认暂停时间（毫秒）。
• favicon.stopAnimate()：停止当前的favicon动画。

4. 项目安装方式

favicon.js 的安装方式已在“安装指南”部分详细说明，可以通过CDN或npm进行安装。

---

本文档基于 favicon.js 的readme介绍和GitHub项目wiki编写，旨在帮助用户更好地理解和使用这个项目。