docs(search): update search plugin README

Signed-off-by: Enrico Alvarenga <enricomalvarenga@gmail.com>
2023-06-22 12:58:40 -07:00
parent be6250a958
commit fc89e4e5b7
1 changed files with 12 additions and 0 deletions
@@ -8,6 +8,18 @@ Development is ongoing. You can follow the progress and contribute at the Backst

 Run `yarn dev` in the root directory, and then navigate to [/search](http://localhost:3000/search) to check out the plugin.

+### Optional Settings
+
+Configure the initialState of the search component in your `app-config.yaml` to defines how it behaves when it is first loaded or reset.
+
+```yaml
+# app-config.yaml
+app:
+  search:
+    initialState:
+      pageLimit: 50
+```
+
 ### Areas of Responsibility

 This search plugin is primarily responsible for the following: