Internationalisation
Uppy speaks many languages, English being the default. You can use a locale pack to translate Uppy into your language of choice.
Checkout
@uppy/locales
on GitHub to see the list of supported languages.
Using a locale pack from npm
This is the recommended way. Install @uppy/locales package from npm, then
choose the locale you’d like to use: @uppy/locales/lib/LANGUAGE_CODE.
npm i @uppy/core @uppy/locales
import Uppy from '@uppy/core';
import German from '@uppy/locales/lib/de_DE';
// see below for the full list of locales
const uppy = new Uppy({
debug: true,
locale: German,
});
Using a locale pack from CDN
Add a <script> tag with Uppy bundle and the locale pack you’d like to use. You
can copy/paste the link from the CDN column in the locales table. The locale
will attach itself to the Uppy.locales object.
<script src="https://releases.transloadit.com/uppy/v3.17.0/uppy.min.js"></script>
<script src="https://releases.transloadit.com/uppy/locales/v3.3.1/de_DE.min.js"></script>
<script>
var uppy = new Uppy.Uppy({
debug: true,
locale: Uppy.locales.de_DE,
});
</script>
Overriding locale strings for a specific plugin
Many plugins come with their own locale strings, and the packs we provide consist of most of those strings. You can, however, override a locale string for a specific plugin, regardless of whether you are using locale pack or not. See the plugin documentation for the list of locale strings it uses.
import Uppy from '@uppy/core';
import DragDrop from '@uppy/drag-drop';
import Russian from '@uppy/locales/lib/ru_RU';
const uppy = new Uppy({
debug: true,
autoProceed: true,
locale: Russian,
});
uppy.use(DragDrop, {
target: '.UppyDragDrop',
// We are using the ru_RU locale pack (set above in Uppy options),
// but you can also override specific strings like so:
locale: {
strings: {
browse: 'выберите ;-)',
},
},
});
List of locales
Contributing a new language
If you speak a language we don’t yet support, you can contribute! Here’s how you do it:
- Go to the uppy/locales directory in the Uppy GitHub repo.
- Go to
en_US.jsand copy its contents, as English is the most up-to-date locale. - Press “Create new file”, name it according to the
language_COUNTRYformat, make sure to use underscore_as a divider. Examples:en_US,en_GB,ru_RU,ar_AE. Variants should be trailing, for examplesr_RS_Latinfor Serbian Latin vs Cyrillic. - If your language has different pluralization rules than English, update the
pluralizeimplementation. If you are unsure how to do this, please ask us for help in a GitHub issue. - Paste what you’ve copied from
en_US.jsand use it as a starting point to translate strings into your language. - When you are ready, save the file — this should create a PR that we’ll then review 🎉 Thanks!