mirror of
https://github.com/halo-dev/docs.git
synced 2026-01-14 07:02:53 +08:00
daf93fb72c
### What this PR does? 添加插件 Finder API 中通过插件名称和版本判断某插件是否可用的 API 的文档 see also https://github.com/halo-dev/halo/pull/6236 ```release-note None ```
1.4 KiB
1.4 KiB
title, description
| title | description |
|---|---|
| 插件 | 插件 - PluginFinder |
available(pluginName)
pluginFinder.available(pluginName)
描述
判断一个插件是否可用，会同时判断插件是否安装和启用。
参数
pluginName:string- 插件的唯一标识metadata.name。
返回值
boolean - 插件是否可用
示例
<!-- https://github.com/halo-sigs/plugin-search-widget -->
<li th:if="${pluginFinder.available('PluginSearchWidget')}">
<a href="javascript:SearchWidget.open()" title="搜索">
搜索
</a>
</li>
available(pluginName, requiresVersion)
pluginFinder.available('fake-plugin', '>=2.3.0')
描述
判断一个插件是否可用，会同时判断插件是否安装和启用且插件的版本符合 requiresVersion 要求，
参数
pluginName:string- 插件的唯一标识metadata.name，不能为空。requiresVersion:string- 插件的版本要求，不能为空，例如：>1.2.0，requiresVersion的格式遵循 Semantic Range Expressions。
返回值
boolean - 插件是否可用
示例
<!-- https://github.com/halo-sigs/plugin-search-widget -->
<li th:if="${pluginFinder.available('PluginSearchWidget', '>=2.3.0')}">
<a href="javascript:SearchWidget.open()" title="搜索">
搜索
</a>
</li>