thoughtco/zinc-search

此包的最新版本(dev-main)没有可用的许可证信息。

dev-main 2023-06-28 20:33 UTC

This package is auto-updated.

Last update: 2024-08-28 23:07:38 UTC


README

ZincSearch 是 Statamic 插件,通过利用 ZincSearch 的力量,来加速您的控制台列表视图。

功能

此插件可以使您的控制台列表运行超级快。

安装方法

确保您有一个可工作的 ZincSearch 安装

从您的项目根目录运行以下命令

composer require thoughtco/zinc-search

zincsearch 驱动器添加到 config/statamic/search.php 中的 drivers 数组

        'zincsearch' => [
             'credentials' => [
                'url' => env('ZINCSEARCH_URL', ''),
                'username' => env('ZINCSEARCH_USERNAME', ''),
                'password' => env('ZINCSEARCH_PASSWORD', ''),
            ],           
        ],

将变量添加到您的 .env 文件中,例如 ZINCSEARCH_URLZINCSEARCH_USERNAMEZINCSEARCH_PASSWORD

使用方法

为集合设置一个搜索索引,例如。

'pages' => [
    'driver' => 'zincsearch',
    'searchables' => ['collection:pages'],
    'fields' => ['id', 'title', 'url', 'content', 'status'],
    'searchable_fields' => ['title, 'slug'],
    'settings' => [],
],

然后将此应用到您的集合 YAML 定义中,键为 search_index,例如。

title: Pages
revisions: false
title_format: null
sort_by: title
sort_dir: asc
preview_targets:
  -
    label: Entry
    url: '{permalink}'
structure:
  root: true
search_index: pages

Antlers / 前端

要利用此搜索的速度在前端使用,请使用 search_index 标签而不是 collection

例如。

{{ search:results index="pages" supplement_data="false" for="*" as="results" limit="10" offset="0" paginate="10" }}
    {{ if no_results }}
    No results
    {{ else }}
        {{ results }}
        <p>{{ id }} - {{ title }}</p>
        {{ /results }}
    {{ /if }}
{{ /search:results }}