feat(plugin-search): add full translation support#16802
Open
MrFlathill wants to merge 1 commit into
Open
Conversation
This change integrates the new `@payloadcms/translations` package, enabling full internationalization for the search plugin's administrative interface. To enhance the plugin's usability and accessibility for a global audience by providing its administrative interface in multiple languages. This change allows developers to easily translate all user-facing strings within the `plugin-search` functionality, ensuring a consistent and localized experience.
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
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?
This change integrates the new
@payloadcms/translationspackage, enabling full internationalization for the search plugin's administrative interface.Why
To enhance the plugin's usability and accessibility for a global audience by providing its administrative interface in multiple languages. This change allows developers to easily translate all user-facing strings within the
plugin-searchfunctionality, ensuring a consistent and localized experience.How?
@payloadcms/translationspackage is now a dependency ofplugin-search.label), and descriptions within theSearchcollection are updated to use translation functions (({ t }) => t('plugin-search:key')) instead of hardcoded strings.searchTranslationsfor external use.LinkToDocUI field is updated to be aUIFieldServerComponent, allowing its label to be translated server-side and passed to the client component.plugin-searchtest environment now includes seed data forpagesandpostscollections, which is essential for thoroughly testing the plugin's functionality, including its newly translatable elements.Testing
pnpm build:plugin-searchpnpm --filter @payloadcms/plugin-search buildpnpm test:int ./test/plugin-search/int.spec.tspnpm dev plugin-search, with German and Italian admin i18n and verified plugin translation keys can be resolved and overridden.