|
|
@ -1,5 +1,6 @@ |
|
|
|
import $ from 'jquery'; |
|
|
|
import $ from 'jquery'; |
|
|
|
import {generateAriaId} from './base.ts'; |
|
|
|
import {generateAriaId} from './base.ts'; |
|
|
|
|
|
|
|
import type {FomanticInitFunction} from '../../types.ts'; |
|
|
|
|
|
|
|
|
|
|
|
const ariaPatchKey = '_giteaAriaPatchDropdown'; |
|
|
|
const ariaPatchKey = '_giteaAriaPatchDropdown'; |
|
|
|
const fomanticDropdownFn = $.fn.dropdown; |
|
|
|
const fomanticDropdownFn = $.fn.dropdown; |
|
|
@ -8,13 +9,13 @@ const fomanticDropdownFn = $.fn.dropdown; |
|
|
|
export function initAriaDropdownPatch() { |
|
|
|
export function initAriaDropdownPatch() { |
|
|
|
if ($.fn.dropdown === ariaDropdownFn) throw new Error('initAriaDropdownPatch could only be called once'); |
|
|
|
if ($.fn.dropdown === ariaDropdownFn) throw new Error('initAriaDropdownPatch could only be called once'); |
|
|
|
$.fn.dropdown = ariaDropdownFn; |
|
|
|
$.fn.dropdown = ariaDropdownFn; |
|
|
|
ariaDropdownFn.settings = fomanticDropdownFn.settings; |
|
|
|
(ariaDropdownFn as FomanticInitFunction).settings = fomanticDropdownFn.settings; |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
// the patched `$.fn.dropdown` function, it passes the arguments to Fomantic's `$.fn.dropdown` function, and:
|
|
|
|
// the patched `$.fn.dropdown` function, it passes the arguments to Fomantic's `$.fn.dropdown` function, and:
|
|
|
|
// * it does the one-time attaching on the first call
|
|
|
|
// * it does the one-time attaching on the first call
|
|
|
|
// * it delegates the `onLabelCreate` to the patched `onLabelCreate` to add necessary aria attributes
|
|
|
|
// * it delegates the `onLabelCreate` to the patched `onLabelCreate` to add necessary aria attributes
|
|
|
|
function ariaDropdownFn(...args) { |
|
|
|
function ariaDropdownFn(...args: Parameters<FomanticInitFunction>) { |
|
|
|
const ret = fomanticDropdownFn.apply(this, args); |
|
|
|
const ret = fomanticDropdownFn.apply(this, args); |
|
|
|
|
|
|
|
|
|
|
|
// if the `$().dropdown()` call is without arguments, or it has non-string (object) argument,
|
|
|
|
// if the `$().dropdown()` call is without arguments, or it has non-string (object) argument,
|
|
|
@ -33,7 +34,7 @@ function ariaDropdownFn(...args) { |
|
|
|
|
|
|
|
|
|
|
|
// make the item has role=option/menuitem, add an id if there wasn't one yet, make items as non-focusable
|
|
|
|
// make the item has role=option/menuitem, add an id if there wasn't one yet, make items as non-focusable
|
|
|
|
// the elements inside the dropdown menu item should not be focusable, the focus should always be on the dropdown primary element.
|
|
|
|
// the elements inside the dropdown menu item should not be focusable, the focus should always be on the dropdown primary element.
|
|
|
|
function updateMenuItem(dropdown, item) { |
|
|
|
function updateMenuItem(dropdown: HTMLElement, item: HTMLElement) { |
|
|
|
if (!item.id) item.id = generateAriaId(); |
|
|
|
if (!item.id) item.id = generateAriaId(); |
|
|
|
item.setAttribute('role', dropdown[ariaPatchKey].listItemRole); |
|
|
|
item.setAttribute('role', dropdown[ariaPatchKey].listItemRole); |
|
|
|
item.setAttribute('tabindex', '-1'); |
|
|
|
item.setAttribute('tabindex', '-1'); |
|
|
@ -43,7 +44,7 @@ function updateMenuItem(dropdown, item) { |
|
|
|
* make the label item and its "delete icon" have correct aria attributes |
|
|
|
* make the label item and its "delete icon" have correct aria attributes |
|
|
|
* @param {HTMLElement} label |
|
|
|
* @param {HTMLElement} label |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
function updateSelectionLabel(label) { |
|
|
|
function updateSelectionLabel(label: HTMLElement) { |
|
|
|
// the "label" is like this: "<a|div class="ui label" data-value="1">the-label-name <i|svg class="delete icon"/></a>"
|
|
|
|
// the "label" is like this: "<a|div class="ui label" data-value="1">the-label-name <i|svg class="delete icon"/></a>"
|
|
|
|
if (!label.id) { |
|
|
|
if (!label.id) { |
|
|
|
label.id = generateAriaId(); |
|
|
|
label.id = generateAriaId(); |
|
|
@ -59,7 +60,7 @@ function updateSelectionLabel(label) { |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
// delegate the dropdown's template functions and callback functions to add aria attributes.
|
|
|
|
// delegate the dropdown's template functions and callback functions to add aria attributes.
|
|
|
|
function delegateOne($dropdown) { |
|
|
|
function delegateOne($dropdown: any) { |
|
|
|
const dropdownCall = fomanticDropdownFn.bind($dropdown); |
|
|
|
const dropdownCall = fomanticDropdownFn.bind($dropdown); |
|
|
|
|
|
|
|
|
|
|
|
// If there is a "search input" in the "menu", Fomantic will only "focus the input" but not "toggle the menu" when the "dropdown icon" is clicked.
|
|
|
|
// If there is a "search input" in the "menu", Fomantic will only "focus the input" but not "toggle the menu" when the "dropdown icon" is clicked.
|
|
|
@ -74,7 +75,7 @@ function delegateOne($dropdown) { |
|
|
|
// the "template" functions are used for dynamic creation (eg: AJAX)
|
|
|
|
// the "template" functions are used for dynamic creation (eg: AJAX)
|
|
|
|
const dropdownTemplates = {...dropdownCall('setting', 'templates'), t: performance.now()}; |
|
|
|
const dropdownTemplates = {...dropdownCall('setting', 'templates'), t: performance.now()}; |
|
|
|
const dropdownTemplatesMenuOld = dropdownTemplates.menu; |
|
|
|
const dropdownTemplatesMenuOld = dropdownTemplates.menu; |
|
|
|
dropdownTemplates.menu = function(response, fields, preserveHTML, className) { |
|
|
|
dropdownTemplates.menu = function(response: any, fields: any, preserveHTML: any, className: Record<string, string>) { |
|
|
|
// when the dropdown menu items are loaded from AJAX requests, the items are created dynamically
|
|
|
|
// when the dropdown menu items are loaded from AJAX requests, the items are created dynamically
|
|
|
|
const menuItems = dropdownTemplatesMenuOld(response, fields, preserveHTML, className); |
|
|
|
const menuItems = dropdownTemplatesMenuOld(response, fields, preserveHTML, className); |
|
|
|
const div = document.createElement('div'); |
|
|
|
const div = document.createElement('div'); |
|
|
@ -89,7 +90,7 @@ function delegateOne($dropdown) { |
|
|
|
|
|
|
|
|
|
|
|
// the `onLabelCreate` is used to add necessary aria attributes for dynamically created selection labels
|
|
|
|
// the `onLabelCreate` is used to add necessary aria attributes for dynamically created selection labels
|
|
|
|
const dropdownOnLabelCreateOld = dropdownCall('setting', 'onLabelCreate'); |
|
|
|
const dropdownOnLabelCreateOld = dropdownCall('setting', 'onLabelCreate'); |
|
|
|
dropdownCall('setting', 'onLabelCreate', function(value, text) { |
|
|
|
dropdownCall('setting', 'onLabelCreate', function(value: any, text: string) { |
|
|
|
const $label = dropdownOnLabelCreateOld.call(this, value, text); |
|
|
|
const $label = dropdownOnLabelCreateOld.call(this, value, text); |
|
|
|
updateSelectionLabel($label[0]); |
|
|
|
updateSelectionLabel($label[0]); |
|
|
|
return $label; |
|
|
|
return $label; |
|
|
@ -97,7 +98,7 @@ function delegateOne($dropdown) { |
|
|
|
|
|
|
|
|
|
|
|
const oldSet = dropdownCall('internal', 'set'); |
|
|
|
const oldSet = dropdownCall('internal', 'set'); |
|
|
|
const oldSetDirection = oldSet.direction; |
|
|
|
const oldSetDirection = oldSet.direction; |
|
|
|
oldSet.direction = function($menu) { |
|
|
|
oldSet.direction = function($menu: any) { |
|
|
|
oldSetDirection.call(this, $menu); |
|
|
|
oldSetDirection.call(this, $menu); |
|
|
|
const classNames = dropdownCall('setting', 'className'); |
|
|
|
const classNames = dropdownCall('setting', 'className'); |
|
|
|
$menu = $menu || $dropdown.find('> .menu'); |
|
|
|
$menu = $menu || $dropdown.find('> .menu'); |
|
|
@ -113,7 +114,7 @@ function delegateOne($dropdown) { |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
// for static dropdown elements (generated by server-side template), prepare them with necessary aria attributes
|
|
|
|
// for static dropdown elements (generated by server-side template), prepare them with necessary aria attributes
|
|
|
|
function attachStaticElements(dropdown, focusable, menu) { |
|
|
|
function attachStaticElements(dropdown: HTMLElement, focusable: HTMLElement, menu: HTMLElement) { |
|
|
|
// prepare static dropdown menu list popup
|
|
|
|
// prepare static dropdown menu list popup
|
|
|
|
if (!menu.id) { |
|
|
|
if (!menu.id) { |
|
|
|
menu.id = generateAriaId(); |
|
|
|
menu.id = generateAriaId(); |
|
|
@ -125,7 +126,7 @@ function attachStaticElements(dropdown, focusable, menu) { |
|
|
|
menu.setAttribute('role', dropdown[ariaPatchKey].listPopupRole); |
|
|
|
menu.setAttribute('role', dropdown[ariaPatchKey].listPopupRole); |
|
|
|
|
|
|
|
|
|
|
|
// prepare selection label items
|
|
|
|
// prepare selection label items
|
|
|
|
for (const label of dropdown.querySelectorAll('.ui.label')) { |
|
|
|
for (const label of dropdown.querySelectorAll<HTMLElement>('.ui.label')) { |
|
|
|
updateSelectionLabel(label); |
|
|
|
updateSelectionLabel(label); |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
@ -142,7 +143,7 @@ function attachStaticElements(dropdown, focusable, menu) { |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
function attachInit(dropdown) { |
|
|
|
function attachInit(dropdown: HTMLElement) { |
|
|
|
dropdown[ariaPatchKey] = {}; |
|
|
|
dropdown[ariaPatchKey] = {}; |
|
|
|
if (dropdown.classList.contains('custom')) return; |
|
|
|
if (dropdown.classList.contains('custom')) return; |
|
|
|
|
|
|
|
|
|
|
@ -161,7 +162,7 @@ function attachInit(dropdown) { |
|
|
|
|
|
|
|
|
|
|
|
// TODO: multiple selection is only partially supported. Check and test them one by one in the future.
|
|
|
|
// TODO: multiple selection is only partially supported. Check and test them one by one in the future.
|
|
|
|
|
|
|
|
|
|
|
|
const textSearch = dropdown.querySelector('input.search'); |
|
|
|
const textSearch = dropdown.querySelector<HTMLElement>('input.search'); |
|
|
|
const focusable = textSearch || dropdown; // the primary element for focus, see comment above
|
|
|
|
const focusable = textSearch || dropdown; // the primary element for focus, see comment above
|
|
|
|
if (!focusable) return; |
|
|
|
if (!focusable) return; |
|
|
|
|
|
|
|
|
|
|
@ -191,7 +192,7 @@ function attachInit(dropdown) { |
|
|
|
attachStaticElements(dropdown, focusable, menu); |
|
|
|
attachStaticElements(dropdown, focusable, menu); |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
function attachDomEvents(dropdown, focusable, menu) { |
|
|
|
function attachDomEvents(dropdown: HTMLElement, focusable: HTMLElement, menu: HTMLElement) { |
|
|
|
// when showing, it has class: ".animating.in"
|
|
|
|
// when showing, it has class: ".animating.in"
|
|
|
|
// when hiding, it has class: ".visible.animating.out"
|
|
|
|
// when hiding, it has class: ".visible.animating.out"
|
|
|
|
const isMenuVisible = () => (menu.classList.contains('visible') && !menu.classList.contains('out')) || menu.classList.contains('in'); |
|
|
|
const isMenuVisible = () => (menu.classList.contains('visible') && !menu.classList.contains('out')) || menu.classList.contains('in'); |
|
|
@ -215,7 +216,7 @@ function attachDomEvents(dropdown, focusable, menu) { |
|
|
|
} |
|
|
|
} |
|
|
|
}; |
|
|
|
}; |
|
|
|
|
|
|
|
|
|
|
|
dropdown.addEventListener('keydown', (e) => { |
|
|
|
dropdown.addEventListener('keydown', (e: KeyboardEvent) => { |
|
|
|
// here it must use keydown event before dropdown's keyup handler, otherwise there is no Enter event in our keyup handler
|
|
|
|
// here it must use keydown event before dropdown's keyup handler, otherwise there is no Enter event in our keyup handler
|
|
|
|
if (e.key === 'Enter') { |
|
|
|
if (e.key === 'Enter') { |
|
|
|
const dropdownCall = fomanticDropdownFn.bind($(dropdown)); |
|
|
|
const dropdownCall = fomanticDropdownFn.bind($(dropdown)); |
|
|
@ -260,7 +261,7 @@ function attachDomEvents(dropdown, focusable, menu) { |
|
|
|
deferredRefreshAriaActiveItem(100); |
|
|
|
deferredRefreshAriaActiveItem(100); |
|
|
|
}, 0); |
|
|
|
}, 0); |
|
|
|
}, true); |
|
|
|
}, true); |
|
|
|
dropdown.addEventListener('click', (e) => { |
|
|
|
dropdown.addEventListener('click', (e: MouseEvent) => { |
|
|
|
if (isMenuVisible() && |
|
|
|
if (isMenuVisible() && |
|
|
|
ignoreClickPreVisible !== 2 && // dropdown is switch from invisible to visible
|
|
|
|
ignoreClickPreVisible !== 2 && // dropdown is switch from invisible to visible
|
|
|
|
ignoreClickPreEvents === 2 // the click event is related to mousedown+focus
|
|
|
|
ignoreClickPreEvents === 2 // the click event is related to mousedown+focus
|
|
|
|