mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
ADW Saved Search (#10306)
Co-authored-by: MichalKinas <michal.kinas@hyland.com>
This commit is contained in:
dominikiwanekhyland
committed by
GitHub
GitHub
parent
537b4f6605
commit
d1462253d0
@@ -25,15 +25,16 @@ Represents an input with autocomplete options.
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
|---------------------------|--------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| autocompleteOptions | `AutocompleteOption[]` | [] | Options for autocomplete |
|
||||
| onReset$ | [`Observable`](https://rxjs.dev/guide/observable)`<void>` | | Observable that will listen to any reset event causing component to clear the chips and input |
|
||||
| allowOnlyPredefinedValues | boolean | true | A flag that indicates whether it is possible to add a value not from the predefined ones |
|
||||
| placeholder | string | 'SEARCH.FILTER.ACTIONS.ADD_OPTION' | Placeholder which should be displayed in input. |
|
||||
| compareOption | (option1: AutocompleteOption, option2: AutocompleteOption) => boolean | | Function which is used to selected options with all options so it allows to detect which options are already selected. |
|
||||
| formatChipValue | (option: string) => string | | Function which is used to format custom typed options. |
|
||||
| filter | (options: AutocompleteOption[], value: string) => AutocompleteOption[] | | Function which is used to filter out possible options from hint. By default it checks if option includes typed value and is case insensitive. |
|
||||
| Name | Type | Default value | Description |
|
||||
|----------------------------|------------------------------------------------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| autocompleteOptions | `AutocompleteOption[]` | [] | Options for autocomplete |
|
||||
| preselectedOptions | `AutocompleteOption[]` | [] | Options which are selected from start |
|
||||
| onReset$ | [`Observable`](https://rxjs.dev/guide/observable)`<void>` | | Observable that will listen to any reset event causing component to clear the chips and input |
|
||||
| allowOnlyPredefinedValues | boolean | true | A flag that indicates whether it is possible to add a value not from the predefined ones |
|
||||
| placeholder | string | 'SEARCH.FILTER.ACTIONS.ADD_OPTION' | Placeholder which should be displayed in input. |
|
||||
| compareOption | (option1: AutocompleteOption, option2: AutocompleteOption) => boolean | | Function which is used to selected options with all options so it allows to detect which options are already selected. |
|
||||
| formatChipValue | (option: string) => string | | Function which is used to format custom typed options. |
|
||||
| filter | (options: AutocompleteOption[], value: string) => AutocompleteOption[] | | Function which is used to filter out possible options from hint. By default it checks if option includes typed value and is case insensitive. |
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@@ -23,6 +23,8 @@ Stores information from all the custom search and faceted search widgets, compil
|
||||
- **buildQuery**(): `SearchRequest`<br/>
|
||||
Builds the current query.
|
||||
- **Returns** `SearchRequest` - The finished query
|
||||
- **encodeQuery**()<br/>
|
||||
Encodes query shards stored in `filterRawParams` property.
|
||||
- **execute**(queryBody?: `SearchRequest`)<br/>
|
||||
Builds and executes the current query.
|
||||
- _queryBody:_ `SearchRequest` - (Optional)
|
||||
@@ -70,7 +72,12 @@ Stores information from all the custom search and faceted search widgets, compil
|
||||
|
||||
- **loadConfiguration**(): [`SearchConfiguration`](../../../lib/content-services/src/lib/search/models/search-configuration.interface.ts)<br/>
|
||||
|
||||
- **Returns** [`SearchConfiguration`](../../../lib/content-services/src/lib/search/models/search-configuration.interface.ts) -
|
||||
- **Returns** [`SearchConfiguration`](../../../lib/content-services/src/lib/search/models/search-configuration.interface.ts) -
|
||||
|
||||
- **navigateToSearch**(query: `string`, searchUrl: `string`) <br/>
|
||||
Updates user query, executes existing search configuration, encodes the query and navigates to searchUrl.
|
||||
- _query:_ `string` - The query to use as user query
|
||||
- _searchUrl:_ `string` - Search url to navigate to
|
||||
|
||||
- **removeFilterQuery**(query: `string`)<br/>
|
||||
Removes an existing filter query.
|
||||
@@ -93,6 +100,8 @@ Stores information from all the custom search and faceted search widgets, compil
|
||||
- **update**(queryBody?: `SearchRequest`)<br/>
|
||||
Builds the current query and triggers the `updated` event.
|
||||
- _queryBody:_ `SearchRequest` - (Optional)
|
||||
- **updateSearchQueryParams**() <br/>
|
||||
Encodes the query and navigates to existing search route adding encoded query as a search param.
|
||||
- **updateSelectedConfiguration**(index: `number`)<br/>
|
||||
|
||||
- _index:_ `number` -
|
||||
|
||||
64
docs/core/services/saved-searches.service.md
Normal file
64
docs/core/services/saved-searches.service.md
Normal file
@@ -0,0 +1,64 @@
|
||||
|
||||
# Saved Searches Service
|
||||
|
||||
Manages operations related to saving and retrieving user-defined searches in the Alfresco Process Services (APS) environment.
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
- **savedSearches$**: [`ReplaySubject`](https://rxjs.dev/api/index/class/ReplaySubject)`<SavedSearch[]>`<br/>
|
||||
Stores the list of saved searches and emits new value whenever there is a change.
|
||||
|
||||
### Methods
|
||||
|
||||
#### getSavedSearches(): [`Observable`](https://rxjs.dev/api/index/class/Observable)`<SavedSearch[]>`
|
||||
|
||||
Fetches the file with list of saved searches either from a locally cached node ID or by querying the APS server. Then it reads the file and maps JSON objects into SavedSearches
|
||||
|
||||
- **Returns**:
|
||||
- [`Observable`](https://rxjs.dev/api/index/class/Observable)`<SavedSearch[]>` - An observable that emits the list of saved searches.
|
||||
|
||||
#### saveSearch(newSaveSearch: Pick<SavedSearch, 'name' | 'description' | 'encodedUrl'>): [`Observable`](https://rxjs.dev/api/index/class/Observable)`<NodeEntry>`
|
||||
|
||||
Saves a new search and updates the existing list of saved searches stored in file and in service property savedSearches$.
|
||||
|
||||
- **Parameters**:
|
||||
- `newSaveSearch`: An object containing the `name`, `description`, and `encodedUrl` of the new search.
|
||||
|
||||
- **Returns**:
|
||||
- [`Observable`](https://rxjs.dev/api/index/class/Observable)`<NodeEntry>` - An observable that emits the response of the node entry after saving.
|
||||
|
||||
### Usage Examples
|
||||
|
||||
#### Fetching Saved Searches
|
||||
|
||||
The following example shows how to fetch saved searches:
|
||||
|
||||
```typescript
|
||||
this.savedSearchService.getSavedSearches().subscribe((searches: SavedSearch[]) => {
|
||||
console.log('Saved searches:', searches);
|
||||
});
|
||||
```
|
||||
|
||||
#### Saving a New Search
|
||||
|
||||
To save a new search:
|
||||
|
||||
```typescript
|
||||
const newSearch = { name: 'New Search', description: 'A sample search', encodedUrl: 'url3' };
|
||||
this.savedSearchService.saveSearch(newSearch).subscribe((response) => {
|
||||
console.log('Saved new search:', response);
|
||||
});
|
||||
```
|
||||
|
||||
#### Creating Saved Searches Node
|
||||
|
||||
When the saved searches file does not exist, it will be created:
|
||||
|
||||
```typescript
|
||||
this.savedSearchService.createSavedSearchesNode('parent-node-id').subscribe((node) => {
|
||||
console.log('Created saved-searches.json node:', node);
|
||||
});
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user