Improve Tom Select usability and accessibility defaults

contao/dca/tl_module.php

@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Contao\Database;
+use Contao\Controller;
 use Contao\StringUtil;
 
 $GLOBALS['TL_DCA']['tl_module']['palettes']['member_organizations'] = '{title_legend},name,headline,type;{eventmanager_legend},editPage;{protected_legend:hide},protected;{expert_legend:hide},guests,cssID';
@@ -157,3 +158,15 @@ $GLOBALS['TL_DCA']['tl_module']['fields']['eventListDomId'] = [
     'eval' => ['includeBlankOption' => true, 'chosen' => true, 'tl_class' => 'w50'],
     'sql' => ['type' => 'string', 'length' => 128, 'default' => ''],
 ];
+
+if (isset($GLOBALS['TL_DCA']['tl_module']['fields']['list_layout'])) {
+    $GLOBALS['TL_DCA']['tl_module']['fields']['list_layout']['options_callback'] = static function (): array {
+        $options = Controller::getTemplateGroup('list_');
+
+        if (!isset($options['list_default_organisationen'])) {
+            $options['list_default_organisationen'] = 'list_default_organisationen';
+        }
+
+        return $options;
+    };
+}

contao/templates/frontend/event_filter.html.twig

@@ -2,8 +2,8 @@
     <div class="select-filters">
         <div class="widget-select category">
             <label for="tag-filter" class="visually-hidden">Kategorie wählen</label>
-            <select id="tag-filter">
+            <select id="tag-filter" placeholder="Kategorie wählen" autocomplete="off">
-                <option value="all" data-placeholder="true">Kategorie wählen</option>
+                <option value="">Kategorie wählen</option>
                 {% for tag in tagButtons|default([]) %}
                     <option value="tag-{{ tag.id }}">{{ tag.title }} ({{ tag.count }})</option>
                 {% endfor %}
@@ -12,8 +12,8 @@
 
         <div class="widget-select places">
             <label for="location-filter" class="visually-hidden">Ort wählen</label>
-            <select id="location-filter">
+            <select id="location-filter" placeholder="Ort wählen" autocomplete="off">
-                <option value="all" data-placeholder="true">Ort wählen</option>
+                <option value="">Ort wählen</option>
                 {% for location in locations|default([]) %}
                     <option value="location-{{ location.id }}">{{ location.title }} ({{ location.count }})</option>
                 {% endfor %}
@@ -22,8 +22,8 @@
 
         <div class="widget-select org">
             <label for="org-filter" class="visually-hidden">Veranstalter wählen</label>
-            <select id="org-filter">
+            <select id="org-filter" placeholder="Veranstalter wählen" autocomplete="off">
-                <option value="all" data-placeholder="true">Veranstalter wählen</option>
+                <option value="">Veranstalter wählen</option>
                 {% for organization in organizations|default([]) %}
                     <option value="org-{{ organization.id }}">{{ organization.title }} ({{ organization.count }})</option>
                 {% endfor %}
@@ -31,6 +31,8 @@
         </div>
     </div>
 
+    <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>
 
@@ -66,18 +68,36 @@
         pointer-events: none;
     }
 
-    #eventfilters .widget-select.active .ss-main {
+    #eventfilters .widget-select.active .ts-control {
-        outline: 2px solid currentColor;
+        outline: 3px solid currentColor;
-        outline-offset: 2px;
+        outline-offset: 3px;
     }
 
-    #eventfilters .ss-main:focus-visible {
+    #eventfilters .ts-control:focus-within {
-        outline: 2px solid currentColor;
+        outline: 3px solid currentColor;
-        outline-offset: 2px;
+        outline-offset: 3px;
     }
+
+    #eventfilters .eventfilter-reset[hidden] {
+        display: none;
+    }
+
+    #eventfilters .ts-wrapper.single .ts-control {
+        background-image: url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'%3E%3Cpath fill='none' stroke='%23343a40' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='m2 5 6 6 6-6'/%3E%3C/svg%3E");
+        background-repeat: no-repeat;
+        background-position: right 0.75rem center;
+        background-size: 16px 12px;
+        padding-right: 2rem;
+    }
+
+    #eventfilters .ts-wrapper.single .ts-control > input {
+        width: auto;
+    }
+
 </style>
 
