Describe the problem
The Shortcut component (used by ShortcutGrid) currently has hardcoded English strings for mouse action labels with no way to internationalize them for applications that need to support multiple languages.
Current hardcoded strings
These are rendered inside Label components alongside a MouseIcon when the corresponding boolean props (hover, click, rightClick, drag, dragAndDrop) are set to true.
Proposed solution
Add optional label props for each mouse action to allow customization of all user-facing strings:
export interface ShortcutProps {
// ... existing props
/** Custom label for "Hover" mouse action */
hoverLabel?: string;
/** Custom label for "Click" mouse action */
clickLabel?: string;
/** Custom label for "Right click" mouse action */
rightClickLabel?: string;
/** Custom label for "Drag" mouse action */
dragLabel?: string;
/** Custom label for "Drag + Drop" mouse action */
dragAndDropLabel?: string;
}
These would default to the current English strings for backwards compatibility.
Example usage
import { useTranslation } from 'react-i18next';
const MyComponent = () => {
const { t } = useTranslation();
return (
<ShortcutGrid
shortcuts={[
{
keys: ['ctrl'],
drag: true,
dragLabel: t('Drag'),
description: t('Move object'),
},
{
keys: [],
rightClick: true,
rightClickLabel: t('Right click'),
description: t('Open context menu'),
},
]}
/>
);
};
Impact
Applications using Shortcut or ShortcutGrid that need to support non-English languages currently have to either:
-
Accept English-only mouse action labels
-
Avoid the boolean mouse action props entirely and lose the MouseIcon + Label badge rendering
-
Build their own shortcut component from scratch
Related
This would align ShortcutGrid with other PatternFly components that support i18n.
Jira Issue: PF-3867
Describe the problem
The
Shortcutcomponent (used byShortcutGrid) currently has hardcoded English strings for mouse action labels with no way to internationalize them for applications that need to support multiple languages.Current hardcoded strings
"Hover"(line 38 of Shortcut.tsx)"Click"(line 45)"Right click"(line 48)"Drag"(line 51)"Drag + Drop"(line 54)These are rendered inside
Labelcomponents alongside aMouseIconwhen the corresponding boolean props (hover,click,rightClick,drag,dragAndDrop) are set totrue.Proposed solution
Add optional label props for each mouse action to allow customization of all user-facing strings:
These would default to the current English strings for backwards compatibility.
Example usage
Impact
Applications using
ShortcutorShortcutGridthat need to support non-English languages currently have to either:Accept English-only mouse action labels
Avoid the boolean mouse action props entirely and lose the
MouseIcon+Labelbadge renderingBuild their own shortcut component from scratch
Related
This would align ShortcutGrid with other PatternFly components that support i18n.
Jira Issue: PF-3867