Skip to content

feat(plugin-form-builder): support translations#16794

Open
quentinhermiteau wants to merge 3 commits into
payloadcms:mainfrom
quentinhermiteau:feat/plugin-form-builder-translations
Open

feat(plugin-form-builder): support translations#16794
quentinhermiteau wants to merge 3 commits into
payloadcms:mainfrom
quentinhermiteau:feat/plugin-form-builder-translations

Conversation

@quentinhermiteau

@quentinhermiteau quentinhermiteau commented May 29, 2026

Copy link
Copy Markdown

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-builder namespace. 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?

  • Added @payloadcms/translations as a dependency of @payloadcms/plugin-form-builder.
  • Added en and fr translation objects under packages/plugin-form-builder/src/translations.
  • Merged plugin translations into the Payload config using the same pattern as plugin-redirects, with user-provided translations taking precedence.
  • Replaced hardcoded form builder labels and admin descriptions with t('plugin-form-builder:...').
  • Added translated labels for form field blocks, confirmation settings, email settings, upload settings, payment fields, and form submission payment metadata.
  • Replaced the 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 expected Field shape for nested label functions.
  • Exported formBuilderTranslations so consumers can inspect or reuse the plugin translation object.

Testing

  • Ran pnpm --filter @payloadcms/plugin-form-builder build
  • Manually tested the plugin in a Payload app configured with French admin i18n and verified plugin translation keys can be resolved and overridden.

Fixes #

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 DanRibbens left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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',

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@quentinhermiteau quentinhermiteau force-pushed the feat/plugin-form-builder-translations branch from 63559a8 to 9a22a62 Compare June 11, 2026 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants