Fix #5760: Locale setup docs (#5762)

primefaces · Jan 13, 2024 · f2d49de · f2d49de
1 parent 3a221fe
commit f2d49de
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 1 deletion.
diff --git a/components/doc/configuration/locale/setuplocaledoc.js b/components/doc/configuration/locale/setuplocaledoc.js
@@ -0,0 +1,35 @@
+import { DocSectionCode } from '@/components/doc/common/docsectioncode';
+import { DocSectionText } from '@/components/doc/common/docsectiontext';
+
+export function SetupLocaleDoc(props) {
+    const code = {
+        basic: `
+//_app.js
+import { PrimeReactProvider } from 'primereact/api';
+
+export default function MyApp({ Component }) {
+    const value = {
+        locale: 'de',
+        ...
+    };
+
+    return (
+        <PrimeReactProvider value={value}>
+            <App />
+        </PrimeReactProvider>
+    );
+}
+        `
+    };
+
+    return (
+        <>
+            <DocSectionText {...props}>
+                <p>
+                    To establish the default locale for your entire application, you can utilize the <i>PrimeReactProvider</i>.
+                </p>
+            </DocSectionText>
+            <DocSectionCode code={code} hideToggleCode import hideCodeSandbox hideStackBlitz />
+        </>
+    );
+}
diff --git a/pages/configuration/index.js b/pages/configuration/index.js
@@ -1,6 +1,5 @@
 import { DocComponent } from '@/components/doc/common/doccomponent';
 import { AppendToDoc } from '@/components/doc/configuration/appendtodoc';
-import { StyleContainer } from '@/components/doc/configuration/stylecontainer';
 import { CSSTransitionDoc } from '@/components/doc/configuration/csstransitiondoc';
 import { FilterMatchModeDoc } from '@/components/doc/configuration/filtermatchmodedoc';
 import { HideOverlaysDoc } from '@/components/doc/configuration/hideoverlaysdoc';
@@ -9,9 +8,11 @@ import { AddLocaleDoc } from '@/components/doc/configuration/locale/addlocaledoc
 import { ImportDoc } from '@/components/doc/configuration/locale/importdoc';
 import { RepositoryDoc } from '@/components/doc/configuration/locale/repositorydoc';
 import { SetLocaleDoc } from '@/components/doc/configuration/locale/setlocaledoc';
+import { SetupLocaleDoc } from '@/components/doc/configuration/locale/setuplocaledoc';
 import { NonceDoc } from '@/components/doc/configuration/noncedoc';
 import { NullSortOrderDoc } from '@/components/doc/configuration/nullsortorderdoc';
 import { RippleDoc } from '@/components/doc/configuration/rippledoc';
+import { StyleContainer } from '@/components/doc/configuration/stylecontainer';
 import { ZIndexDoc } from '@/components/doc/configuration/zindexdoc';
 
 const InstallationPage = () => {
@@ -70,6 +71,11 @@ const InstallationPage = () => {
             id: 'Locale',
             label: 'Locale',
             children: [
+                {
+                    id: 'setup',
+                    label: 'Setup',
+                    component: SetupLocaleDoc
+                },
                 {
                     id: 'import',
                     label: 'Import',