npm 包 wiki-plugin-fivestar 使用教程

简介

wiki-plugin-fivestar 是一个 npm 包，用于在 wiki 中添加评分系统。使用 fivestar 评分系统的用户可以简单快速地评价 wiki 中的条目。这个插件可以方便地自定义评级选项的数量、颜色和评分标准。

安装

首先，在终端中使用 npm 安装 wiki-plugin-fivestar：

npm install wiki-plugin-fivestar

安装完成后，在配置文件中添加以下行：

{
    …
    "plugins": [
        …,
        "wiki-plugin-fivestar"
    ]
    …
}

使用

添加评分系统

要在 wiki 中添加评分系统，只需在文章正文中添加以下标签：

<fivestar /><fivestar-rating />

<fivestar> 标签用于显示评分系统，<fivestar-rating> 标签用于显示当前的评分。

自定义评级选项

自定义评级选项可以通过以下属性进行设置：

• maxValue：设置评分系统的最大值，默认为 5。可以将其设为较高的数字以实现更精细的评分；
• colors：设置评分条的颜色。例如：

<fivestar showValue minValue="1" maxValue="5" colors="red:yellow:green" />

在这个例子中，1 显示为红色，3 显示为黄色，5 显示为绿色。您可以为每个颜色指定一个起始值和一个结束值。如果不指定结束值，则该选项将一直持续到下一个选项的开始。

设置评分格式

每个 wiki 都可以根据自己的需要自定义评分系统的格式。可以将评分格式设为任何组合。

必须在 <fivestar> 标记上使用以下属性来指定显示信息：

• numberFormat：将显示小数点后的位数。默认为 1；
• showValue：如果评分是非零值，则将显示评分。默认值为 true；
• minValue：将显示评分的最小值。默认为 0。

示例代码

自定义评级选项

<fivestar showValue minValue="1" maxValue="5" colors="red:yellow:green" />

设置评分格式

<fivestar showValue minValue="1" maxValue="5" colors="red:yellow:green" />
<fivestar-rating numberFormat="2" showValue />

结论

通过使用 npm 包 wiki-plugin-fivestar，您可以轻松地在 wiki 中添加评分系统。这个插件提供了广泛的自定义选项，使您可以根据自己的需要配置评分系统。如果您需要更详细的信息，请参阅 wiki-plugin-fivestar 的文档。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005598e81e8991b448d7253