blob: f667e4cfe93d672a318ee440af8c11d94dfdf947 (
plain)
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
|
# plugin-search
This plugin is the interface used by all the search plugins (`plugin-lunr`, `plugin-algolia`, etc.)
## Registering a Search handler
Your plugin must register as a Search handler during its `activate` method:
``` js
GitBook.createPlugin({
activate: (dispatch, getState, { Search }) => {
dispatch(Search.registerHandler('my-plugin-name', searchHandler));
},
reduce
})
/**
* Search against a query
* @param {String} query
* @return {Promise<List<Result>>}
*/
function searchHandler(query, dispatch, getState) {
...
}
```
Your search handler must return a List of result-shaped objects. A result object has the following shape:
``` js
result = {
title: string, // The title of the resource, as displayed in the list of results.
url: string, // The URL to access the matched resource.
body: string // (optional) The context of the matched text (can be a sentence
// containing matching words). It will be displayed near the result.
}
```
|
