revert: move config back to search plugin

Signed-off-by: Enrico Alvarenga <enricomalvarenga@gmail.com>
This commit is contained in:
Enrico Alvarenga
2023-08-02 14:19:54 -07:00
committed by Camila Belo
parent 18aa9d27ec
commit 9f09a702d6
9 changed files with 62 additions and 43 deletions
+4 -5
View File
@@ -3,13 +3,12 @@
'@backstage/plugin-search': minor
---
The SearchPage component can now be configured via app-config.yaml with an initial state to define how it behaves when it is first loaded or reset. Check out the following example:
The SearchPage component can now be configured via app-config.yaml with default query parameters to define how it behaves when it is first loaded or reset. Check out the following example:
```yaml
app:
search:
initialState:
pageLimit: 50
search:
query:
pageLimit: 50
```
Acceptable values for `pageLimit` are `10`, `25`, `50` or `100`.
@@ -283,4 +283,4 @@ permission:
search:
query:
pageLimit: 100
pageLimit: 50
-16
View File
@@ -10,19 +10,3 @@ centralized in the `search` plugin README.md.
For a better overview of how the search platform is put together, check the
[Backstage Search Architecture](https://backstage.io/docs/features/search/architecture)
documentation.
### Optional Settings
Configure the search query values via `app-config.yaml` to define how it behaves by default.
```yaml
# app-config.yaml
search:
query:
pageLimit: 50
```
Acceptable values for `pageLimit` are `10`, `25`, `50` or `100`.
**NOTE**: Currently this configuration only reflects the initial state of the Search React components. This means that
it defines how it behaves when it is first loaded or reset.
-16
View File
@@ -40,21 +40,5 @@ export interface Config {
*/
queryLatencyBudgetMs?: number;
};
/**
* An object representing the default search query configuration.
* By configuring and modifying the values of this object,
* you can customize the default values of the search queries
* and define how it behaves by default.
*/
query?: {
/**
* A number indicating the maximum number of results to be returned
* per page during pagination.
*
* @visibility frontend
*/
pageLimit?: 10 | 25 | 50 | 100;
};
};
}
+1 -2
View File
@@ -72,6 +72,5 @@
"files": [
"dist",
"config.d.ts"
],
"configSchema": "config.d.ts"
]
}
@@ -102,7 +102,7 @@ export const useSearchContextCheck = () => {
* The initial state of `SearchContextProvider`.
*
*/
export const searchInitialState = {
const searchInitialState: SearchContextState = {
term: '',
types: [],
filters: {},
+16
View File
@@ -8,6 +8,22 @@ 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 search query values via `app-config.yaml` to define how it behaves by default.
```yaml
# app-config.yaml
search:
query:
pageLimit: 50
```
Acceptable values for `pageLimit` are `10`, `25`, `50` or `100`.
**NOTE**: Currently this configuration only reflects the initial state of the Search React components. This means that
it defines how it behaves when it is first loaded or reset.
### Areas of Responsibility
This search plugin is primarily responsible for the following:
+35
View File
@@ -0,0 +1,35 @@
/*
* Copyright 2023 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export interface Config {
/** Configuration options for the search plugin */
search?: {
/**
* An object representing the default search query configuration.
* By configuring and modifying the values of this object,
* you can customize the default values of the search queries
* and define how it behaves by default.
*/
query?: {
/**
* A number indicating the maximum number of results to be returned
* per page during pagination.
* @visibility frontend
*/
pageLimit?: 10 | 25 | 50 | 100;
};
};
}
+4 -2
View File
@@ -70,6 +70,8 @@
"msw": "^1.0.0"
},
"files": [
"dist"
]
"dist",
"config.d.ts"
],
"configSchema": "config.d.ts"
}