Skip to content

added accessible names for links and aria-labels for code editors #987

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
wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −4
Open

added accessible names for links and aria-labels for code editors #987

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
9 changes: 5 additions & 4 deletions utils/mdx-components.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,11 @@ const components: React.ComponentProps<typeof MDXProvider>['components'] = {
const language = className.replace(/language-/, '') as Language | 'react' | 'sh';

if (language === 'react') {
return <LiveEdit code={children.trim()} />;
return <LiveEdit code={children.trim()} aria-label="Live code editor" />;
} else if (language === 'sh') {
return <CodeBlock code={children.trim()} language="bash" />;
return <CodeBlock code={children.trim()} language="bash" aria-label="Code snippet in Bash" />;
} else if (language) {
return <CodeBlock code={children.trim()} language={language} />;
return <CodeBlock code={children.trim()} language={language} aria-label={`Code snippet in ${language}`} />;
}

return <Code>{children}</Code>;
Expand All @@ -77,8 +77,9 @@ const components: React.ComponentProps<typeof MDXProvider>['components'] = {
},

a({ href, children }) {
const content = children || href;
return (
<Link href={href || ''} inline>
<Link href={href || ''} inline aria-label={typeof children === 'string' ? undefined : href}>
{children}
</Link>
);
Expand Down