Skip to content

Commit

Permalink
fix: typos, format
Browse files Browse the repository at this point in the history
  • Loading branch information
kim.tran committed Dec 31, 2024
1 parent 41f66b6 commit 139e487
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ To find out how to work with the SearchHeader component, please visit the {searc
// TODO: Add reference to search config docs?
| `selectedSearchConfigChanged` | `EventEmitter<<<search-config-data, SearchConfigData>> \| undefined>` | Emits the `<<search-config-data, SearchConfigData>>` upon change of selected searchConfig.
| `viewModeChanged` | `EventEmitter<'basic' \| 'advanced'>` | Emits the viewMode `'basic'` or `'advanced'` when the Basic\|Advanced button is clicked.
| `componentStateChanged` | `EventEmitter<<<search-header-component-state, SearchHeaderComponentState>>>` | Emits the `<<search-header-component-state, SearchHeaderComponentState>>` with updated `viewMode` or `searchConfig` if changed, to ensure consistent component state.
| `componentStateChanged` | `EventEmitter <<<search-header-component-state, SearchHeaderComponentState>>>` | Emits the `<<search-header-component-state, SearchHeaderComponentState>>` with updated `viewMode` or `searchConfig` if changed, to ensure consistent component state.
|===
[#types]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,17 @@
:!sectids:

[#goal]
== Goal: Add an AutoComplete for suggestions with array of type number as a search criteria input field for your search page.
== Goal: Add AutoComplete Number
:sectids:
:sectnums:

NOTE: Please replace all occurences of `+exampleNumberArray+` with the actual name in the following code snippets
Add an AutoComplete for suggestions with array of type number as a search criteria input field for your search page.

NOTE: Please replace all occurences of *exampleNumberArray* with the actual name in the following code snippets

[#parameters]
== Parameters
Please define the member for your `+<%= featurePropertyName %>SearchCriteriasSchema+` here.
Please define the member for your *<%= featurePropertyName %>SearchCriteriasSchema* here.


_Adapt in File:_ `+<feature>-search.parameters.ts+`
Expand Down Expand Up @@ -249,4 +251,4 @@ _Adapt in File:_ `+<feature>-search.effects.ts+`
...
----

NOTE: Don't forget to add the translations to your de.json and en.json.
NOTE: Don't forget to add the translations to your *de.json* and *en.json*.
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
= AutoComplete with array of type object
= AutoComplete for suggestions with array of type object

:idprefix:
:idseparator: -
:!sectids:
[#goal]
== Goal: Add an AutoComplete for suggestions with array of type object as a search criteria input field for your search page.
== Goal: Add Autocmplete Object
:sectids:
:sectnums:

NOTE: Please replace all occurences of `+exampleStringObject+`, `+property1+`, `+property2+` and `+exampleStringObjectProperty1+`, `+exampleStringObjectProperty2+` respectively with the actual names in the following code snippets.
Add an AutoComplete for suggestions with array of type object as a search criteria input field for your search page.

NOTE: Please replace all occurences of *exampleStringObject*, *property1*, *property2* and *exampleStringObjectProperty1*, *exampleStringObjectProperty2* respectively with the actual names in the following code snippets.

In this section, we aim to add an AutoComplete input field. The suggestions will be an array of type string. For this use case, we want to display `property1` (a string type property of the object) in the input field and the suggestions and perform a search with `property2` for the search criteria. The object has the following interface:

Expand Down Expand Up @@ -323,4 +325,4 @@ _Adapt in File:_ `+<feature>-search.effects.ts+`
...
----

NOTE: Don't forget to add the translations to your de.json and en.json.
NOTE: Don't forget to add the translations to your *de.json* and *en.json*.
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
= AutoComplete with array of type string
= AutoComplete for suggestions with array of type string

:idprefix:
:idseparator: -
:!sectids:
[#goal]
== Goal: Add an AutoComplete for suggestions with array of type string as a search criteria input field for your search page.
== Goal: Add AutoComplet String
:sectids:
:sectnums:

Add an AutoComplete for suggestions with array of type string as a search criteria input field for your search page.

[#parameters]
== Parameters
Please define the member for your `+<%= featurePropertyName %>SearchCriteriasSchema+` here
Please define the member for your *<%= featurePropertyName %>SearchCriteriasSchema* here

NOTE: Please replace all occurences of `+exampleStringArray+` with the actual name in the following code snippets.
NOTE: Please replace all occurences of *exampleStringArray* with the actual name in the following code snippets.

_Adapt in File:_ `+<feature>-search.parameters.ts+`

Expand Down Expand Up @@ -242,4 +244,4 @@ _Adapt in File:_ `+<feature>-search.effects.ts+`
...
----

NOTE: Don't forget to add the translations to your de.json and en.json.
NOTE: Don't forget to add the translations to your *de.json* and *en.json*.
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
:idseparator: -
:!sectids:
[#goal]
== Goal: Add a Calendar as a search criteria input field for your search page.
== Goal: Add Calendar Input
:sectids:
:sectnums:

NOTE: Please replace all occurences of `+exampleDate+` with the actual name in the following code snippets
Add a Calendar as a search criteria input field for your search page.

NOTE: Please replace all occurences of *exampleDate* with the actual name in the following code snippets

[#parameters]
== Parameters
Expand Down Expand Up @@ -123,4 +125,4 @@ _Adapt in File:_ `+<feature>-search.effects.ts+`
);
----

NOTE: Don't forget to add the translations to your de.json and en.json.
NOTE: Don't forget to add the translations to your *de.json* and *en.json*.
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
:idseparator: -
:!sectids:
[#goal]
== Goal: Add a Dropdown as a search criteria input field for your search page.
== Goal: Add Dropdown Input
:sectids:
:sectnums:

NOTE: Please replace all occurences of `+exampleEnum+` with the actual name in the following code snippets
Add a Dropdown as a search criteria input field for your search page.

NOTE: Please replace all occurences of *exampleEnum* with the actual name in the following code snippets

[#parameters]
== Parameters
Expand Down Expand Up @@ -75,5 +77,5 @@ _Adapt in File:_ `+<feature>-search.component.ts+`
);
----

NOTE: Don't forget to add the translations to your de.json and en.json.
NOTE: Don't forget to add the translations to your *de.json* and *en.json*.

Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
= Configure the search criteria and parameters
= Adding search criteria

:idprefix:
:idseparator: -
:!sectids:
[#configure-search-results]
== To configure the search criteria and parameters, the following steps must be taken.
[#configure-search-criteria]
== Goal: Configure search criteria
:sectids:
:sectnums:

Configure the search criteria input field and parameters for you search page.

[#request-object]
== Request Object
Add additional properties to the `+<feature>-bff.yaml+`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
:idseparator: -
:!sectids:
[#goal]
== Goal: Add a MultiSelect as a search criteria input field for your search page.
== Goal: Add MultiSelect Input
:sectids:
:sectnums:

NOTE: Please replace all occurences of `+exampleDate+` with the actual name in the following code snippets
Add a MultiSelect as a search criteria input field for your search page.

NOTE: Please replace all occurences of *exampleEnum* with the actual name in the following code snippets

[#parameters]
== Parameters
Expand Down Expand Up @@ -76,4 +78,4 @@ _Adapt in File:_ `+<feature>-search.component.ts+`
);
----

NOTE: Don't forget to add the translations to your de.json and en.json.
NOTE: Don't forget to add the translations to your *de.json* and *en.json*.

0 comments on commit 139e487

Please sign in to comment.