@igamingcareer/igaming-components 1.1.15 → 1.1.17

package/Readme.md

@@ -124,6 +124,43 @@ export function Example() {
 }
 ```
 
+## JobsList filter configuration
+
+`JobsList` now supports multi-select company/country/city filters, optional counts in filter labels, and top-level sorting for those filter options.
+
+```tsx
+<JobsList
+  apiUrl={process.env.NEXT_PUBLIC_JOB_API_URL!}
+  filterKeys={["company", "country", "city", "department"]}
+  searchableFilters={["company", "country", "city", "department"]}
+  filterDisplayConfig={{
+    multiSelectKeys: ["company", "country", "city"], // default
+    showOptionCounts: true,                           // default, renders "Malta (3)"
+    optionSort: "count_desc",                        // "alphabetical" | "count_desc" | "count_asc"
+  }}
+/>
+```
+
+### `filterDisplayConfig`
+
+- `multiSelectKeys`
+  - Controls which dynamic filters render as multi-select checkbox groups.
+  - Defaults to `["company", "country", "city"]`.
+  - If you remove one of those keys, that filter falls back to the legacy single-select dropdown.
+
+- `showOptionCounts`
+  - Defaults to `true`.
+  - When `true`, dynamic filters show the number of matching jobs next to each option.
+  - Example: `Malta (3)`.
+  - Set it to `false` only if you want to hide those counts.
+
+- `optionSort`
+  - Controls how dynamic filter options are ordered.
+  - Supported values:
+    - `"alphabetical"` (default)
+    - `"count_desc"` — highest count first
+    - `"count_asc"` — lowest count first
+
 ## Login (remember me identifier)
 
 The `Login` and `LoginForm` components support a real “Remember me” experience by persisting the identifier (email/username)