(fix): Translation component issue returning undefined instead of defaultValue #3313
Conversation
This file contains 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
… defaultValue
When the translation component is passed a defaultValue that matches an i18n key with
an object value, `i18next.t` returns `undefined` instead of the default value.
Our Translation component was then returning an empty string in place of the default value
for these translations. This commit fixes that and returns the defaultValue if `i18next.t` returns `undefined` // i18next returns 'undefined' if the default value happens to be the key for a set of definitions
Example of the issue
example en.json file
```
...
"components": {
"componentDef": "Translated Component Def"
}
```
In this case, a request for i18next.t("components", "defaultValue") will return undefined
but i18next.t("components.componentDef", "defaultValue") will return correctly
jshimko
suggested changes
Nov 20, 2017
There was a problem hiding this comment.
Looks good to me. One small code style nitpick though...
Although it probably works fine, there probably shouldn't be a space after the spread operator.
// instead of this
<span {... rest}>{defaultValue}</span>
// use this
<span {...rest}>{defaultValue}</span>Not sure what the general consensus is on that, but I've personally never seen someone use a space there. And all MDN examples don't have a space.
|
@jshimko good catch. Fixed. |
jshimko
approved these changes
Nov 20, 2017
Merged
spencern
deleted the
fix-unreported-spencer-translation-component-undefined
branch
Akarshit
pushed a commit
that referenced
this pull request
Jan 7, 2018
…-translation-component-undefined (fix): Translation component issue returning undefined instead of defaultValue
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.
When the translation component is passed a defaultValue that matches an i18n key with
an object value,
i18next.treturnsundefinedinstead of the default value.Example of the issue
example en.json file
In this case, a request for
i18next.t("components", "defaultValue")will return undefinedbut
i18next.t("components.componentDef", "defaultValue")will return correctlyOur Translation component was then returning an empty string in place of the default value
for these translations. This PR resolves this issue by checking to see if
i18next.treturnsundefinedand returning the default value if so.To test:
You can see this by passing a default value that matches a "category" within an i18n definition file into a
Translationcomponent, before this PR, that would result in an empty string, now it should result in the default value getting returnedThe easiest way to test the premise of this PR is to drop a debugger on line 10 of the
translations.jsfile that this PR modifies and then to test out several different keys and defaultValues from the console.