feat(plugin-nested-docs): support for translations#16801
Open
MrFlathill wants to merge 2 commits into
Open
Conversation
Introduces translation keys and default translations for the nested docs plugin fields (breadcrumbs, parent). This enables the plugin to display its UI labels in multiple languages within the Payload admin, improving user experience for internationalized installations. The plugin now registers its own translation namespace, allowing its field labels to be localized and overridden through the main Payload i18n configuration.
Configures `package.json` exports to allow the main Payload application to discover and load the plugin's language-specific translation files. This completes the integration of the plugin's internationalization capabilities, enabling its UI labels to be properly localized. Additionally, corrects the relative `$schema` path within the translation files and promotes `@payloadcms/translations` to a runtime dependency.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Adds i18n support to
@payloadcms/plugin-nested-docs.Introduces translation keys and default translations for the nested docs plugin fields (breadcrumbs, parent). This enables the plugin to display its UI labels in multiple languages within the Payload admin, improving user experience for internationalized installations.
Why?
The nested docs plugin currently renders its fields without lables (results in English Language). This makes the plugin inconsistent with Payload’s i18n support and with other plugins that already expose translated admin labels.
The plugin now registers its own translation namespace, allowing its field labels to be localized and overridden through the main Payload i18n configuration.
How?
Added @payloadcms/translations as a dependency of @payloadcms/plugin-nested-docs
Added en, de and it translation objects under packages/plugin-form-builder/src/translations/languages.
Merged plugin translations into the Payload config using the same pattern as plugin-seo, with user-provided translations taking precedence.
Replaced hardcoded form builder labels and admin descriptions with
t('plugin-nested-docs:...').Added translated labels for breadcrumbs array and parent realtion
Exported
nestedDocsTranslationsso consumers can inspect or reuse the plugin translation object.Testing
pnpm --filter @payloadcms/plugin-form-builder buildpnpm build:plugin-nested-docspnpm dev plugin-nested-docs, with German and Italian admin i18n and verified plugin translation keys can be resolved and overridden.Fixes #