Skip to content

Commit 5f009b7

Browse files
committed
WIP search params
1 parent 88cd899 commit 5f009b7

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

apps/events-helsinki/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,61 @@ The application configuration is done via the [AppConfig.ts](./src/domain/app/Ap
183183

184184
> NOTE: This section easily runs out-of-date.
185185
186+
### Main event search
187+
188+
```ts
189+
[EVENT_SEARCH_FILTERS.TEXT]: !isEmpty(text) ? text?.join(',') : undefined, // NOTE: only *OngoingAnd supports Array.
190+
[EVENT_SEARCH_FILTERS.ONGOING]: true,
191+
[EVENT_SEARCH_FILTERS.DIVISIONS]: division,
192+
end,
193+
include,
194+
publisherAncestor,
195+
isFree: isFree || undefined,
196+
internetBased: onlyRemoteEvents || undefined,
197+
keywordOrSet2: [...(keyword ?? []), ...mappedCategories],
198+
keywordAnd,
199+
keywordNot,
200+
language,
201+
location: places.sort(),
202+
pageSize,
203+
publisher,
204+
sort: sortOrder,
205+
start,
206+
startsAfter,
207+
superEventType,
208+
superEvent,
209+
eventType: AppConfig.supportedEventTypes,
210+
```
211+
212+
The "main events search" component is used in the search page at `/search`.
213+
214+
| parameter | default value | controllable | required | description |
215+
| ----------------- | ---------------------------------------- | ------------ | -------- | ------------------------------------------------------------------------- |
216+
| eventType | "General" | - | x | Select only "general" type events |
217+
| xFullText | "" | x | x | A text scoring mathcher (title, place, description, ...) |
218+
| include | ['keywords', 'location'] | - | x | Fetch related data from datasource |
219+
| pageSize | 10 | - | x | How many items are fetched per page |
220+
| place | Null | x | - | Filter by location / venue / place (source: LinkedEvents) |
221+
| sortOrder | "end_time" | x | x | Sorting order of the result set. Default is "event end time as ascending" |
222+
| division | "ocd-division/country:fi/kunta:helsinki" | - | x | Only city of Helsinki events |
223+
| start | "now" | x | x | Filter by location / venue / place (source: LinkedEvents) |
224+
| startsAfter | "" | x | x | |
225+
| end | null | x | x | |
226+
| keywordAnd | "" | - | - | |
227+
| keywordOrSet2 | "" | - | - | |
228+
| keywordNot | "" | - | - | |
229+
| language | "" | - | - | |
230+
| publisher | "" | - | - | |
231+
| publisherAncestor | "" | - | - | |
232+
| isFree | false | - | - | |
233+
| internetBased | false | - | - | |
234+
| superEventType | "" | - | - | |
235+
| superEvent | "" | - | - | |
236+
237+
### Similar events
238+
239+
### Upcoming events
240+
186241
## Learn more
187242

188243
You can learn more in the [NextJs documentation](https://nextjs.org/docs/getting-started).

0 commit comments

Comments
 (0)