UI: UiProvider
Sets the locale of the components and their own texts. Import the token file once (@pithyx/ui/tokens.css) and wrap the app in UiProvider; see @pithyx/ui.
Generated from the TSDoc comments of @pithyx/ui 1.0.0-rc.9 at build time; the text below the headings is the comment in the source.
Interfaces
Section titled “Interfaces”UiProviderProps
Section titled “UiProviderProps”The props of UiProvider.
Properties
Section titled “Properties”locale
Section titled “locale”locale: string;A BCP 47 tag such as de-AT. Dates and numbers follow it; the texts follow its language.
children
Section titled “children”children: ReactNode;The app, or the part of it that uses the locale.
Functions
Section titled “Functions”UiProvider()
Section titled “UiProvider()”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.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
props |
UiProviderProps |
The locale and the components below it. |
Returns
Section titled “Returns”Element
React Aria’s I18nProvider with the locale.
Example
Section titled “Example”<UiProvider locale={app.context.locale}> <App /></UiProvider>