patternfly / patternfly/react-component-groups
ShortcutGrid: Add internationalization (i18n) support for Shortcut grid component
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 10
- Fork
- 40
- Merge medio
- 3g 22h
- PR unite (30g)
- 4
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia da Shortcut.tsx, in particolare dalle label codificate direttamente esistenti intorno alle righe 38–54 e dall’interfaccia ShortcutProps. Aggiungi label opzionali che mantengano i valori predefiniti attuali in inglese, quindi verifica che ogni prop booleana per le azioni del mouse esegua il rendering della propria label personalizzabile, preservando l’utilizzo esistente di ShortcutGrid.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- react, typescript
- Ambito
- frontend, internationalization
- Tipo di issue
- Funzionalità
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Tranquilla
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 58/100