Skip to content

fix: Added aria descriptions to code-editors #3945

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 2 commits into from
Oct 19, 2025
Merged

fix: Added aria descriptions to code-editors #3945

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6d6244
fix: Added aria descriptions to code-editors
Oct 16, 2025
5e45f97
Merge branch 'main' into dev-v3-csciotto
ClaudioGSDB Oct 17, 2025
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
10 changes: 10 additions & 0 deletions src/code-editor/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ const CodeEditor = forwardRef((props: CodeEditorProps, ref: React.Ref<CodeEditor
const mergedRef = useMergeRefs(codeEditorMeasureRef, __internalRootRef);

const paneId = useUniqueId('code-editor-pane');
const descriptionId = useUniqueId('code-editor-description');

const [paneStatus, setPaneStatus] = useState<PaneStatus>('hidden');
const [annotations, setAnnotations] = useState<Ace.Annotation[]>([]);
Expand Down Expand Up @@ -135,6 +136,13 @@ const CodeEditor = forwardRef((props: CodeEditorProps, ref: React.Ref<CodeEditor
const warningCount = annotations.filter(a => a.type === 'warning').length;
const currentAnnotations = useMemo(() => annotations.filter(a => a.type === paneStatus), [annotations, paneStatus]);

const computedAriaDescription = useMemo(() => {
const errorText = `${errorCount} ${i18n('i18nStrings.errorsTab', i18nStrings?.errorsTab)}`;
const warningText = `${warningCount} ${i18n('i18nStrings.warningsTab', i18nStrings?.warningsTab)}`;

return `${errorText}, ${warningText}`;
}, [errorCount, warningCount, i18n, i18nStrings]);

/*
* Callbacks
*/
Expand Down Expand Up @@ -224,13 +232,15 @@ const CodeEditor = forwardRef((props: CodeEditorProps, ref: React.Ref<CodeEditor
handleAriaLabel={i18n('i18nStrings.resizeHandleAriaLabel', i18nStrings?.resizeHandleAriaLabel)}
handleTooltipText={i18n('i18nStrings.resizeHandleTooltipText', i18nStrings?.resizeHandleTooltipText)}
>
<div id={descriptionId}>{computedAriaDescription}</div>
<div
ref={editorRef}
className={clsx(styles.editor, styles.ace, isRefresh && styles['editor-refresh'])}
onKeyDown={onEditorKeydown}
tabIndex={0}
role="group"
aria-label={i18n('i18nStrings.editorGroupAriaLabel', i18nStrings?.editorGroupAriaLabel)}
aria-describedby={descriptionId}
/>
</ResizableBox>
<div
Expand Down
Loading