Languages

The widget ships with 7 built-in locales: English (en), French (fr), German (de), Spanish (es), Italian (it), Brazilian Portuguese (pt), and Russian (ru).

initSiteping({
  endpoint: "/api/siteping",
  projectName: "my-project",
  locale: "fr",
});

How resolution works

• English is bundled; every other locale loads as its own tiny chunk, so you only download the language you use.
• Full BCP-47 tags are welcome — "fr-CA" resolves to fr, "pt-BR" to pt.
• An unknown locale logs a console.warn and falls back to English. Nothing breaks.
• While a locale chunk is loading, labels render in English and re-localize the moment it lands; markers wait for the translations so screen-reader labels are never half-translated.

Custom locales

registerLocale(code, translations) adds a language the widget doesn't ship, and loadLocale(code) fetches a built-in dictionary ahead of time. Both are runtime exports of @siteping/widget:

import { initSiteping, registerLocale, type Translations } from "@siteping/widget";

registerLocale("nl", { "panel.title": "Feedbacks", "fab.annotate": "Nieuwe annotatie maken" });
initSiteping({ endpoint: "/api/siteping", projectName: "my-project", locale: "nl" });

Partial dictionaries are fine. Missing keys fall back to English key by key, so overriding a single string never means copying the whole catalog — pass the Translations type only if you want the full set checked. Two rules the implementation enforces: register under the base language code ("nl", not "nl-BE" — lookups normalize to the base), and call registerLocale before initSiteping.

await loadLocale("fr") before init if you want a built-in locale on screen from the first paint instead of a brief English flash.

The dashboard follows the same set

@siteping/dashboard ships the same seven locales with the same resolution rules, and exports its own registerLocale with the same partial-dictionary behavior — see the dashboard docs.

Want your language built in? Locale contributions are the friendliest first PR to this project — see CONTRIBUTING ("Adding a Locale").