在前端开发中，我们经常需要在项目中使用各种各样的第三方包，npm（Node Package Manager）是 JavaScript 应用程序的包管理器，提供数以十万计的包供我们使用。其中一个非常有用的 npm 包是 grateful，它是一个用于在页面上展示文字感谢列表的库，可以让我们在页面中方便的显示对项目贡献者的感谢。
在这篇文章中，我们将学习如何在项目中使用 grateful。
安装 grateful
在使用 grateful 之前，我们先需要通过 npm 安装该包。在终端中输入以下命令即可安装：
npm install grateful --save
其中 --save 参数表示将包添加到项目的 package.json 文件中，确保在项目构建时该包也能被安装。
使用 grateful
安装完成后，我们可以在项目中引用 grateful 包。在需要使用的页面或组件中，可以使用以下代码：
import Grateful from 'grateful';
然后在页面中添加一个简单的 HTML 结构作为容器：
<div id="grateful-list-container"></div>
接下来我们就可以创建一个感谢列表了：
-- -------------------- ---- -------
----- ------------ - --- ----------------------------------- -
------------- -
- ----- ----- ------- ------------------------------------ --
- ----- ----- ------- ------------------------------------ --
- ----- ----- ------- ------------------------------------ --
--
------ ----------
---------- -----
--------- --
-------- -------
---------- ------
------------------ -----
---以上代码中，我们实例化了一个 gratefulList 对象，将其渲染到 id 为 grateful-list-container 的容器中；并设置了相关配置项，包括 contributors（贡献者名单）、title（列表标题）、showCount（是否显示总数）、maxCount（最多显示多少项）、orderBy（按照哪一列进行排序）、direction（排序方向）、animationDuration（动画时长）等。
执行以上代码，我们就可以在页面上看到一个感谢列表，效果如下图所示：
grateful 配置项详解
在上面的代码中，我们设置了一些 grateful 的配置项。下面我们来逐一详解一下：
contributors
贡献者数组，每个元素需要包含 name 和 avatar 两个属性。
title
列表标题，可选项，默认为空。
showCount
是一个布尔值，控制是否显示贡献者总数，可选项，默认为 true。
maxCount
最大显示数量，即总贡献者列表中显示的最大项数，可选项，默认为 5。
orderBy
按照哪一列进行排序，支持 'name' 和 'date' 两个值，可选项，默认为 'name'。
direction
排序方向，支持 'asc' 和 'desc' 两个值，可选项，默认为 'desc'。
animationDuration
动画时长，以毫秒为单位，可选项，默认为 500。
grateful 方法详解
除了以上的配置项，grateful 还有一些方法可供我们调用：
addContributor(contributor)
向列表中添加一个贡献者，contributor 是一个对象，包含 name 和 avatar 属性。
gratefulList.addContributor({ name: '小张', avatar: 'https://www.example.com/avatar.png' });clearContributors()
清空列表中所有贡献者。
gratefulList.clearContributors();
destroy()
将列表从页面中移除并销毁 grateful 对象。
gratefulList.destroy();
总结
在本篇文章中，我们学习了如何使用 npm 包 grateful，在页面中展示感谢列表。除了介绍 grateful 的基本使用方法和配置项，还详细解释了 grateful 的各种方法。希望通过本篇教程，读者能够更好地理解 grateful 的使用方法，并掌握它在项目中的实际应用场景。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056ccd81e8991b448e6577