apps/docs/content/sdk-features/internationalization.mdx
Tldraw's UI supports 50 languages out of the box, including right-to-left languages like Arabic, Hebrew, Farsi, and Urdu. The translation system loads language files on demand, detects the user's browser language, and lets you override any translation string or add custom ones.
The user's locale is stored in user preferences. By default, tldraw detects the browser's language and selects the closest match from supported languages.
The simplest way to set the locale is with the locale prop on the Tldraw component:
import { Tldraw } from 'tldraw'
import 'tldraw/tldraw.css'
export default function App() {
return (
<div style={{ position: 'fixed', inset: 0 }}>
<Tldraw locale="fr" />
</div>
)
}
The locale prop takes priority over the browser's language preferences but can still be overridden by the user's explicit locale preference (e.g. via editor.user.updateUserPreferences).
You can also set the locale imperatively after the editor mounts:
import { Tldraw } from 'tldraw'
import 'tldraw/tldraw.css'
export default function App() {
return (
<div style={{ position: 'fixed', inset: 0 }}>
<Tldraw
onMount={(editor) => {
// Change the locale to French
editor.user.updateUserPreferences({ locale: 'fr' })
// Get the current locale
const locale = editor.user.getLocale() // "fr"
}}
/>
</div>
)
}
The locale value uses standard language codes: 'en', 'fr', 'de', 'ja', 'zh-cn', 'ar', and so on.
When no locale is set, tldraw uses getDefaultTranslationLocale() to detect the user's preferred language from the browser:
import { getDefaultTranslationLocale } from '@tldraw/tlschema'
// Returns 'fr', 'en', 'zh-cn', etc. based on browser settings
const locale = getDefaultTranslationLocale()
The detection algorithm:
navigator.languages array'fr-CA' → 'fr')'zh' → 'zh-cn'), Portuguese ('pt' → 'pt-br'), Korean ('ko' → 'ko-kr'), and Hindi ('hi' → 'hi-in')'en' if no match is foundThe useTranslation hook returns a function for looking up translation strings:
import { useTranslation } from 'tldraw'
function CopyButton() {
const msg = useTranslation()
return <button>{msg('action.copy')}</button>
}
For access to the full translation object including locale and text direction:
import { useCurrentTranslation } from 'tldraw'
function LocaleInfo() {
const translation = useCurrentTranslation()
return (
<div dir={translation.dir}>
<p>Locale: {translation.locale}</p>
<p>Label: {translation.label}</p>
</div>
)
}
The TLUiTranslation object contains a locale code (e.g., 'fr'), a label in the native script (e.g., 'Français'), a messages record with all translation strings, and a dir indicating text direction ('ltr' or 'rtl').
Pass translation overrides through the overrides prop on Tldraw:
import { Tldraw } from 'tldraw'
function App() {
return (
<Tldraw
overrides={{
translations: {
en: {
'action.copy': 'Copy to clipboard',
'action.paste': 'Paste from clipboard',
},
fr: {
'action.copy': 'Copier dans le presse-papiers',
},
},
}}
/>
)
}
Overrides are merged with the base translations for each language. English serves as the fallback—any key missing from the target language uses the English string.
Translation keys follow a hierarchical naming convention. Common prefixes include action.* for user actions like copy and paste, tool.* for tool names, menu.* for menu labels, style-panel.* for style panel UI, and a11y.* for accessibility announcements.
The TLUiTranslationKey type provides autocomplete for all available keys:
import type { TLUiTranslationKey } from 'tldraw'
const key: TLUiTranslationKey = 'action.copy'
Import LANGUAGES from @tldraw/tlschema for the complete list of supported languages:
import { LANGUAGES } from '@tldraw/tlschema'
function LanguageSelector() {
return (
<select>
{LANGUAGES.map(({ locale, label }) => (
<option key={locale} value={locale}>
{label}
</option>
))}
</select>
)
}
Each entry in LANGUAGES has a locale code and a label in that language's native script.
The supported languages include: English, Spanish, French, German, Italian, Portuguese (Brazilian and European), Dutch, Russian, Polish, Czech, Danish, Finnish, Swedish, Hungarian, Norwegian, Romanian, Turkish, Ukrainian, Greek, Croatian, Slovenian, Arabic, Hebrew, Farsi, Urdu, Hindi, Tamil, Telugu, Malayalam, Kannada, Bengali, Gujarati, Nepali, Marathi, Punjabi, Thai, Khmer, Vietnamese, Indonesian, Malay, Filipino, Somali, Japanese, Korean, Simplified Chinese, Traditional Chinese (Taiwan), Catalan, and Galician.
Languages like Arabic, Hebrew, Farsi, and Urdu automatically set dir: 'rtl' in the translation object. The tldraw UI respects this direction. Layout and text alignment mirror automatically. The dir attribute is set on the editor's root container, and the built-in components use CSS logical properties (margin-inline-start, inset-inline-end, and so on) so they flip without per-component code.
When building custom UI components, use the useDirection hook to get the current text direction. It returns 'ltr' or 'rtl' from the active translation context — the same value you'd read from useCurrentTranslation().dir, but without pulling the rest of the translation object into the component:
import { useDirection } from 'tldraw'
function CustomPanel() {
const dir = useDirection()
return <aside dir={dir}></aside>
}
Use useCurrentTranslation instead when you also need the locale, label, or messages from the same render.
Here's a language picker that updates the user's locale preference:
import { useEditor, useValue } from 'tldraw'
import { LANGUAGES } from '@tldraw/tlschema'
function LanguagePicker() {
const editor = useEditor()
const currentLocale = useValue('locale', () => editor.user.getLocale(), [editor])
return (
<select
value={currentLocale}
onChange={(e) => {
editor.user.updateUserPreferences({ locale: e.target.value })
}}
>
{LANGUAGES.map(({ locale, label }) => (
<option key={locale} value={locale}>
{label}
</option>
))}
</select>
)
}
The language change applies immediately without a page reload. The preference persists to localStorage and synchronizes across browser tabs.
Translations load asynchronously when the locale changes. The system:
During loading, the UI uses the previous translations to avoid flicker. If loading fails, English remains as the fallback.