refactor: apply review suggestions

Signed-off-by: Camila Belo <camilaibs@gmail.com>
2022-10-03 13:50:14 +02:00
parent a799972bb1
commit 4ed1fa2480
6 changed files with 34 additions and 14 deletions
@@ -0,0 +1,28 @@
+---
+'@backstage/plugin-search-react': minor
+---
+
+The search query state now has an optional `pageLimit` property that determines how many results will be requested per page, it defaults to 25.
+
+Examples:
+_Basic_
+
+```jsx
+<SearchResults query={{ pageLimit: 30 }}>
+  {results => {
+    // Item rendering logic is omitted
+  }}
+</SearchResults>
+```
+
+_With context_
+
+```jsx
+<SearchContextProvider initialState={{ pageLimit: 30 }}>
+  <SearchResults>
+    {results => {
+      // Item rendering logic is omitted
+    }}
+  </SearchResults>
+</SearchContextProvider>
+```