You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# App Search Reference UI
2
2
3
3
The Reference UI is a configurable, generic UI meant to work with
4
-
any [App Search](https://www.elastic.co/cloud/app-search-service) Engine. It
4
+
any [App Search](https://www.elastic.co/cloud/search-lib-service) Engine. It
5
5
can serve as a simple demo, a functional test for your Engine data,
6
6
or as a code reference when building out your own App Search
7
7
UI.
@@ -27,7 +27,7 @@ Run the following commands to start this application:
27
27
# Run the `cd` command to change the current directory to the
28
28
# location of your downloaded Reference UI. Replace the path
29
29
# below with the actual path of your project.
30
-
cd~/Downloads/app-search-reference-ui
30
+
cd~/Downloads/search-lib-reference-ui
31
31
32
32
# Run this to set everything up
33
33
npm install
@@ -57,7 +57,7 @@ The following is a complete list of options available for configuration in [engi
57
57
|`urlField`| String | optional | A field with a url to use as a link in results. |
58
58
|`urlFieldTemplate`| String | optional | Instead of urlField, you can provide a URL "template" here, which lets you build a URL from other fields. ex: "https://www.example.com/{{id}}".|
59
59
|`sortFields`| Array[String]| required | A list of fields that will be used for sort options. |
60
-
|`facets`| Array[String]| required | A list of fields that will be available as "facet" filters. Read more about facets within the [App Search documentation](https://swiftype.com/documentation/app-search/guides/facets). |
60
+
|`facets`| Array[String]| required | A list of fields that will be available as "facet" filters. Read more about facets within the [App Search documentation](https://swiftype.com/documentation/search-lib/guides/facets). |
61
61
62
62
### External configuration
63
63
@@ -92,13 +92,13 @@ Logically, the pieces of this application fit together like this:
92
92
|
93
93
( State manager ) ( Syncs state with URL )
94
94
------------------- --------------
95
-
| AppSearchDriver | <--> | URLManager |
95
+
| SearchDriver | <--> | URLManager |
96
96
------------------- --------------
97
97
|
98
98
| actions / state
99
99
v
100
100
---------------------
101
-
| AppSearchProvider | ( Driver to React glue )
101
+
| SearchProvider | ( Driver to React glue )
102
102
---------------------
103
103
|
104
104
| context
@@ -115,7 +115,7 @@ Logically, the pieces of this application fit together like this:
115
115
116
116
That corresponds to the code and file structure in the following way:
117
117
118
-
**src/app-search**
118
+
**src/search-lib**
119
119
120
120
Everything in this directory for now should be thought of as a separate library.
121
121
The goal eventually is to actually separate this out into a library of its own,
@@ -171,7 +171,7 @@ Components in this UI are separated into "Containers" and "Components". These
171
171
can be thought of as "Logic" and "View", respectively.
172
172
173
173
"Containers" are "connected" to the "context" via a "Higher Order Component"
174
-
(HOC) `withAppSearch`. This HOC simply exposes all state and actions as `props`.
174
+
(HOC) `withSearch`. This HOC simply exposes all state and actions as `props`.
175
175
A consuming Container simply accesses those actions and state, composes
176
176
appropriate handlers and data as props and passes them to the appropriate
177
177
Component.
@@ -218,7 +218,7 @@ own implementation. Here are a few places to look to make changes:
218
218
won't need this.
219
219
220
220
- Lastly, if you find there is a core action or state missing, you may
221
-
consider updating the core logic in [src/app-search](src/app-search).
221
+
consider updating the core logic in [src/search-lib](src/search-lib).
222
222
223
223
Lastly, we accept PRs! If you make a customization that you think would benefit
0 commit comments