Skip to content

Add aria-description for menu keyboard shortcuts #539

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
sjdemartini merged 1 commit into from
Mar 22, 2026
Merged

Add aria-description for menu keyboard shortcuts #539

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
7 changes: 7 additions & 0 deletions src/controls/MenuButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { styled, useThemeProps, type SxProps } from "@mui/material/styles";
import { clsx } from "clsx";
import type { ReactNode, RefObject } from "react";
import { getUtilityComponentName } from "../styles";
import { getShortcutKeysDescription } from "../utils/platform";
import {
menuButtonClasses,
type MenuButtonClassKey,
Expand Down Expand Up @@ -110,6 +111,11 @@ export default function MenuButton(inProps: MenuButtonProps) {
...toggleButtonProps
} = props;

// Expose keyboard shortcuts to screen readers. We use aria-description
// rather than aria-keyshortcuts due to inconsistent screen reader
// support for the latter.
const ariaDescription = getShortcutKeysDescription(tooltipShortcutKeys);

return (
<MenuButtonRoot
className={clsx([menuButtonClasses.root, className, classes.root])}
Expand All @@ -132,6 +138,7 @@ export default function MenuButton(inProps: MenuButtonProps) {
// and MenuButtonTooltip's direct child is its `contentWrapper`
// anyway, not the button itself.
aria-label={tooltipLabel}
aria-description={ariaDescription}
{...toggleButtonProps}
>
{children ??
Expand Down
64 changes: 28 additions & 36 deletions src/controls/MenuSelectHeading.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { useCallback, useMemo, type ReactNode } from "react";
import { useRichTextEditorContext } from "../context";
import { getEditorStyles, getUtilityComponentName } from "../styles";
import { getAttributesForEachSelected } from "../utils/getAttributesForEachSelected";
import { getShortcutKeysDescription } from "../utils/platform";
import MenuButtonTooltip, {
type MenuButtonTooltipProps,
} from "./MenuButtonTooltip";
Expand Down Expand Up @@ -207,12 +208,24 @@ export default function MenuSelectHeading(inProps: MenuSelectHeadingProps) {
const props = useThemeProps({ props: inProps, name: componentName });
const {
labels,
shortcutKeys,
shortcutKeys: shortcutKeyOverrides,
hideShortcuts = false,
classes = {},
sx,
...menuSelectProps
} = props;
const shortcutKeys = hideShortcuts
? undefined
: {
paragraph: shortcutKeyOverrides?.paragraph ?? ["mod", "alt", "0"],
heading1: shortcutKeyOverrides?.heading1 ?? ["mod", "alt", "1"],
heading2: shortcutKeyOverrides?.heading2 ?? ["mod", "alt", "2"],
heading3: shortcutKeyOverrides?.heading3 ?? ["mod", "alt", "3"],
heading4: shortcutKeyOverrides?.heading4 ?? ["mod", "alt", "4"],
heading5: shortcutKeyOverrides?.heading5 ?? ["mod", "alt", "5"],
heading6: shortcutKeyOverrides?.heading6 ?? ["mod", "alt", "6"],
};

const editor = useRichTextEditorContext();

const handleHeadingType: (
Expand Down Expand Up @@ -354,14 +367,11 @@ export default function MenuSelectHeading(inProps: MenuSelectHeadingProps) {
<MenuItem
value={HEADING_OPTION_VALUES.Paragraph}
disabled={!isCurrentlyParagraphOrHeading && !canSetParagraph}
aria-description={getShortcutKeysDescription(shortcutKeys?.paragraph)}
>
<MenuSelectMenuOption
label=""
shortcutKeys={
hideShortcuts
? undefined
: (shortcutKeys?.paragraph ?? ["mod", "alt", "0"])
}
shortcutKeys={shortcutKeys?.paragraph}
placement="right"
classes={{
contentWrapper: clsx([
Expand All @@ -380,14 +390,11 @@ export default function MenuSelectHeading(inProps: MenuSelectHeadingProps) {
<MenuItem
value={HEADING_OPTION_VALUES.Heading1}
disabled={!canSetHeading}
aria-description={getShortcutKeysDescription(shortcutKeys?.heading1)}
>
<MenuSelectHeadingOption1
label=""
shortcutKeys={
hideShortcuts
? undefined
: (shortcutKeys?.heading1 ?? ["mod", "alt", "1"])
}
shortcutKeys={shortcutKeys?.heading1}
placement="right"
className={clsx([
menuSelectHeadingClasses.menuOption,
Expand All @@ -407,14 +414,11 @@ export default function MenuSelectHeading(inProps: MenuSelectHeadingProps) {
<MenuItem
value={HEADING_OPTION_VALUES.Heading2}
disabled={!canSetHeading}
aria-description={getShortcutKeysDescription(shortcutKeys?.heading2)}
>
<MenuSelectHeadingOption2
label=""
shortcutKeys={
hideShortcuts
? undefined
: (shortcutKeys?.heading2 ?? ["mod", "alt", "2"])
}
shortcutKeys={shortcutKeys?.heading2}
placement="right"
className={clsx([
menuSelectHeadingClasses.menuOption,
Expand All @@ -434,14 +438,11 @@ export default function MenuSelectHeading(inProps: MenuSelectHeadingProps) {
<MenuItem
value={HEADING_OPTION_VALUES.Heading3}
disabled={!canSetHeading}
aria-description={getShortcutKeysDescription(shortcutKeys?.heading3)}
>
<MenuSelectHeadingOption3
label=""
shortcutKeys={
hideShortcuts
? undefined
: (shortcutKeys?.heading3 ?? ["mod", "alt", "3"])
}
shortcutKeys={shortcutKeys?.heading3}
placement="right"
className={clsx([
menuSelectHeadingClasses.menuOption,
Expand All @@ -461,14 +462,11 @@ export default function MenuSelectHeading(inProps: MenuSelectHeadingProps) {
<MenuItem
value={HEADING_OPTION_VALUES.Heading4}
disabled={!canSetHeading}
aria-description={getShortcutKeysDescription(shortcutKeys?.heading4)}
>
<MenuSelectHeadingOption4
label=""
shortcutKeys={
hideShortcuts
? undefined
: (shortcutKeys?.heading4 ?? ["mod", "alt", "4"])
}
shortcutKeys={shortcutKeys?.heading4}
placement="right"
className={clsx([
menuSelectHeadingClasses.menuOption,
Expand All @@ -488,14 +486,11 @@ export default function MenuSelectHeading(inProps: MenuSelectHeadingProps) {
<MenuItem
value={HEADING_OPTION_VALUES.Heading5}
disabled={!canSetHeading}
aria-description={getShortcutKeysDescription(shortcutKeys?.heading5)}
>
<MenuSelectHeadingOption5
label=""
shortcutKeys={
hideShortcuts
? undefined
: (shortcutKeys?.heading5 ?? ["mod", "alt", "5"])
}
shortcutKeys={shortcutKeys?.heading5}
placement="right"
className={clsx([
menuSelectHeadingClasses.menuOption,
Expand All @@ -515,14 +510,11 @@ export default function MenuSelectHeading(inProps: MenuSelectHeadingProps) {
<MenuItem
value={HEADING_OPTION_VALUES.Heading6}
disabled={!canSetHeading}
aria-description={getShortcutKeysDescription(shortcutKeys?.heading6)}
>
<MenuSelectHeadingOption6
label=""
shortcutKeys={
hideShortcuts
? undefined
: (shortcutKeys?.heading6 ?? ["mod", "alt", "6"])
}
shortcutKeys={shortcutKeys?.heading6}
placement="right"
className={clsx([
menuSelectHeadingClasses.menuOption,
Expand Down
4 changes: 4 additions & 0 deletions src/controls/MenuSelectTextAlign.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import MenuButtonTooltip, {
// without needing to list extension-text-align as a peer dependency.
// eslint-disable-next-line import/no-extraneous-dependencies
import type { TextAlignOptions } from "@tiptap/extension-text-align";
import { getShortcutKeysDescription } from "../utils/platform";
import { MENU_BUTTON_FONT_SIZE_DEFAULT } from "./MenuButton";
import MenuSelect, { type MenuSelectProps } from "./MenuSelect";
import {
Expand Down Expand Up @@ -301,6 +302,9 @@ export default function MenuSelectTextAlign(inProps: MenuSelectTextAlignProps) {
// Add an accessible label, since no text is included within the
// menu item
aria-label={alignmentOption.label ?? alignmentOption.value}
aria-description={getShortcutKeysDescription(
alignmentOption.shortcutKeys,
)}
className={clsx([
menuSelectTextAlignClasses.menuItem,
classes.menuItem,
Expand Down
16 changes: 16 additions & 0 deletions src/utils/platform.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,22 @@ export function getModShortcutKey(): string {
return isMac() ? "⌘" : "Ctrl";
}

/**
* Format an array of shortcut keys (e.g. ["mod", "Shift", "B"]) into a
* human-readable string (e.g. "Ctrl + Shift + B" or "⌘ + Shift + B"), suitable
* for use as an aria-description. Returns undefined if the array is empty or
* undefined.
*/
export function getShortcutKeysDescription(
shortcutKeys: string[] | undefined,
): string | undefined {
return shortcutKeys?.length
? shortcutKeys
.map((key) => (key === "mod" ? getModShortcutKey() : key))
.join(" + ")
: undefined;
}

/** Return true if the user is using a touch-based device. */
export function isTouchDevice(): boolean {
if (isTouchDeviceResult === undefined) {
Expand Down
Loading