patternfly / patternfly/react-component-groups
ShortcutGrid: Add internationalization (i18n) support for Shortcut grid component
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 10
- Forks
- 40
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 4
Description
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
-
"Hover"(line 38 of Shortcut.tsx) -
"Click"(line 45) -
"Right click"(line 48) -
"Drag"(line 51) -
"Drag + Drop"(line 54)
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+Labelbadge rendering -
Build their own shortcut component from scratch
Related
This would align ShortcutGrid with other PatternFly components that support i18n.
Jira Issue: PF-3867
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in Shortcut.tsx, especially the existing hardcoded labels around lines 38–54 and the ShortcutProps interface. Add optional labels that retain the current English defaults, then verify that each boolean mouse-action prop renders its customizable label while preserving the existing ShortcutGrid usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- frontend, internationalization
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100