Skip to content

Docs: Clarify locale precedence when using PrimeReactProvider #8453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
melloware merged 2 commits into from
Dec 31, 2025
+29 −3
Merged

Docs: Clarify locale precedence when using PrimeReactProvider #8453

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
789ec15
Docs: clarify locale precedence when using PrimeReactProvider
Coderxrohan Dec 31, 2025
2b51f7d
Docs: format locale setup documentation
Coderxrohan Dec 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions components/doc/configuration/locale/setuplocaledoc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { DocSectionText } from '@/components/doc/common/docsectiontext';
export function SetupLocaleDoc(props) {
const code = {
basic: `
//_app.js
// _app.js
import { PrimeReactProvider } from 'primereact/api';

export default function MyApp({ Component }) {
Expand All @@ -15,7 +15,7 @@ export default function MyApp({ Component }) {

return (
<PrimeReactProvider value={value}>
<App />
<Component />
</PrimeReactProvider>
);
}
Expand All @@ -26,9 +26,35 @@ export default function MyApp({ Component }) {
<>
<DocSectionText {...props}>
<p>
To establish the default locale for your entire application, you can utilize the <i>PrimeReactProvider</i>.
To establish the default locale for your entire application, you can utilize the
<i> PrimeReactProvider</i>.
</p>

<p>
When <b>PrimeReactProvider</b> is used, it becomes the primary source of locale configuration for all PrimeReact components.
</p>

<h5>Locale Precedence</h5>
<p>Locale resolution follows the order below:</p>
<ul>
<li>
<code>locale</code> prop defined on a component
</li>
<li>
<code>PrimeReactProvider</code> (<code>context.locale</code>)
</li>
<li>
Global <code>PrimeReact.locale</code> set via <code>locale()</code>
</li>
<li>Browser locale</li>
</ul>

<p>
This means that once <b>PrimeReactProvider</b> is present, calling
<code> locale()</code> alone is not sufficient. The locale must be provided explicitly through the provider.
</p>
</DocSectionText>

<DocSectionCode code={code} hideToggleCode import hideStackBlitz />
</>
);
Expand Down
Loading