@lowdefy/blocks-algolia 0.0.0-experimental-20250915134255 → 0.0.0-experimental-20250926130521
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
<TITLE>
|
|
2
|
+
DocSearch
|
|
3
|
+
</TITLE>
|
|
4
|
+
|
|
5
|
+
<DESCRIPTION>
|
|
6
|
+
|
|
7
|
+
This block renders a [Algolia DocSearch](https://docsearch.algolia.com/) search box.
|
|
8
|
+
|
|
9
|
+
To use the block, the `apiKey`, `appId` and `indexName` properties need to be configured.
|
|
10
|
+
|
|
11
|
+
The DocSearch CSS files and preconnect optimisation also need to be added to the HTML head of your app using `appendHead` as follows:
|
|
12
|
+
|
|
13
|
+
```yaml
|
|
14
|
+
lowdefy: { { version } }
|
|
15
|
+
app:
|
|
16
|
+
html:
|
|
17
|
+
appendHead: |
|
|
18
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" />
|
|
19
|
+
<link rel="preconnect" href="https://YOUR_APP_ID-dsn.algolia.net" crossorigin />
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
</DESCRIPTION>
|
|
23
|
+
|
|
24
|
+
<SCHEMA>
|
|
25
|
+
|
|
26
|
+
```json
|
|
27
|
+
{
|
|
28
|
+
"type": "object",
|
|
29
|
+
"properties": {
|
|
30
|
+
"type": "object",
|
|
31
|
+
"additionalProperties": false,
|
|
32
|
+
"properties": {
|
|
33
|
+
"apiKey": {
|
|
34
|
+
"type": "string",
|
|
35
|
+
"description": "Your Algolia Search API key."
|
|
36
|
+
},
|
|
37
|
+
"appId": {
|
|
38
|
+
"type": "string",
|
|
39
|
+
"description": "Your Algolia application ID."
|
|
40
|
+
},
|
|
41
|
+
"disableUserPersonalization": {
|
|
42
|
+
"type": "boolean",
|
|
43
|
+
"description": "Disable saving recent searches and favorites to the local storage."
|
|
44
|
+
},
|
|
45
|
+
"indexName": {
|
|
46
|
+
"type": "string",
|
|
47
|
+
"description": "Your Algolia index name."
|
|
48
|
+
},
|
|
49
|
+
"initialQuery": {
|
|
50
|
+
"type": "string",
|
|
51
|
+
"description": "The search input initial query."
|
|
52
|
+
},
|
|
53
|
+
"maxResultsPerGroup": {
|
|
54
|
+
"type": "number",
|
|
55
|
+
"description": "The maximum number of results to display per search group. Default is 5."
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
},
|
|
59
|
+
"events": {
|
|
60
|
+
"type": "object",
|
|
61
|
+
"additionalProperties": false,
|
|
62
|
+
"properties": {}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
</SCHEMA>
|
|
68
|
+
|
|
69
|
+
<EXAMPLES>
|
|
70
|
+
|
|
71
|
+
### Standard Usage
|
|
72
|
+
|
|
73
|
+
```yaml
|
|
74
|
+
id: standard_usage
|
|
75
|
+
type: DocSearch
|
|
76
|
+
properties:
|
|
77
|
+
apiKey: YOUR_API_KEY
|
|
78
|
+
appId: YOUR_APP_ID
|
|
79
|
+
indexName: YOUR_INDEX_NAME
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
</EXAMPLES>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lowdefy/blocks-algolia",
|
|
3
|
-
"version": "0.0.0-experimental-
|
|
3
|
+
"version": "0.0.0-experimental-20250926130521",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"description": "Algolia Lowdefy blocks.",
|
|
6
6
|
"homepage": "https://lowdefy.com",
|
|
@@ -39,14 +39,14 @@
|
|
|
39
39
|
],
|
|
40
40
|
"dependencies": {
|
|
41
41
|
"@docsearch/react": "3.5.2",
|
|
42
|
-
"@lowdefy/block-utils": "0.0.0-experimental-
|
|
42
|
+
"@lowdefy/block-utils": "0.0.0-experimental-20250926130521",
|
|
43
43
|
"react": "18.2.0",
|
|
44
44
|
"react-dom": "18.2.0"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
47
|
"@emotion/jest": "11.10.5",
|
|
48
|
-
"@lowdefy/block-dev": "0.0.0-experimental-
|
|
49
|
-
"@lowdefy/jest-yaml-transform": "0.0.0-experimental-
|
|
48
|
+
"@lowdefy/block-dev": "0.0.0-experimental-20250926130521",
|
|
49
|
+
"@lowdefy/jest-yaml-transform": "0.0.0-experimental-20250926130521",
|
|
50
50
|
"@swc/cli": "0.1.63",
|
|
51
51
|
"@swc/core": "1.3.99",
|
|
52
52
|
"@swc/jest": "0.2.29",
|