Translation Generation Guide

Translation Generation Guide

Payload has two separate translation systems:

1. Core Translations - for core Payload packages (packages/ui, packages/payload, packages/next)
2. Plugin Translations - for plugins (packages/plugin-*)

Table of Contents

• 1. Core Translations
• 2. Plugin Translations
  • Scaffolding New Plugin Translations
• Important Notes

1. Core Translations

When to use: Adding translations to core Payload packages (packages/ui, packages/payload, packages/next)

Steps:

1. Add the English translation to packages/translations/src/languages/en.ts

   • Add your new key/value to the appropriate section (e.g., authentication, general, fields, etc.)
   • Use nested objects for organization
   • Example:

     export const enTranslations = {
       authentication: {
         // ... existing keys
         newFeature: 'New Feature Text',
       },
     }
     

2. Add client key (if needed for client-side usage) to packages/translations/src/clientKeys.ts

   • Add the translation key path using colon notation
   • Example: 'authentication:newFeature'