Persist event filter state across reload and navigation

contao/templates/frontend/event_filter.html.twig

@@ -31,7 +31,7 @@
         </div>
     </div>
 
-    <button type="button" id="eventfilter-reset" class="eventfilter-reset" hidden>Filter zurücksetzen</button>
+    <button type="button" id="eventfilter-reset" class="eventfilter-reset" aria-label="Alle Filter zurücksetzen" aria-controls="{{ targetEventListId|default('eventlist')|e('html_attr') }}" hidden>Filter zurücksetzen</button>
 
     <p id="eventfilter-status" class="visually-hidden" aria-live="polite"></p>
 </div>
@@ -69,13 +69,13 @@
     }
 
     #eventfilters .widget-select.active .ts-control {
-        outline: 2px solid currentColor;
+        outline: 3px solid currentColor;
-        outline-offset: 2px;
+        outline-offset: 3px;
     }
 
     #eventfilters .ts-control:focus-within {
-        outline: 2px solid currentColor;
+        outline: 3px solid currentColor;
-        outline-offset: 2px;
+        outline-offset: 3px;
     }
 
     #eventfilters .eventfilter-reset[hidden] {
@@ -91,15 +91,13 @@
     }
 
     #eventfilters .ts-wrapper.single .ts-control > input {
-        width: auto !important;
+        width: auto;
-        min-width: 0 !important;
-        flex: 0 0 auto;
     }
 
 </style>
 
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/tom-select@2.4.3/dist/css/tom-select.css">
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/tom-select@2/dist/css/tom-select.css">
-<script src="https://cdn.jsdelivr.net/npm/tom-select@2.4.3/dist/js/tom-select.complete.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/tom-select@2/dist/js/tom-select.complete.min.js"></script>
 
 <script type="module">
     const filters = document.getElementById('eventfilters');
@@ -126,6 +124,8 @@
     const orgWidget = orgSelect?.closest('.widget-select');
     const resetButton = filters.querySelector('#eventfilter-reset');
     const status = filters.querySelector('#eventfilter-status');
+    const stateStorageKey = 'event-filter-state';
+    const stateQueryKey = 'event_filter';
 
     const animationMs = 220;
     let hideTimers = new WeakMap();
@@ -137,12 +137,46 @@
             return null;
         }
 
+        let shouldBlurOnChange = false;
+
         return new window.TomSelect(selectElement, {
-            create: true,
+            create: false,
             sortField: {
                 field: 'text',
                 direction: 'asc',
             },
+            render: {
+                no_results() {
+                    return '<div class="no-results" role="option" aria-disabled="true">Keine Ergebnisse gefunden</div>';
+                },
+                no_more_results() {
+                    return '<div class="no-more-results" role="option" aria-disabled="true">Keine weiteren Ergebnisse</div>';
+                },
+            },
+            onInitialize() {
+                const markPointerInteraction = () => {
+                    shouldBlurOnChange = true;
+                };
+
+                const markKeyboardInteraction = () => {
+                    shouldBlurOnChange = false;
+                };
+
+                this.control.addEventListener('pointerdown', markPointerInteraction);
+                this.control.addEventListener('touchstart', markPointerInteraction, { passive: true });
+                this.control.addEventListener('keydown', markKeyboardInteraction);
+                this.dropdown.addEventListener('pointerdown', markPointerInteraction);
+                this.dropdown.addEventListener('touchstart', markPointerInteraction, { passive: true });
+                this.dropdown.addEventListener('keydown', markKeyboardInteraction);
+            },
+            onChange() {
+                if (!shouldBlurOnChange) {
+                    return;
+                }
+
+                this.blur();
+                shouldBlurOnChange = false;
+            },
         });
     };
 
@@ -150,6 +184,109 @@
     const locationTom = initTomSelect(locationSelect);
     const orgTom = initTomSelect(orgSelect);
 
+    const hasOptionValue = (selectElement, value) => {
+        if (!selectElement) {
+            return false;
+        }
+
+        return Array.from(selectElement.options).some((option) => option.value === value);
+    };
+
+    const rawValueToFilterState = (rawValue) => {
+        const value = (rawValue || '').trim();
+
+        if (!value) {
+            return { type: 'all', value: '' };
+        }
+
+        if (value.startsWith('tag-') && hasOptionValue(tagSelect, value)) {
+            return { type: 'tag', value: value.replace('tag-', '') };
+        }
+
+        if (value.startsWith('location-') && hasOptionValue(locationSelect, value)) {
+            return { type: 'location', value: value.replace('location-', '') };
+        }
+
+        if (value.startsWith('org-') && hasOptionValue(orgSelect, value)) {
+            return { type: 'org', value: value.replace('org-', '') };
+        }
+
+        return { type: 'all', value: '' };
+    };
+
+    const filterStateToRawValue = (filterState) => {
+        if (!filterState.value || filterState.type === 'all') {
+            return '';
+        }
+
+        if (filterState.type === 'tag') {
+            return `tag-${filterState.value}`;
+        }
+
+        if (filterState.type === 'location') {
+            return `location-${filterState.value}`;
+        }
+
+        if (filterState.type === 'org') {
+            return `org-${filterState.value}`;
+        }
+
+        return '';
+    };
+
+    const readUrlState = () => {
+        const url = new URL(window.location.href);
+        return (url.searchParams.get(stateQueryKey) || '').trim();
+    };
+
+    const writeUrlState = (value) => {
+        const url = new URL(window.location.href);
+
+        if (value) {
+            url.searchParams.set(stateQueryKey, value);
+        } else {
+            url.searchParams.delete(stateQueryKey);
+        }
+
+        window.history.replaceState(window.history.state, '', url);
+    };
+
+    const readStoredState = () => {
+        try {
+            return (window.sessionStorage.getItem(stateStorageKey) || '').trim();
+        } catch (error) {
+            return '';
+        }
+    };
+
+    const writeStoredState = (value) => {
+        try {
+            if (value) {
+                window.sessionStorage.setItem(stateStorageKey, value);
+            } else {
+                window.sessionStorage.removeItem(stateStorageKey);
+            }
+        } catch (error) {
+            // noop
+        }
+    };
+
+    const syncState = (filterState) => {
+        const rawValue = filterStateToRawValue(filterState);
+        writeStoredState(rawValue);
+        writeUrlState(rawValue);
+    };
+
+    const applyControlState = (filterState) => {
+        const tagValue = filterState.type === 'tag' ? `tag-${filterState.value}` : '';
+        const locationValue = filterState.type === 'location' ? `location-${filterState.value}` : '';
+        const orgValue = filterState.type === 'org' ? `org-${filterState.value}` : '';
+
+        setSelectValue(tagSelect, tagTom, tagValue);
+        setSelectValue(locationSelect, locationTom, locationValue);
+        setSelectValue(orgSelect, orgTom, orgValue);
+    };
+
     const setSelectValue = (selectElement, tomInstance, value) => {
         if (!selectElement) {
             return;
@@ -282,6 +419,7 @@
         });
 
         updateStatus(filterState);
