Improve Tom Select usability and accessibility defaults

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,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>
@@ -68,28 +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 .ss-content,
+    #eventfilters .ts-wrapper.single .ts-control {
-    #eventfilters .ss-list {
+        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");
-        overscroll-behavior: contain;
+        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>
 
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/slim-select@3/dist/slimselect.css">
+<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/slim-select@3/dist/slimselect.min.js"></script>
+<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');
@@ -119,28 +127,36 @@
 
     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;
         }
@@ -152,8 +168,8 @@
         suppressedChangeEvents += 1;
 
         try {
-            if (slimInstance) {
+            if (tomInstance) {
-                slimInstance.setSelected(value);
+                tomInstance.setValue(value, true);
             } else {
                 selectElement.value = value;
             }
@@ -195,9 +211,9 @@
     };
 
     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);
@@ -214,7 +230,7 @@
         .filter(Boolean);
 
     const matches = (eventItem, filterState) => {
-        if (filterState.value === 'all') {
+        if (!filterState.value || filterState.type === 'all') {
             return true;
         }
 
@@ -230,10 +246,6 @@
             return parseIdList(eventItem.dataset.org).includes(filterState.value);
         }
 
-        if (filterState.type === 'all') {
-            return true;
-        }
-
         return true;
     };
 
@@ -285,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-', '') },
         );
     });
@@ -302,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-', '') },
         );
     });
@@ -319,128 +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, tagSlim, 'all');
+        setSelectValue(tagSelect, tagTom, '');
-        setSelectValue(locationSelect, locationSlim, 'all');
+        setSelectValue(locationSelect, locationTom, '');
-        setSelectValue(orgSelect, orgSlim, 'all');
+        setSelectValue(orgSelect, orgTom, '');
 
-        applyFilter({ type: 'all', value: 'all' });
+        applyFilter({ type: 'all', value: '' });
     });
 
-    const getDropdownFromTarget = (target) => {
-        if (!(target instanceof Element)) {
-            return null;
-        }
-
-        return target.closest('.ss-content, .ss-list');
-    };
-
-    const getScrollContainer = (targetDropdown) => {
-        if (!targetDropdown) {
-            return null;
-        }
-
-        if (targetDropdown.scrollHeight > targetDropdown.clientHeight) {
-            return targetDropdown;
-        }
-
-        const contentContainer = targetDropdown.closest('.ss-content') || targetDropdown;
-        const listContainer = contentContainer.querySelector('.ss-list');
-
-        if (listContainer && listContainer.scrollHeight > listContainer.clientHeight) {
-            return listContainer;
-        }
-
-        if (contentContainer.scrollHeight > contentContainer.clientHeight) {
-            return contentContainer;
-        }
-
-        return null;
-    };
-
-    const shouldBlockBoundaryScroll = (scrollContainer, delta) => {
-        if (!scrollContainer || delta === 0) {
-            return false;
-        }
-
-        const top = scrollContainer.scrollTop;
-        const height = scrollContainer.clientHeight;
-        const scrollHeight = scrollContainer.scrollHeight;
-
-        const atTop = top <= 0;
-        const atBottom = top + height >= scrollHeight - 1;
-
-        return (atTop && delta < 0) || (atBottom && delta > 0);
-    };
-
-    let lastTouchY = null;
-
-    document.addEventListener('wheel', (event) => {
-        const dropdown = getDropdownFromTarget(event.target);
-        if (!dropdown) {
-            return;
-        }
-
-        const scrollContainer = getScrollContainer(dropdown);
-
-        if (shouldBlockBoundaryScroll(scrollContainer, event.deltaY)) {
-            event.preventDefault();
-        }
-
-        event.stopPropagation();
-    }, { passive: false, capture: true });
-
-    document.addEventListener('touchstart', (event) => {
-        const dropdown = getDropdownFromTarget(event.target);
-        if (!dropdown || event.touches.length === 0) {
-            lastTouchY = null;
-            return;
-        }
-
-        lastTouchY = event.touches[0].clientY;
-    }, { passive: true, capture: true });
-
-    document.addEventListener('touchmove', (event) => {
-        const dropdown = getDropdownFromTarget(event.target);
-        if (!dropdown || event.touches.length === 0 || lastTouchY === null) {
-            return;
-        }
-
-        const scrollContainer = getScrollContainer(dropdown);
-
-        if (!scrollContainer) {
-            return;
-        }
-
-        const currentTouchY = event.touches[0].clientY;
-        const delta = lastTouchY - currentTouchY;
-
-        if (shouldBlockBoundaryScroll(scrollContainer, delta)) {
-            event.preventDefault();
-        }
-
-        event.stopPropagation();
-
-        lastTouchY = currentTouchY;
-    }, { passive: false, capture: true });
-
-    document.addEventListener('touchend', () => {
-        lastTouchY = null;
-    }, { passive: true, capture: true });
-
-    document.addEventListener('touchcancel', () => {
-        lastTouchY = null;
-    }, { passive: true, capture: true });
-
     applyFilter(currentFilter);
 </script>