feat: add translation building capability to Streami18n and useNotifications hook #2719
Conversation
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
|
Size Change: -297 kB (-22.61%) 🎉 Total Size: 1.02 MB
ℹ️ View Unchanged
|
MartinCupela
force-pushed
the
feat/translation-builder
branch
from
8e09269 to
b5513b7
Compare
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.
🎯 Goal
Closes REACT-399
Depends on GetStream/stream-chat-js#1542
Notifications emitted within the LLC code were not yet consumed and thus not displayed by the React SDK components. This PR brings:
useNotificationsthat consumes the updates in theclient.notifications.storeMessageListNotificationscomponent displaying the notifications emitted byclient.notifications.storeTranslationBuilderconcept that allows to inject custom logic for building translations from object or in general register custom translation logic with a specific translation key🛠 Implementation details
Originally I was trying to avoid bringing
TranslationBuilderand rather expose native i18next post-processors onStreami18n. Unfortunately the library has bad type declarations (use of any or types missing attributes) + the post-processor functions are not getting translation function among the arguments. Therefore theTranslationBuilderis a wrapper around post-processing providing thei18nextinstance so that the value can be translated inside the post-processors.So the translation building hierarchy is:
TranslationBuilderkeeps mapping of translation topic and presents a public API for registering: translation topics and theirtranslatorfunctionsTopic(e.g. notification) is a equivalent to a single I18Next post-processor and is responsible for defining a methodtranslatethat should return a translated string. It keeps a mapping of translator functions that are invoked based on custom logic (e.g. based on notification code aka grouping).Integrators that want to convert objects into translations or add custom post-processing to translations will do the following:
Important
Notification translations work only with
Notificationobjects emitted with the client's notifications store. That means that this feature will not work with the legacy notification system in stream-chat-react.