I'm getting my bearing with i18next, but Trans is offering me riddles when I try to work with a link. Everything is working well with t{} so far (I'm working in React – JSX):
Here is the code that almost works (other approaches I tried didn't work at all):
<p className="button"><Trans i18nkey="home.p3" components={{ MyLink: <a href='beispiele.html'>link</a> }}/>{t('home.p3')}</p>
JSON:
de:
{
(…)
"home": {
(…)
"p3": "Durchstöbern Sie unsere <5>Beispiele</5>.",
(…)
}
}
en:
{
(…)
"home": {
(…)
"p3": "View <MyLink>samples</MyLink> of our work.",
(…)
}
}
and this is how I initialize i18next:
i18next
// detect user language
// learn more: https://github.com/i18next/i18next-browser-languageDetector
.use(LanguageDetector)
// pass the i18n instance to react-i18next.
.use(initReactI18next)
// init i18next
// for all options read: https://www.i18next.com/overview/configuration-options
.init({
debug: true,
fallbackLng: 'de', // language to use
resources: {
en: {
translation: common_en // 'translation' is our custom namespace
},
de: {
translation: common_de
},
},
});
The resulting text displayed: undefinedView samples of our work.
I've looked at the i18next documentation on using Trans, also trying to use <1></1> and similar to encapsulate the link. Each time "undefined" is displayed. I've gone through this tutorial, where it worked. And have been mirroring it as closely as possible. The Transelement is not being grasped, although there are no error messages.
I'd appreciate any tips on how I can further troubleshoot this. Many thanks!
ETA:
thanks to Ahmet's eagle eye one mistake has been found. I'm not correcting it above, in case someone else runs into this problem: it should be i18nKey.
Further digging showed I have to place the JSON files in to the public folder to have the links work. For those looking into this: use i18next-http-backend in your init (i18n.use(Backend)) in your setup so you can reach the folder
There is a typo in your Trans component. You need to change the i18nkey prop to i18nKey.
You can take a look at this sandbox for a live working example.
Related
Does app fabric have something that supports translation of data directly (NOTE: I don't want React's Intl since that is meant for localising data before it is rendered). I need to localise the data present in the state and update the state with the translated data.
React's intl is intended to be used with components and I require translation of data present outside components. I don't want to use the createIntl module since that requires manual provision of locale & messages.
This is the code that I'm dealing with. It is present outside a component.
export function func () {
client.get (url, {}).then (
response => {
// handle error
}).then(data => {
// This is where i want to translate the data based on the locale i am in
// so that the data this translated data is present in the state
}
// error-handling, more code ...
}
You can use i18next to translate data in plain js.
Basic Example:
import i18next from 'i18next';
i18next.init({
lng: 'en', // if you're using a language detector, do not define the lng option
debug: true,
resources: {
en: {
translation: {
"key": "hello world"
}
}
}
});
// initialized and ready to go!
// i18next is already initialized, because the translation resources where passed via init function
document.getElementById('output').innerHTML = i18next.t('key');
By the way, why not translate data on the server-side? You may encounter some cases like export excel which may require translation, too.
I am working in a project where we are using modules with lazy loading to separate it, now we would like to separate also the translations into the different modules, so only the translations that belogn to that module get loaded.
currently we have the translations as it follows:
translations
--en
--de
--it
--sp
we would like to have sth like this now:
translations
--en
|--moduleA
|--moduleB
|--moduleC
--it
|--moduleA
|--moduleB
|--moduleC
etc,
I have been throug the documentation and tried the 'useTranslation (hook)' and 'withTranslation', both dont seem to work since they load all the translations in the specified ns anyway and after take what is received when calling i18n, I also hada look at the i18next-http-backend but the documentation do not specify how to use it very clearly.
basically I am missing some information about how to use it, but as per my findings seems the only posible solution, am I wrong?.
after installing the dependancy I have my i18n as followns:
import i18n from 'i18next'
import LanguageDetector from 'i18next-browser-languagedetector'
import moment from 'moment'
import HttpApi from 'i18next-http-backend'
import request from 'superagent'
import {EN} from './translations/eng'
import {test} from './translations/test'
i18n
.use(LanguageDetector)
.use(HttpApi)
.init({
backend: options,
resources: {
en: {
translations: EN,
translations2: test,
},
},
fallbackLng: 'en',
ns: ['translations', 'translations2'],
defaultNS: 'translations',
keySeparator: false,
interpolation: {
escapeValue: false,
formatSeparator: ',',
format: function(value, formatting) {
if (value instanceof Date) return moment(value).format(formatting)
return value.toString()
},
},
react: {
wait: true,
},
})
the backend key is expecting some options information:
const options = {
loadPath: 'path to file',
addPath: 'path to file',
allowMultiLoading: false,
parse: function(data) {
return data.replace(/a/g, '')
},
parsePayload: function(namespace, key, fallbackValue) {
return {key}
},
request: function(options, url, payload, callback) {},
}
But I am not really sure about the way how to use it,I wanted to know if someone has experience with this and if someone can recomend any guide or documentation that might help me.
thanks
I think you may be looking for Namespaces:
Namespaces are a feature in i18next internationalization framework which allows you to separate translations that get loaded into multiple files.
While in a smaller project it might be reasonable to just put everything in one file you might get at a point where you want to break translations into multiple files. Reasons might be:
You start losing the overview having more than 300 segments in a file
Not every translation needs to be loaded on the first page, speed up load time
I have a simple project that supposed to work with English and Dutch(default). I have copied everything from the original example but somehow it doesn't work as expected.
Even though I have browserLanguageDetection: false, it is forcing me to /enendpoint.
I would like to show the NL text on / but currently I couldn't.
Could you please check the sandbox and tell me what is wrong here?
https://codesandbox.io/s/pensive-galileo-zifjm?file=/pages/index.js
There is solution in the docs. Here it is: https://nextjs.org/docs/advanced-features/i18n-routing
As I found out from the docs you should declare localeDetection: false then you should declare your own domain paths. It will work.
i18n: {
defaultLocale: 'en',
locales: ['en'],
localeDetection: false, // Important!
domains: [
{
domain: 'example.com', // <-
defaultLocale: 'en' // This locale will be appeared at the exact above domain.
},
{
// 2nd locale goes here in the same way.
}
]
}
I hope, it helps.
It is important to know that in Next.js, the first loading is always done on the server side. In i18n.js you have defined browserLanguageDetection: false but you have not defined serverLanguageDetection: false that's why you are always redirected to /en
In the index page, replace this line export default withTranslation('common')(IndexPage); with this one export default withTranslation(['common'])(IndexPage); to avoid this warning
I'm using a react app with react-i18next and loading the translation with i18next-xhr-backend
i18n
.use(Backend)
.use(initReactI18next) // passes i18n down to react-i18next
.init({
lng: "de",
backend: {
loadPath: '/static/locales/{{lng}}/{{ns}}.json'
}
});
If I run it locally my app is served over http://localhost:3000/
and the translation file is also loading nicely (src is located in public/statuc/locales/ ) http://localhost:3000/static/locales/de/translation.json
I'm now facing the issue that in production the app is not served from root, instead the builded files are served over a subfolder. Because of that I changed my packages.json and added homepage
{
"name": "myapp",
"version": "0.1.0",
"homepage": "/static/app/",
...
}
After building the application and deploying it on prod, it still loads correctly, but the translation files are not found.
http://production.tld/static/app/index.html
react app files are loaded correctly http://production.tld/static/app/static/js/main*.js
but the translation file is still fetched by http://production.tld/static/locales/de/translation.json which is not available anymore (instead http://production.tld/static/app/static/locales/de/translation.json would be correct)
I could fix it by changing the i18n config
backend: {
loadPath: '/static/app/static(locales/{{lng}}/{{ns}}.json'
}
then it works in production, but not locally anymore :-/
I'm not sure how to avoid this situation ?
You can pass loadPath as function.
backend: {
loadPath: () => {
// check the domain
const host = window.location.host;
return (host === 'production.ltd' ? '/static/app':'') + '/static/app/static/locales/{{lng}}/{{ns}}.json';
},
},
Another solution would be to work with environment variables. Only the condition would be different and without a function, the idea is like #felixmosh's solution.
An example with create-react-app, here you can use the environment variable 'NODE_ENV' for the condition.
i18n.use(XHR)
.use(initReactI18next)
.init({
backend: {
loadPath:
process.env.NODE_ENV !== "production"
? `./locales/{{lng}}/{{ns}}.json`
: ` /static/app/static/locales/{{lng}}/{{ns}}.json`,
},
lng: "de",
fallbackLng: "de",
load: "languageOnly",
debug: true,
react: {
transSupportBasicHtmlNodes: true,
transKeepBasicHtmlNodesFor: ["br", "strong", "i", "sub", "sup", "li"],
},
});
Here the documentation of create-react-app
https://create-react-app.dev/docs/adding-custom-environment-variables
Here's a follow-along question that may deserve its own top-level question:
it appears that if your locales directories have dashes in the name (e.g. locales/en-us/translation.json), then things don't work. How are we supposed to get around that? I stumbled on this answer because I thought perhaps I could do something along the lines of:
loadPath: (lng, ns) => { return `/locales/{{lng.replace(/-/g,'')/{{ns}}.json` }
But during my initial testing, that didn't work.
I need to understand the difference between this:
this.domElement.getElementsByClassName
which references domElement. This is not usable as I get errors saying it doesn't exist on 'myproject'.
I also use this:
this.props.context.pageContext.web
etc..
What is the difference between the two or are they both different in their usage?
Please note, I understand what domElement is, but how it's used here is not what I understand.
I need to understand because I see a lot of demonstrations of features (which I need to use) that use domElement in their spfx project, although it's not usable by me!
C
pageContext is built by SharePoint client runtime (JS)libraries, it contains many SharePoint client side objects.
Stefan Bauer had shared good explanation for domElement below.
https://n8d.at/this-domelement-is-your-new-document-object-in-spfx-web-parts-development/
Update:
In webpart.ts, not in component .tsx.
Update:
Component property interface.
import { WebPartContext } from '#microsoft/sp-webpart-base';
export interface IReactSpFxProps {
description: string,
context: WebPartContext,
userToken:string
}
.ts
const element: React.ReactElement<IReactSpFxProps> = React.createElement(
ReactSpFx,
{
description: this.properties.description,
context:this.context,
userToken: accessToken
});
ReactDom.render(element, this.domElement);
.tsx:
public componentDidMount() {
var dom=this.props.context.domElement;