feat(plugin-form-builder): support translations#16794
Conversation
Converts all static string labels, descriptions, and block labels within the Form Builder plugin to use Payload's i18n `t` function. This change allows the plugin's administrative interface to be localized by providing translatable keys. Includes default English and French translation files.
DanRibbens
left a comment
There was a problem hiding this comment.
Optionally, one thing you could do to make this complete would be to generate all the translations for the plugin. Our translations use open ai, if you don't have an API key, don't worry about this. To generate the translations you will have to add the plugin to the tools similar to tools/scripts/src/generateTranslations/plugin-multi-tenant.ts and then run pnpm --filter @tools/scripts run generateTranslations:plugin-form-builder.
| $schema: './translation-schema.json', | ||
| 'plugin-form-builder': { | ||
| name: 'Name (lowercase, no special characters)', | ||
| addLabel: 'Add', |
There was a problem hiding this comment.
Nit pick, but I would prefer to drop the Label at the end of the keys that end in Label.
addLabel => add
basePriceLabel => basePrice
conditionLabel => condition
It matters less that the translation is used in a label
There was a problem hiding this comment.
Hey Dan,
Thanks for your time on this review, renamed the translations keys like you asked and I generated the translations for all the supported languages, not with an OPENAI_KEY thought but at the end, the model used was GPT 5.5 high
Changes are ready to be reviewed
63559a8 to
9a22a62
Compare
What?
Adds i18n support to
@payloadcms/plugin-form-builder.This replaces hardcoded admin labels, descriptions, option labels, block labels, and field labels with translation keys under the
plugin-form-buildernamespace. It also adds English and French translation files and exports the plugin translations for external reuse or overrides.Why?
The form builder plugin currently renders many admin UI strings directly in English. This makes the plugin inconsistent with Payload’s i18n support and with other plugins that already expose translated admin labels.
This change allows form builder UI text to be translated based on the active Payload admin language, while still allowing users to override plugin translations through
config.i18n.translations.How?
@payloadcms/translationsas a dependency of@payloadcms/plugin-form-builder.enandfrtranslation objects underpackages/plugin-form-builder/src/translations.plugin-redirects, with user-provided translations taking precedence.t('plugin-form-builder:...').filter(Boolean)field cleanup in the payment block with conditional array spreading so the field array keeps stronger contextual typing and avoids TypeScript losing the expectedFieldshape for nested label functions.formBuilderTranslationsso consumers can inspect or reuse the plugin translation object.Testing
pnpm --filter @payloadcms/plugin-form-builder buildFixes #