+        syncState(filterState);
     };
 
     tagSelect?.addEventListener('change', () => {
@@ -343,5 +481,16 @@
         applyFilter({ type: 'all', value: '' });
     });
 
-    applyFilter(currentFilter);
+    const urlState = readUrlState();
+    const storedState = readStoredState();
+    const initialState = rawValueToFilterState(urlState || storedState);
+
+    applyControlState(initialState);
+    applyFilter(initialState);
+
+    window.addEventListener('popstate', () => {
+        const stateFromUrl = rawValueToFilterState(readUrlState());
+        applyControlState(stateFromUrl);
+        applyFilter(stateFromUrl);
+    });
 </script>

src/EventListener/OrganizationListingTemplateDataListener.php

@@ -53,7 +53,7 @@ class OrganizationListingTemplateDataListener
 
         $organizationIds = array_values(array_unique(array_values($rowToOrganizationIdMap)));
         $organizationTagMap = $this->fetchOrganizationTagMap($organizationIds);
-        $organizationLogoUuidMap = $this->fetchOrganizationLogoUuidMap($organizationIds);
+        $organizationLogoMap = $this->fetchOrganizationLogoMap($organizationIds);
 
         $organizationTagLabelMap = [];
         $rowTagIdsList = [];
@@ -74,7 +74,9 @@ class OrganizationListingTemplateDataListener
             }
 
             $tagData = $organizationTagMap[$organizationId] ?? ['ids' => [], 'labels' => []];
-            $logoUuid = $organizationLogoUuidMap[$organizationId] ?? '';
+            $logoData = $organizationLogoMap[$organizationId] ?? ['uuid' => '', 'isSvg' => false];
+            $logoUuid = (string) ($logoData['uuid'] ?? '');
+            $logoIsSvg = (bool) ($logoData['isSvg'] ?? false);
             $tagIdsCsv = implode(',', $tagData['ids']);
             $tagLabelsCsv = implode(', ', $tagData['labels']);
 
@@ -84,6 +86,7 @@ class OrganizationListingTemplateDataListener
 
             if ('' !== $logoUuid) {
                 $tbody[$rowIndex]['logo_uuid']['content'] = $logoUuid;
+                $tbody[$rowIndex]['logo_is_svg']['content'] = $logoIsSvg ? '1' : '';
             }
         }
 
@@ -266,16 +269,19 @@ class OrganizationListingTemplateDataListener
     }
 
     /** @param list<int> $organizationIds
-     *  @return array<int, string>
+     *  @return array<int, array{uuid: string, isSvg: bool}>
      */
-    private function fetchOrganizationLogoUuidMap(array $organizationIds): array
+    private function fetchOrganizationLogoMap(array $organizationIds): array
     {
         if ([] === $organizationIds) {
             return [];
         }
 
         $rows = $this->connection->executeQuery(
-            'SELECT o.id AS organization_id, o.logo AS logo_uuid FROM tl_organization o WHERE o.id IN (?)',
+            'SELECT o.id AS organization_id, o.logo AS logo_uuid, f.extension AS file_extension, f.path AS file_path
+             FROM tl_organization o
+             LEFT JOIN tl_files f ON f.uuid = o.logo
+             WHERE o.id IN (?)',
             [$organizationIds],
             [ArrayParameterType::INTEGER],
         )->fetchAllAssociative();
@@ -285,12 +291,22 @@ class OrganizationListingTemplateDataListener
         foreach ($rows as $row) {
             $organizationId = (int) ($row['organization_id'] ?? 0);
             $logoUuid = $this->normalizeUuid($row['logo_uuid'] ?? null);
+            $extension = strtolower(trim((string) ($row['file_extension'] ?? '')));
+
+            if ('' === $extension && isset($row['file_path']) && \is_scalar($row['file_path'])) {
+                $extension = strtolower((string) pathinfo((string) $row['file_path'], PATHINFO_EXTENSION));
+            }
+
+            $isSvg = 'svg' === $extension;
 
             if ($organizationId <= 0 || '' === $logoUuid) {
                 continue;
             }
 
-            $map[$organizationId] = $logoUuid;
+            $map[$organizationId] = [
+                'uuid' => $logoUuid,
+                'isSvg' => $isSvg,
+            ];
         }
 
         return $map;