Zum Inhalt springen

UI: UiProvider

Als Markdown ansehen

Setzt die Locale der Komponenten und ihrer eigenen Texte. Importiere die Token-Datei einmal (@pithyx/ui/tokens.css) und umschließe die App mit UiProvider; siehe @pithyx/ui.

Beim Build aus den TSDoc-Kommentaren von @pithyx/ui 1.0.0-rc.9 erzeugt; der Text unter den Überschriften ist der Kommentar im Quelltext und bleibt Englisch.

The props of UiProvider.

locale: string;

A BCP 47 tag such as de-AT. Dates and numbers follow it; the texts follow its language.

children: ReactNode;

The app, or the part of it that uses the locale.

function UiProvider(props): Element;

Sets the language of the components below it: React Aria’s formatting and announcements, and the package’s own texts (English and German; English for any other language). Without it, both follow the browser.

Parameter Typ Beschreibung
props UiProviderProps The locale and the components below it.

Element

React Aria’s I18nProvider with the locale.

<UiProvider locale={app.context.locale}>
<App />
</UiProvider>