plugin-search-widget

Halo 2.0 的通用搜索组件插件。

使用方式

1. 下载，目前提供以下两个下载方式：
   • GitHub Releases：访问 Releases 下载 Assets 中的 JAR 文件。
   • Halo 应用市场：https://halo.run/store/apps/app-DlacW。
2. 安装，插件安装和更新方式可参考：https://docs.halo.run/user-guide/plugins。

需要注意的是，此插件需要主题进行适配，不会主动显示搜索入口。

开发环境

git clone git@github.com:halo-dev/plugin-search-widget.git

# 或者当你 fork 之后

git clone git@github.com:{your_github_id}/plugin-search-widget.git

cd path/to/plugin-search-widget

./gradlew pnpmInstall

./gradlew build

修改 Halo 配置文件：

halo:
  plugin:
    runtime-mode: development
    classes-directories:
      - "build/classes"
      - "build/resources"
    lib-directories:
      - "libs"
    fixedPluginPath:
      - "/path/to/plugin-search-widget"

主题适配

调用搜索弹框

此插件是一个通用的搜索框插件，主题需要做的只是通过 JS API 唤起搜索框即可，以下是代码示例：

<li th:if="${pluginFinder.available('PluginSearchWidget')}">
  <a href="https://github.com/halo-dev/plugin-search-widget/blob/main/javascript:SearchWidget.open()" title="搜索">
    搜索
  </a>
</li>

其中，pluginFinder.available('PluginSearchWidget') 的作用是判断使用者是否安装和启用了此插件，如果没有安装或者没有启用，那么就不会显示搜索入口。

自定义样式

虽然目前不能直接为搜索组件编写额外的样式，但可以通过一系列的 CSS 变量来自定义部分样式，开发者可以根据需求自行在主题中添加这些 CSS 变量，让搜索组件和主题更好地融合。

目前已提供的 CSS 变量：

配色切换方案

根据上面提供的 CSS 变量，也可以通过定义 CSS 变量的方式为搜索组件提供动态切换配色的功能。

以下是实现示例，你可以根据需求自行修改选择器或者媒体查询。

@media (prefers-color-scheme: dark) {
  .color-scheme-auto,
  [data-color-scheme='auto'] {
    color-scheme: dark;
    --halo-search-widget-muted-color: #cbd5e1;
    --halo-search-widget-content-color: #f1f5f9;
    --halo-search-widget-hit-bg-color: #090a11;
    --halo-search-widget-modal-bg-color: #15172a;
    --halo-search-widget-modal-layer-color: #000000cc;
    --halo-search-widget-base-bg-color: #090a11;
    --halo-search-widget-divider-color: #1e293b;
    --halo-search-widget-kbd-border-color: #334155;
    --halo-search-widget-kbd-shadow: 0px 2px 0px 0px #ffffff1a;
  }
}

.color-scheme-dark,
.dark,
[data-color-scheme='dark'] {
  color-scheme: dark;
  --halo-search-widget-muted-color: #cbd5e1;
  --halo-search-widget-content-color: #f1f5f9;
  --halo-search-widget-hit-bg-color: #090a11;
  --halo-search-widget-modal-bg-color: #15172a;
  --halo-search-widget-modal-layer-color: #000000cc;
  --halo-search-widget-base-bg-color: #090a11;
  --halo-search-widget-divider-color: #1e293b;
  --halo-search-widget-kbd-border-color: #334155;
  --halo-search-widget-kbd-shadow: 0px 2px 0px 0px #ffffff1a;
}

此外，为了让主题可以更加方便的适配暗黑模式，此插件也提供了一套暗黑模式的配色方案，主题可以直接使用此方案，而不需要自己去适配暗黑模式，适配方式如下：

1. 在 html 或者 body 标签添加 class：
   1. color-scheme-auto：自动模式，根据系统的暗黑模式自动切换。
   2. color-scheme-dark / dark：强制暗黑模式。
   3. color-scheme-light / light：强制明亮模式。
2. 在 html 或者 body 标签添加 data-color-scheme 属性：
   1. auto：自动模式，根据系统的暗黑模式自动切换。
   2. dark：强制暗黑模式。
   3. light：强制明亮模式。

Credits

• Algolia DocSearch: 搜索组件的 UI 设计灵感来源于 DocSearch。