algolia
2020-03-30
2020-12-15
2 min

Algolia の InstantSearch.js を用いて URL ルーティングを実装する

thumbnail

1. はじめに

 Algolia は,検索サイトに必要なインターフェースを InstantsSearch.js として提供しています。 URL ルーティングも InstantsSearch.js に含まれています。本記事では,URL ルーティングに関する情報を記述します。

2. サンプルコード

 CodeSandbox で基本的な URL ルーティングのサンプルコードが公開されています。動作を確認すると,検索ボックスやページネーション,検索フィルタの動作状況が URL パラメータに反映されていることがわかります。

3. コードリーディング

 CodeSandbox で公開されている App.vue の一部を以下に示します。特に重要な部分は,ハイライトしている 17, 43, 44, 54〜57 行目です。ドキュメントによると historyRoutersimpleStateMapping をオーバーライドすることで,SEO フレンドリーな URL 設計にすることもできるそうです。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<template>
  <div>
    <header class="header">
      <h1 class="header-title"><a href="/">Basic routing</a></h1>
      <p class="header-subtitle">
        using
        <a href="https://github.com/algolia/vue-instantsearch">
          Vue InstantSearch
        </a>
      </p>
    </header>

    <div class="container">
      <ais-instant-search
        :search-client="searchClient"
        index-name="instant_search"
        :routing="routing"
      >
        <div class="search-panel">
          <div class="search-panel__filters">
            <ais-refinement-list attribute="brand" searchable />
          </div>

          <div class="search-panel__results">
            <ais-search-box placeholder="Search here…" class="searchbox" />
            <ais-hits>
              <template slot="item" slot-scope="{ item }">
                <h1><ais-highlight :hit="item" attribute="name" /></h1>
                <p><ais-highlight :hit="item" attribute="description" /></p>
              </template>
            </ais-hits>

            <div class="pagination"><ais-pagination /></div>
          </div>
        </div>
      </ais-instant-search>
    </div>
  </div>
</template>

<script>
import algoliasearch from 'algoliasearch/lite';
import { history as historyRouter } from 'instantsearch.js/es/lib/routers';
import { simple as simpleStateMapping } from 'instantsearch.js/es/lib/stateMappings';
import 'instantsearch.css/themes/algolia-min.css';

export default {
  data() {
    return {
      searchClient: algoliasearch(
        'latency',
        '6be0576ff61c053d5f9a3225e2a90f76'
      ),
      routing: {
        router: historyRouter(),
        stateMapping: simpleStateMapping(),
      },
    };
  },
};
</script>

4. おわりに

 ここまで,URL ルーティングに関する情報について記述してきました。基本的にはデフォルト設定で,SEO 対策が必要になったら追加実装で良いと思います。また,ドキュメントによると Vue RouterNuxt.js とも統合できるようです。

環境情報

  • algoliasearch Ver.3.33.0
  • instantsearch.js Ver.3.7.0
  • vue-instantsearch Ver.2.2.1
  • Vue.js Ver.2.6.10
  • Node.js Ver.8.10.0
  • Zorin OS 15.2 Core (Ubuntu 18.04 LTS)