Skip to content

fix(a11y): accessible modal dismissal (Escape, focus trap, focus return) #4

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

Open
ocheeluma wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(a11y): accessible modal dismissal (Escape, focus trap, focus return) #4

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
76 changes: 55 additions & 21 deletions apps/web/src/components/retire-modal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'use client'

import { useRef, useState } from 'react'
import { useRef, useState, useEffect } from 'react'
import { X, Leaf } from 'lucide-react'
import { CopyableText } from './copy-button'

Expand All @@ -14,7 +14,48 @@ interface Props {
export function RetireModal({ certificateId, kwh, onConfirm, onClose }: Props) {
const [reason, setReason] = useState('')
const [submitting, setSubmitting] = useState(false)
const inputRef = useRef<HTMLTextAreaElement>(null)
const dialogRef = useRef<HTMLDivElement>(null)
const triggerRef = useRef<Element | null>(null)

// Capture triggering element and auto-focus dialog on mount; restore focus on unmount
useEffect(() => {
triggerRef.current = document.activeElement
dialogRef.current?.focus()
return () => {
(triggerRef.current as HTMLElement | null)?.focus()
}
}, [])

// Escape key closes the modal
useEffect(() => {
function handleKeyDown(e: KeyboardEvent) {
if (e.key === 'Escape') onClose()
}
document.addEventListener('keydown', handleKeyDown)
return () => document.removeEventListener('keydown', handleKeyDown)
}, [onClose])

// Focus trap: keep Tab inside the dialog
function handleTabKey(e: React.KeyboardEvent<HTMLDivElement>) {
if (e.key !== 'Tab') return
const focusable = dialogRef.current?.querySelectorAll<HTMLElement>(
'button:not([disabled]), [href], input:not([disabled]), textarea:not([disabled]), select:not([disabled]), [tabindex]:not([tabindex="-1"])'
)
if (!focusable || focusable.length === 0) return
const first = focusable[0]
const last = focusable[focusable.length - 1]
if (e.shiftKey) {
if (document.activeElement === first) {
e.preventDefault()
last.focus()
}
} else {
if (document.activeElement === last) {
e.preventDefault()
first.focus()
}
}
}

async function handleSubmit(e: React.FormEvent) {
e.preventDefault()
Expand All @@ -28,13 +69,18 @@ export function RetireModal({ certificateId, kwh, onConfirm, onClose }: Props) {

return (
<div
role="dialog"
aria-modal="true"
aria-labelledby="retire-title"
className="fixed inset-0 z-50 flex items-center justify-center bg-black/50 p-4"
onClick={(e) => e.target === e.currentTarget && onClose()}
>
<div className="w-full max-w-md rounded-xl bg-white p-6 shadow-xl dark:bg-gray-900">
<div
ref={dialogRef}
role="dialog"
aria-modal="true"
aria-labelledby="retire-title"
tabIndex={-1}
onKeyDown={handleTabKey}
className="w-full max-w-md rounded-xl bg-white p-6 shadow-xl outline-none dark:bg-gray-900"
>
<div className="mb-4 flex items-center justify-between">
<div className="flex items-center gap-2">
<Leaf className="h-5 w-5 text-green-500" aria-hidden="true" />
Expand All @@ -44,7 +90,7 @@ export function RetireModal({ certificateId, kwh, onConfirm, onClose }: Props) {
</div>
<button
onClick={onClose}
aria-label="Close"
aria-label="Close retire certificate dialog"
className="rounded p-1 text-gray-400 hover:text-gray-600 dark:hover:text-gray-200"
>
<X className="h-4 w-4" aria-hidden="true" />
Expand All @@ -68,7 +114,6 @@ export function RetireModal({ certificateId, kwh, onConfirm, onClose }: Props) {
</label>
<textarea
id="retire-reason"
ref={inputRef}
value={reason}
onChange={(e) => setReason(e.target.value)}
rows={3}
Expand Down Expand Up @@ -99,19 +144,8 @@ export function RetireModal({ certificateId, kwh, onConfirm, onClose }: Props) {
viewBox="0 0 24 24"
aria-hidden="true"
>
<circle
className="opacity-25"
cx="12"
cy="12"
r="10"
stroke="currentColor"
strokeWidth="4"
/>
<path
className="opacity-75"
fill="currentColor"
d="M4 12a8 8 0 018-8V0C5.373 0 0 5.373 0 12h4zm2 5.291A7.962 7.962 0 014 12H0c0 3.042 1.135 5.824 3 7.938l3-2.647z"
/>
<circle className="opacity-25" cx="12" cy="12" r="10" stroke="currentColor" strokeWidth="4" />
<path className="opacity-75" fill="currentColor" d="M4 12a8 8 0 018-8V0C5.373 0 0 5.373 0 12h4zm2 5.291A7.962 7.962 0 014 12H0c0 3.042 1.135 5.824 3 7.938l3-2.647z" />
</svg>
)}
{submitting ? 'Retiring…' : 'Confirm retirement'}
Expand Down
59 changes: 53 additions & 6 deletions apps/web/src/components/transfer-modal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'use client'

import { useState } from 'react'
import { useRef, useState, useEffect } from 'react'
import { X, ArrowRightLeft } from 'lucide-react'
import { CopyableText } from './copy-button'

Expand All @@ -14,6 +14,48 @@ interface Props {
export function TransferModal({ certificateId, kwh, onConfirm, onClose }: Props) {
const [toAddress, setToAddress] = useState('')
const [submitting, setSubmitting] = useState(false)
const dialogRef = useRef<HTMLDivElement>(null)
const triggerRef = useRef<Element | null>(null)

// Capture triggering element and auto-focus dialog on mount; restore focus on unmount
useEffect(() => {
triggerRef.current = document.activeElement
dialogRef.current?.focus()
return () => {
(triggerRef.current as HTMLElement | null)?.focus()
}
}, [])

// Escape key closes the modal
useEffect(() => {
function handleKeyDown(e: KeyboardEvent) {
if (e.key === 'Escape') onClose()
}
document.addEventListener('keydown', handleKeyDown)
return () => document.removeEventListener('keydown', handleKeyDown)
}, [onClose])

// Focus trap: keep Tab inside the dialog
function handleTabKey(e: React.KeyboardEvent<HTMLDivElement>) {
if (e.key !== 'Tab') return
const focusable = dialogRef.current?.querySelectorAll<HTMLElement>(
'button:not([disabled]), [href], input:not([disabled]), textarea:not([disabled]), select:not([disabled]), [tabindex]:not([tabindex="-1"])'
)
if (!focusable || focusable.length === 0) return
const first = focusable[0]
const last = focusable[focusable.length - 1]
if (e.shiftKey) {
if (document.activeElement === first) {
e.preventDefault()
last.focus()
}
} else {
if (document.activeElement === last) {
e.preventDefault()
first.focus()
}
}
}

async function handleSubmit(e: React.FormEvent) {
e.preventDefault()
Expand All @@ -27,13 +69,18 @@ export function TransferModal({ certificateId, kwh, onConfirm, onClose }: Props)

return (
<div
role="dialog"
aria-modal="true"
aria-labelledby="transfer-title"
className="fixed inset-0 z-50 flex items-center justify-center bg-black/50 p-4"
onClick={(e) => e.target === e.currentTarget && onClose()}
>
<div className="w-full max-w-md rounded-xl bg-white p-6 shadow-xl dark:bg-gray-900">
<div
ref={dialogRef}
role="dialog"
aria-modal="true"
aria-labelledby="transfer-title"
tabIndex={-1}
onKeyDown={handleTabKey}
className="w-full max-w-md rounded-xl bg-white p-6 shadow-xl outline-none dark:bg-gray-900"
>
<div className="mb-4 flex items-center justify-between">
<div className="flex items-center gap-2">
<ArrowRightLeft className="h-5 w-5 text-blue-500" aria-hidden="true" />
Expand All @@ -43,7 +90,7 @@ export function TransferModal({ certificateId, kwh, onConfirm, onClose }: Props)
</div>
<button
onClick={onClose}
aria-label="Close"
aria-label="Close transfer certificate dialog"
className="rounded p-1 text-gray-400 hover:text-gray-600 dark:hover:text-gray-200"
>
<X className="h-4 w-4" aria-hidden="true" />
Expand Down