Skip to content

A11y enhancements for SelectField. #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 4, 2023
Merged

A11y enhancements for SelectField. #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 19 additions & 11 deletions src/lib/components/SelectField.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@
$: logger.debug({ searchText });

export let value: any = undefined;
let prevValue = undefined;
export let selected = undefined;
let prevSelected = undefined;
let prevValue: any = undefined;
export let selected: any = undefined;
let prevSelected: any = undefined;

function updateSelected(selected, value, options) {
function updateSelected(selected: any, value: any, options: any) {
logger.debug('updateSelected', {
value,
prevValue,
Expand Down Expand Up @@ -187,15 +187,16 @@
show();
}

function onBlur(e: FocusEvent) {
logger.debug('onBlur', { target: e.target, relatedTarget: e.relatedTarget, menuOptionsEl });
function onBlur(e: FocusEvent|CustomEvent<any>) {
const fe = e as FocusEvent;
logger.debug('onBlur', { target: e.target, relatedTarget: fe?.relatedTarget, menuOptionsEl });

// Hide if focus not moved to menu (option clicked)
if (
e.relatedTarget instanceof HTMLElement &&
!menuOptionsEl?.contains(e.relatedTarget) && // TODO: Oddly Safari does not set `relatedTarget` to the clicked on menu option (like Chrome and Firefox) but instead appears to take `tabindex` into consideration. Currently resolves to `.options` after setting `tabindex="-1"
e.relatedTarget !== menuOptionsEl?.offsetParent && // click on scroll bar
!e.relatedTarget.closest('menu > [slot=actions]') // click on action item
fe.relatedTarget instanceof HTMLElement &&
!menuOptionsEl?.contains(fe.relatedTarget) && // TODO: Oddly Safari does not set `relatedTarget` to the clicked on menu option (like Chrome and Firefox) but instead appears to take `tabindex` into consideration. Currently resolves to `.options` after setting `tabindex="-1"
fe.relatedTarget !== menuOptionsEl?.offsetParent && // click on scroll bar
!fe.relatedTarget.closest('menu > [slot=actions]') // click on action item
) {
hide('blur');
} else {
Expand Down Expand Up @@ -335,7 +336,7 @@
</script>

<!-- svelte-ignore a11y-click-events-have-key-events -->
<div class={cls('SelectField', theme.root, classes.root, $$props.class)} on:click={onClick}>
<div role="button" tabindex="-1" aria-pressed={open ? "true" : "false"} class={cls('SelectField', theme.root, classes.root, $$props.class)} on:click={onClick}>
<TextField
{label}
{placeholder}
Expand All @@ -353,6 +354,8 @@
on:keypress={onKeyPress}
actions={(node) => [selectOnFocus(node)]}
class={cls('h-full', theme.field, classes.field)}
role="combobox"
aria-expanded={open ? "true" : "false"}
{...$$restProps}
>
<slot slot="prepend" name="prepend" />
Expand Down Expand Up @@ -399,7 +402,9 @@
{...menuProps}
>
<div
role="listbox"
tabindex="-1"
aria-expanded={open ? "true" : "false"}
class={cls('options group p-1 focus:outline-none', theme.options, classes.options)}
class:opacity-50={loading}
bind:this={menuOptionsEl}
Expand Down Expand Up @@ -448,6 +453,9 @@
classes.option
)}
scrollIntoView={index === highlightIndex}
role="option"
aria-selected={option === selected ? "true" : "false"}
aria-disabled={option?.disabled ? "true" : "false"}
>
{optionText(option)}
</MenuItem>
Expand Down
3 changes: 2 additions & 1 deletion src/lib/components/TextField.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
export let accept: string | RegExp | undefined = undefined;
// https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autocapitalize
export let autocapitalize: ComponentProps<Input>['autocapitalize'] = undefined;
export let role: AriaRole | undefined = undefined;

let inputType = 'text';
$: switch (type) {
Expand Down Expand Up @@ -240,7 +241,7 @@
{/if}

<!-- svelte-ignore a11y-click-events-have-key-events -->
<div class="flex-grow inline-grid" on:click>
<div role={role === "combobox" ? role : undefined} class="flex-grow inline-grid" on:click>
{#if label && ['inset', 'float'].includes(labelPlacement)}
<label
class={cls(
Expand Down