Video Summary and Transcription
Today's Talk explores the impact of I18n and DEX for developers, the challenges of I18n, and the importance of understanding different approaches. It discusses determining languages and regions using IP address, browser settings, and URL patterns. The Talk also covers translation loading, using the i18xProvider, and addressing issues such as URL parameters and maintaining translation files. Additionally, it explores connecting with a Content Management System, implementing folder level translation, and utilizing code splats for dynamic routes.
1. Introduction to I18n and its Impact
Today, we're going to see how I18n makes applications accessible to over 70% of users. We'll explore the impact of I18n and DEX for developers, the fundamental logic, and how it works with Remix. Internationalization (I18n) has its challenges, including a relearning cost and mismatched localized text and I18n keys. However, the numbers speak for themselves. With 5.07 billion Internet users and English accounting for only 25.9%, understanding different approaches to I18n will improve your current DX.
Hi, everyone. Thank you for watching my talk. My name is Erys Erczeki. I'm a Deferral engineer working at Storyblock. Today, we're going to see together how I18n gives the impact and making your applications accessible to over 70% of the users in the world.
Moving on to the next slide. And here are the three takeaways from my talk. First of all, we're going to see the impact of the I18n as well as the DEX for the developers. And we're going to see the fundamental logic. Lastly, we're going to see how it works with Remix.
There are a couple of notes. So this talk is first of all for the developers who implement internationalization. Secondly, Remix and I18n feature on going discussions. If you're interested to join the discussions, here's the link. And I'm going to make sure to share my slides on the social media. So you will have access to all the sources I'm going to share.
So internationalization. I18n is first of all an acronym of internationalization. And let's see some of the I18n developer experience. So here's my friend, Maya. She shared with me her experience on Twitter saying that there is a relearning cost how to use the internationalization library every single time. And there is also another issue I would say that localized text versus the I18n keys, you know, in the test, they're not matching. So from her opinion or not just her, but based on that, seems it's not the best DX. So based on, you know, like the current I18n DX you have, let's talk about the numbers and facts.
So starting from the whole entire numbers of the users in the world, actually, it's 5.07 billions of the users using the Internet. And surprisingly, English is used only 25.9% on the Internet. And Asia leads more than half of the global Internet users. So all the numbers are huge, right? And we cannot simply ignore about these, you know, massive numbers. And by knowing the different approaches with more options will actually solve the your current I18nDX. So let's talk about fundamental logic.
2. Determining Languages and Framework Examples
There are three ways to determine languages and regions: IP address, browser settings, and URL patterns. The Remix I18next example uses an npm package, while the content management system approach combines different systems. I18next configuration files define supported languages, fallback language, and namespaces. The client and server side configuration files ensure translations are loaded before hydration.
There are three ways to determine the languages and the regions. First of all, there is the way to detect the location from the IP address, which we are not going to cover in this talk. But secondly, here is the example of respecting users, you know, like configured in their browser setting, you know, like which languages to choose. And lastly, there is a way to identify in the URL. And I'm going to show you the three patterns to identify URLs.
So pattern one is differentiating, you know, by domains, but it will not follow the same origin policy. The pattern two is using the URL parameters, but it doesn't look user friendly, right? And the last pattern is localized sub directories. This looks much cleaner and much more user friendly.
So moving on to the framework examples, there are in general two approaches to choose. So the first approach would be like using an npm package that is, you know, related with I18next. And the other approach is with a combination of the content management system. So this talk is about the Remix, so I'm going to show you the Remix I18next example first. And moving on to show you the content management system example.
So Remix I18next is an npm package for Remix to use the I18next. So first step would be creating the translation files. In this case, I have a default language in English saying greeting hello and translated, you know, like the translation file greeting says hello in Japanese, and let's create I18next configuration file. So in here, what I'm defining is supported languages, fallback language and the default namespace. This namespace common is actually what I gave the names into these translation file. Moving on to, you know, like the other file called I18nextserver.js file. So in here what I'm doing is importing what we configured in I18next config file, and you know, like from the previous file, what we configured, the values are actually arrays in the strings. So we iterate them from the configuration file from the previous slide. And the rest we are setting the translation file path. So next up is creating the client side and the server side configuration files. From the time I have, I'm going to focus on the client side, but don't worry about it, server side, you know, config files looks pretty much the same and a few differences. So entry.client.jsx file. What I want you to pay attention to is with the orange highlighted, you know, line of the code, which is an API called i18xProvider. So with this, by using this API, we want to ensure the translations are loaded before the hydration happens. And we're going to see why together in one of the following slides. And next up, you know, we wrap the remix browser component in between i18xProvider component. So we're also going to see the reasons in one of the following slides.
3. Translation Loading and i18xProvider
Translation should be loaded before hydration to ensure the application is interactive. Wrapping the remix browser component with i18xProvider uses the React hook use memo to avoid unnecessary re-rendering. The app directory contains APIs like loader function, use loader data, JSON, and use change language. The use translation API allows for switching between languages. However, there are some issues to address, such as URL parameters, maintaining translation files, and translating slugs.
So the first why, why translation should be loaded before the hydration. So imagine if translation is not loaded before the hydration happens, the application is not yet interacted. So users cannot see, you know, the localized value. And the other example, if translation is already loaded before the hydration happens, the application is interactive. So users can see the localized content.
Moving on to the second one, why wrapping remix browser component with i18xProvider. So I did a little bit of research in modules. And here's what I found, what I found, where, you know, like i18xProvider has been defined. So it uses actually a, you know, React, sorry. So it uses actually the React hook called use memo. And this, this actually catches the result of the calculation between re-renders. So what I mean by that to say is, you know, like this i18nConfiguration values and the default namespace values are the same, then we don't trigger the re-rendering. But if the values or either one of the values are changed, then that's the only time we are going to trigger the re-rendering. So let's use the configurations in action.
Moving on to the app directory, you know, opening up this root.jsx file, then I wanted to pay attention to the three APIs. So the first one is called loader function. This loader function is a backend API already provided remix site. And it's already, you know, connected with the use loader data. So this use loader data gets the local from the loader function. And lastly, what we are doing is calling an API called JSON. So instead of you know, like defining the new response headers, blah, blah, blah, you can do the same thing with just, you know, one line of the code. And in the end, there is a function called use change language. So this function updates the I18n instance language to the current locale from the loader function and locale will be updated and I18n loads the correct translation files. So let's see how it goes on the browser with the last configuration. So any route of your files at remix app, what I'm doing is importing one API called use translation and setting the value that we define in the very beginning of one of the translation files creating. So you can see you know now back and forth between you know like English and in this case Spanish, you can see the content you know are you know like switching back and forth. But if you have realized a couple of things I have three confessions. First of all if you paid attention on the URL, yes I use the URL parameters which I wanted to avoid. Secondly we developers need to maintain the translation files and lastly we didn't translate the slugs. So to clean up everything what we haven't yet achieved let's have a look at another example with the Content Management System.
4. Connecting with CMS and Folder Level Translation
In this part, we connect the Remix application with a Content Management System, specifically using the example of Storyblock. We explore the folder level translation approach, where different folders are used to store localized content. We see how this approach works in the browser and how to implement the logic from the source code level. Additionally, we discuss the use of code splats provided by Remix to create dynamic routes. Overall, we emphasize the importance of i18n in improving performance, UI, and UX.
So the first step will be connecting your Remix application with Content Management System of your choice. In this talk I'm going to show you the example with the story block, but I'm not going to cover you know like how you can create a connection. Instead I would offer you to have a look at the five minutes tutorial after my talk and you can choose you know like which sort block between four approaches so from the time again I'm going to cover one of the approaches called folder level translation and as you can visually see on the screenshot we divide it into the different folders to have different localized content and let's see how it's going to work on the browser first before we're going to see you know like how we can create the logic from the source code level.
So here is a very little you know blog application that I have built with Remix and Storyblock so we are at right now in the default language of the home that's why you do not see any I would say like locale related slug so we are at the traveling to Salt Lake City in the default language and when I move to the Japanese version of exactly the same entry blog post now on the url we can see the Japanese slug which says ja in front of 4 blog and the content has been localized and on the right hand side as you can see content editors and the translators they can already you know work on their own and when I move back to the blog overview page which we saw together before in the default language you can see the Japanese translated version with the translated slug and if I go back to the root of the home with the default language now I can see the content has been back to the default language which is in English.
Let's move on to the fundamental let's move on to the logic how I was able to create you know like some of the options for the not some of I mean actually like the options for the content editors and the translators to have more controls and take care of creating you know these dynamic routes from the content management systems UI. I used the approach code splats provided from Remix. So in a nutshell besides from you know the important you know three APIs that we already covered before LoaderFunction, UseLoaderData, JSON I wanted to pay attention to the green highlighted line of the code which uses the special parametric code params with the square brackets and the string value of the asterisk. So if you set this value into the console.log and move in back and forth between different you know the pages such as like home or block entry you're going to see the full slags you know like being returned on your on your terminal and by using you know the special parameters which is already provided from the Remix side and a little bit of the modifications of the slags then you already have you know the logic that you just saw like on the recordings I showed you.
So here's a little summary of my talk. We saw together more than a half of the users in the world access localized content and next by knowing more approaches to find better DX for your cases. So this is just one of the examples what I showed you and if you do a little bit of more research which I highly recommend you, I want to tell you that you will be able to find the best approaches that fits better in your cases. And lastly, I also want to emphasize about this that i18n is related to performance UI and UX. And that's actually all about my talk.
Comments