> For the complete documentation index, see [llms.txt](https://help.form.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.form.io/dev/form-development/translations.md).

# Translations

Documentation of Form.io Translations

## Introduction

The Form.io Platform uses the [**i18Next**](https://www.i18next.com/) system as the mechanism for displaying all of the translations within the JavaScript Renderer and Builder. Refer to the i18Next documentation to understand all of the mechanisms that are available to handle translations within an application and forms rendered by Form.io. The Form.io Renderer exposes the i18next platform within the `i18next` variable in the renderer, and all options for this library can be introduced through the `i18n` configuration variable.

## Translation Models

Form.io supports two methods of providing translations:

* [**Embedded translations**](#embedded-translations)**-** The translations are written into the application code and passed to the renderer in the `i18n` option. This is the simplest setup. Adding or changing a translation means changing and redeploying the application.
* [**Resource-based translations**](#dynamic-translations-using-resources)**-** The translations are stored as submissions in a Form.io Language resource and fetched when a user picks a language. Non-developers can add or update translations without any application change.

The following table contrasts the two models: 

|                         | Embedded                         | Dynamic (resource-based)           |
| ----------------------- | -------------------------------- | ---------------------------------- |
| Where translations live | Application code (`i18n` option) | Form.io Language resource          |
| Who edit them           | Application developers           | Anyone with access to the resource |
| Adding a language       | Source change and redeploy       | Add a resource submission          |
| When they load          | Bundled with the app             | Fetched on demand                  |

Both models use the same translation keys and the same language-switching methods, making it easy to start with embedded translations and move to resources later.

The following example illustrates how the i18next framework can be initialized and accessed within the Form.io renderer:

```javascript
Formio.createForm(document.getElementById('formio'), 'https://forms.mysite.com/myproject/myform', {
    i18n: {...} // These options are passed to the i18Next framework
}).then((form) => {
    console.log(form.i18next); // Exposes the i18Next framework instance.
    
    form.language = 'es'; // Changes the language of the i18Next framework.
});
```

Following initialization, the features documented for the[ **i18Next framework**](https://www.i18next.com/) apply.\
\
The following topics provide additional guidance on rendering a form with internationalization:

* [**Embedded translations**](#embedded-translations)
* [**Resource-based translations**](#dynamic-translations-using-resources)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.form.io/dev/form-development/translations.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.