-<script src="https://cdn.jsdelivr.net/npm/slim-select@3/dist/slimselect.min.js"></script>
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/tom-select@2.4.3/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 type="module">
     const filters = document.getElementById('eventfilters');
@@ -102,32 +122,41 @@
     const tagWidget = tagSelect?.closest('.widget-select');
     const locationWidget = locationSelect?.closest('.widget-select');
     const orgWidget = orgSelect?.closest('.widget-select');
+    const resetButton = filters.querySelector('#eventfilter-reset');
     const status = filters.querySelector('#eventfilter-status');
 
     const animationMs = 220;
     let hideTimers = new WeakMap();
-    let currentFilter = { type: 'all', value: 'all' };
+    let currentFilter = { type: 'all', value: '' };
     let suppressedChangeEvents = 0;
 
-    const initSlimSelect = (selectElement) => {
+    const initTomSelect = (selectElement) => {
-        if (!selectElement || 'undefined' === typeof window.SlimSelect) {
+        if (!selectElement || 'undefined' === typeof window.TomSelect) {
             return null;
         }
 
-        return new window.SlimSelect({
+        return new window.TomSelect(selectElement, {
-            select: selectElement,
+            create: false,
-            settings: {
+            sortField: {
-                showSearch: false,
+                field: 'text',
-                allowDeselect: false,
+                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>';
+                },
             },
         });
     };
 
-    const tagSlim = initSlimSelect(tagSelect);
+    const tagTom = initTomSelect(tagSelect);
-    const locationSlim = initSlimSelect(locationSelect);
+    const locationTom = initTomSelect(locationSelect);
-    const orgSlim = initSlimSelect(orgSelect);
+    const orgTom = initTomSelect(orgSelect);
 
-    const setSelectValue = (selectElement, slimInstance, value) => {
+    const setSelectValue = (selectElement, tomInstance, value) => {
         if (!selectElement) {
             return;
         }
@@ -139,8 +168,8 @@
         suppressedChangeEvents += 1;
 
         try {
-            if (slimInstance) {
+            if (tomInstance) {
-                slimInstance.setSelected(value);
+                tomInstance.setValue(value, true);
             } else {
                 selectElement.value = value;
             }
@@ -182,13 +211,17 @@
     };
 
     const setActiveControl = ({ type, value }) => {
-        const hasActiveTag = type === 'tag' && value !== 'all';
+        const hasActiveTag = type === 'tag' && Boolean(value);
-        const hasActiveLocation = type === 'location' && value !== 'all';
+        const hasActiveLocation = type === 'location' && Boolean(value);
-        const hasActiveOrg = type === 'org' && value !== 'all';
+        const hasActiveOrg = type === 'org' && Boolean(value);
 
         tagWidget?.classList.toggle('active', hasActiveTag);
         locationWidget?.classList.toggle('active', hasActiveLocation);
         orgWidget?.classList.toggle('active', hasActiveOrg);
+
+        if (resetButton) {
+            resetButton.hidden = !(hasActiveTag || hasActiveLocation || hasActiveOrg);
+        }
     };
 
     const parseIdList = (rawValue) => (rawValue ?? '')
@@ -197,7 +230,7 @@
         .filter(Boolean);
 
     const matches = (eventItem, filterState) => {
-        if (filterState.value === 'all') {
+        if (!filterState.value || filterState.type === 'all') {
             return true;
         }
 
@@ -213,10 +246,6 @@
             return parseIdList(eventItem.dataset.org).includes(filterState.value);
         }
 
-        if (filterState.type === 'all') {
-            return true;
-        }
-
         return true;
     };
 
@@ -268,12 +297,12 @@
 
         const selectedValue = tagSelect.value;
 
-        setSelectValue(locationSelect, locationSlim, 'all');
+        setSelectValue(locationSelect, locationTom, '');
-        setSelectValue(orgSelect, orgSlim, 'all');
+        setSelectValue(orgSelect, orgTom, '');
 
         applyFilter(
-            selectedValue === 'all'
+            !selectedValue
-                ? { type: 'all', value: 'all' }
+                ? { type: 'all', value: '' }
                 : { type: 'tag', value: selectedValue.replace('tag-', '') },
         );
     });
@@ -285,12 +314,12 @@
 
         const selectedValue = locationSelect.value;
 
-        setSelectValue(tagSelect, tagSlim, 'all');
+        setSelectValue(tagSelect, tagTom, '');
-        setSelectValue(orgSelect, orgSlim, 'all');
+        setSelectValue(orgSelect, orgTom, '');
 
         applyFilter(
-            selectedValue === 'all'
+            !selectedValue
-                ? { type: 'all', value: 'all' }
+                ? { type: 'all', value: '' }
                 : { type: 'location', value: selectedValue.replace('location-', '') },
         );
     });
@@ -302,15 +331,23 @@
 
         const selectedValue = orgSelect.value;
 
-        setSelectValue(tagSelect, tagSlim, 'all');
+        setSelectValue(tagSelect, tagTom, '');
-        setSelectValue(locationSelect, locationSlim, 'all');
+        setSelectValue(locationSelect, locationTom, '');
 
         applyFilter(
-            selectedValue === 'all'
+            !selectedValue
-                ? { type: 'all', value: 'all' }
+                ? { type: 'all', value: '' }
                 : { type: 'org', value: selectedValue.replace('org-', '') },
         );
     });
 
+    resetButton?.addEventListener('click', () => {
+        setSelectValue(tagSelect, tagTom, '');
+        setSelectValue(locationSelect, locationTom, '');
+        setSelectValue(orgSelect, orgTom, '');
+
+        applyFilter({ type: 'all', value: '' });
+    });
+
     applyFilter(currentFilter);
 </script>

src/EventListener/OrganizationListingTemplateDataListener.php

@@ -0,0 +1,326 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MummertMedia\EventManagerBundle\EventListener;
+
+use Contao\CoreBundle\DependencyInjection\Attribute\AsHook;
+use Contao\StringUtil;
+use Contao\Template;
+use Doctrine\DBAL\ArrayParameterType;
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\ParameterType;
+use Psr\Log\LoggerInterface;
+
+#[AsHook('parseTemplate', method: 'onParseTemplate')]
+class OrganizationListingTemplateDataListener
+{
+    public function __construct(
+        private readonly Connection $connection,
+        private readonly ?LoggerInterface $logger = null,
+    ) {
+    }
+
+    public function onParseTemplate(Template $template): void
+    {
+        if ('list_default_organisationen' !== (string) $template->getName()) {
+            return;
+        }
+
+        $tbody = $template->tbody;
+
+        if (!\is_array($tbody) || [] === $tbody) {
+            return;
+        }
+
+        $rowToOrganizationIdMap = [];
+
+        foreach ($tbody as $rowIndex => $row) {
+            if (!\is_array($row)) {
+                continue;
+            }
+
+            $organizationId = $this->extractOrganizationId($row);
+
+            if ($organizationId > 0) {
+                $rowToOrganizationIdMap[(int) $rowIndex] = $organizationId;
+            }
+        }
+
+        if ([] === $rowToOrganizationIdMap) {
+            return;
+        }
+
+        $organizationIds = array_values(array_unique(array_values($rowToOrganizationIdMap)));
+        $organizationTagMap = $this->fetchOrganizationTagMap($organizationIds);
+        $organizationLogoUuidMap = $this->fetchOrganizationLogoUuidMap($organizationIds);
+
+        $organizationTagLabelMap = [];
+        $rowTagIdsList = [];
+
+        foreach ($organizationTagMap as $tagData) {
+            foreach (($tagData['ids'] ?? []) as $index => $tagId) {
+                $label = trim((string) (($tagData['labels'][$index] ?? '') ?: ''));
+
+                if ('' !== $tagId && '' !== $label && !isset($organizationTagLabelMap[(string) $tagId])) {
+                    $organizationTagLabelMap[(string) $tagId] = $label;
+                }
+            }
+        }
+
+        foreach ($rowToOrganizationIdMap as $rowIndex => $organizationId) {
+            if (!isset($tbody[$rowIndex]) || !\is_array($tbody[$rowIndex])) {
+                continue;
+            }
+
+            $tagData = $organizationTagMap[$organizationId] ?? ['ids' => [], 'labels' => []];
+            $logoUuid = $organizationLogoUuidMap[$organizationId] ?? '';
+            $tagIdsCsv = implode(',', $tagData['ids']);
+            $tagLabelsCsv = implode(', ', $tagData['labels']);
+
+            $tbody[$rowIndex]['tag_ids']['content'] = $tagIdsCsv;
+            $tbody[$rowIndex]['tag_labels']['content'] = $tagLabelsCsv;
+            $tbody[$rowIndex]['tags']['content'] = $tagLabelsCsv;
+
+            if ('' !== $logoUuid) {
+                $tbody[$rowIndex]['logo_uuid']['content'] = $logoUuid;
+            }
+        }
+
+        foreach ($tbody as $rowIndex => $row) {
+            if (!\is_array($row)) {
+                $rowTagIdsList[] = '';
+                continue;
+            }
+
+            $organizationId = $rowToOrganizationIdMap[(int) $rowIndex] ?? 0;
+            $rowTagIdsList[] = ($organizationId > 0 && isset($organizationTagMap[$organizationId]))
+                ? implode(',', $organizationTagMap[$organizationId]['ids'] ?? [])
+                : '';
+        }
+
+        if (null !== $this->logger) {
+            $rowsWithoutTagIds = 0;
+
+            foreach ($rowToOrganizationIdMap as $organizationId) {
+                if (!isset($organizationTagMap[$organizationId]) || [] === ($organizationTagMap[$organizationId]['ids'] ?? [])) {
+                    ++$rowsWithoutTagIds;
+                }
+            }
+
+            if ($rowsWithoutTagIds > 0) {
+                $this->logger->warning('Organization listing enrichment found rows without tag IDs.', [
+                    'template' => (string) $template->getName(),
+                    'totalRows' => \count($tbody),
+                    'mappedRows' => \count($rowToOrganizationIdMap),
+                    'rowsWithoutTagIds' => $rowsWithoutTagIds,
+                ]);
+            }
+        }
+
+        $template->organization_tag_label_map = $organizationTagLabelMap;
+        $template->organization_row_tag_ids_list = $rowTagIdsList;
+
+        $template->tbody = $tbody;
+    }
+
+    /** @param array<string, mixed> $row */
+    private function extractOrganizationId(array $row): int
+    {
+        foreach (['id', 'organization_id', 'org_id'] as $fieldName) {
+            if (isset($row[$fieldName]) && \is_scalar($row[$fieldName]) && ctype_digit((string) $row[$fieldName])) {
+                return (int) $row[$fieldName];
+            }
+
+            $value = $this->extractRowFieldContent($row, $fieldName);
+
+            if ('' !== $value && ctype_digit($value)) {
+                return (int) $value;
+            }
+        }
+
+        foreach ($row as $column) {
+            if (!\is_array($column)) {
+                continue;
+            }
+
+            foreach (['url', 'href'] as $urlField) {
+                if (!isset($column[$urlField]) || !\is_scalar($column[$urlField])) {
+                    continue;
+                }
+
+                $organizationId = $this->extractIdFromUrl((string) $column[$urlField]);
+
+                if ($organizationId > 0) {
+                    return $organizationId;
+                }
+            }
+        }
+
+        return 0;
+    }
+
+    /** @param array<string, mixed> $row */
+    private function extractRowFieldContent(array $row, string $fieldName): string
+    {
+        if (!isset($row[$fieldName])) {
+            return '';
+        }
+
+        if (\is_scalar($row[$fieldName])) {
+            return trim((string) $row[$fieldName]);
+        }
+
+        if (!\is_array($row[$fieldName])) {
+            return '';
+        }
+
+        $field = $row[$fieldName];
+
+        if (!isset($field['content']) || !\is_scalar($field['content'])) {
+            return '';
+        }
+
+        return trim((string) $field['content']);
+    }
+
+    private function extractIdFromUrl(string $url): int
+    {
+        $parts = parse_url($url);
+
+        if (!\is_array($parts) || !isset($parts['query'])) {
+            return 0;
+        }
+
+        parse_str((string) $parts['query'], $query);
+
+        foreach (['show', 'id'] as $queryKey) {
+            if (!isset($query[$queryKey])) {
+                continue;
+            }
+
+            $value = $query[$queryKey];
+
+            if (\is_scalar($value) && ctype_digit((string) $value)) {
+                return (int) $value;
+            }
+        }
+
+        return 0;
+    }
+
+    /** @param list<int> $organizationIds
+     *  @return array<int, array{ids: list<string>, labels: list<string>}>
+     */
+    private function fetchOrganizationTagMap(array $organizationIds): array
+    {
+        if ([] === $organizationIds) {
+            return [];
+        }
+
+        $rows = $this->connection->executeQuery(
+            'SELECT r.pid AS organization_id, r.tag_id, t.tag AS label
+             FROM tl_tags_rel r
+             INNER JOIN tl_tags t ON t.id = r.tag_id
+             WHERE r.ptable = ? AND r.field = ? AND r.pid IN (?)
+             ORDER BY r.pid ASC, r.tag_id ASC',
+            ['tl_organization', 'tags', $organizationIds],
+            [ParameterType::STRING, ParameterType::STRING, ArrayParameterType::INTEGER],
+        )->fetchAllAssociative();
+
+        if ([] === $rows) {
+            $rows = $this->connection->executeQuery(
+                'SELECT r.pid AS organization_id, r.tag_id, t.tag AS label
+                 FROM tl_tags_rel r
+                 INNER JOIN tl_tags t ON t.id = r.tag_id
+                 WHERE r.ptable = ? AND r.pid IN (?)
+                 ORDER BY r.pid ASC, r.tag_id ASC',
+                ['tl_organization', $organizationIds],
+                [ParameterType::STRING, ArrayParameterType::INTEGER],
+            )->fetchAllAssociative();
+        }
+
+        $map = [];
+        $seen = [];
+
+        foreach ($rows as $row) {
+            $organizationId = (int) ($row['organization_id'] ?? 0);
+            $tagId = (int) ($row['tag_id'] ?? 0);
+            $label = trim((string) ($row['label'] ?? ''));
+
+            if ($organizationId <= 0 || $tagId <= 0 || '' === $label || isset($seen[$organizationId][$tagId])) {
+                continue;
+            }
+
+            $seen[$organizationId][$tagId] = true;
+            $map[$organizationId]['ids'][] = (string) $tagId;
+            $map[$organizationId]['labels'][] = $label;
+        }
+
+        foreach ($map as $organizationId => $tagData) {
+            $map[$organizationId]['ids'] = array_values(array_unique($tagData['ids'] ?? []));
+            $map[$organizationId]['labels'] = array_values(array_unique($tagData['labels'] ?? []));
+        }
+
+        return $map;
+    }
+
+    /** @param list<int> $organizationIds
+     *  @return array<int, string>
+     */
+    private function fetchOrganizationLogoUuidMap(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 (?)',
+            [$organizationIds],
+            [ArrayParameterType::INTEGER],
+        )->fetchAllAssociative();
+
+        $map = [];
+
+        foreach ($rows as $row) {
+            $organizationId = (int) ($row['organization_id'] ?? 0);
+            $logoUuid = $this->normalizeUuid($row['logo_uuid'] ?? null);
+
+            if ($organizationId <= 0 || '' === $logoUuid) {
+                continue;
+            }
+
+            $map[$organizationId] = $logoUuid;
+        }
+
+        return $map;
+    }
+
+    private function normalizeUuid(mixed $value): string
+    {
+        if (null === $value) {
+            return '';
+        }
+
+        if (\is_resource($value)) {
+            $value = stream_get_contents($value) ?: '';
+        }
+
+        $trimmed = trim((string) $value);
+
+        if ('' === $trimmed) {
+            return '';
+        }
+
+        if (preg_match('/^[0-9a-fA-F-]{36}$/', $trimmed)) {
+            return strtolower($trimmed);
+        }
+
+        if (16 === strlen($trimmed)) {
+            return StringUtil::binToUuid($trimmed);
+        }
+
+        return '';
+    }
+
+}