Improve keyboard accessibility of the codecard component #10405
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
microbit-robert
commented
Mar 5, 2025
| @@ -95,9 +102,18 @@ export class CodeCardView extends data.Component<CodeCardProps, CodeCardState> { | |||
| const ariaLabel = card.ariaLabel || card.title || card.shortName || name; | |||
|
|
|||
| const style = card.style || "card" | |||
| const cardDiv = <div className={`ui ${style} ${color} ${card.onClick ? "link" : ''} ${className ? className : ''}`} | |||
| role={card.role} aria-selected={card.role === "option" ? "true" : undefined} aria-label={ariaLabel} title={card.title} | |||
| onClick={clickHandler} tabIndex={card.onClick ? card.tabIndex || 0 : null} onKeyDown={card.onClick ? fireClickOnEnter : null}> | |||
There was a problem hiding this comment.
fireClickOnEnter does the wrong thing here when using "Enter" or "Space" while the "Feedback" anchor tag is focussed. It prevents the default behaviour, then triggers click on this element instead of the anchor tag from which the original event was triggered, causing the experiment to toggle on/off.
There was a problem hiding this comment.
PR Overview
This PR improves keyboard accessibility and visual focus for code cards on the experiments page.
- Change the interactive role from "button" to "link" for the Beta Editor card in scriptsearch.tsx.
- Refactor and add a keyboard event handler (keydownHandler) in CodeCardView to trigger the click action on Enter and Space keys.
Reviewed Changes
| File | Description |
|---|---|
| webapp/src/scriptsearch.tsx | Updated the role attribute for the Beta Editor card to support link behavior. |
| webapp/src/codecard.tsx | Introduced a keydownHandler for keyboard interactivity and refactored rendering logic. |
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (2)
webapp/src/scriptsearch.tsx:526
- Verify that changing the role from 'button' to 'link' correctly reflects the element's behavior. Ensure that if a link is expected, the element provides appropriate navigation behavior (for example, a valid href) or that the change is aligned with the intended interaction.
role="link"
webapp/src/codecard.tsx:84
- [nitpick] Consider defining named constants for the key codes (e.g., ENTER and SPACE) to improve the readability of the keydownHandler function.
const keydownHandler = (e: React.KeyboardEvent) => {
riknoll
approved these changes
Mar 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This affects code cards on the experiments page. At the moment, it is not possible to trigger the feedback link of these cards via keyboard, this action simple toggles the experiment on and off. This PR addresses this and also improves the appearance of the focus-visible outline around the "Beta Editor" card.
@microbit-matt-hillsdon