Skip to content

docs(next): update locale-aliases for gt-next v11 (getGTClass removed) #341

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

Closed
moss-bryophyta wants to merge 1 commit into from
Closed

docs(next): update locale-aliases for gt-next v11 (getGTClass removed) #341

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 11 additions & 15 deletions docs/en-US/next/guides/locale-aliases.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,21 +50,20 @@ While aliases work seamlessly for routing, there are three places where you **mu
2. Alternate link tags in your page metadata
3. Alternate entries in your sitemap

GT provides the `resolveCanonicalLocale()` method to convert aliases back to their BCP 47 codes. You can access it via `getGTClass` from `gt-next/server`:
GT provides the `resolveCanonicalLocale()` function to convert aliases back to their BCP 47 codes. Import it from `gt-next/server`:

```ts
import { getGTClass } from 'gt-next/server';
import { resolveCanonicalLocale } from 'gt-next/server';

const gtInstance = getGTClass();
const canonicalLocale = gtInstance.resolveCanonicalLocale('cn');
const canonicalLocale = resolveCanonicalLocale('cn');
// Returns: "zh"
```

For non-aliased locales, `resolveCanonicalLocale()` returns the input unchanged:

```ts
gtInstance.resolveCanonicalLocale('ja'); // "ja"
gtInstance.resolveCanonicalLocale('en-US'); // "en-US"
resolveCanonicalLocale('ja'); // "ja"
resolveCanonicalLocale('en-US'); // "en-US"
```

### 1. HTML `lang` attribute
Expand All @@ -74,7 +73,7 @@ The `<html lang>` attribute tells browsers and search engines what language the
In your root layout, resolve the locale before passing it to the `<html>` tag:

```tsx title="app/[locale]/layout.tsx"
import { getGTClass } from 'gt-next/server';
import { resolveCanonicalLocale } from 'gt-next/server';

export default function RootLayout({
children,
Expand All @@ -83,8 +82,7 @@ export default function RootLayout({
children: React.ReactNode;
params: { locale: string };
}) {
const gtInstance = getGTClass();
const canonicalLocale = gtInstance.resolveCanonicalLocale(params.locale);
const canonicalLocale = resolveCanonicalLocale(params.locale);

return (
<html lang={canonicalLocale}>
Expand All @@ -102,20 +100,19 @@ Alternate links tell search engines which versions of a page exist in other lang

```tsx title="app/[locale]/layout.tsx"
import type { Metadata } from 'next';
import { getGTClass } from 'gt-next/server';
import { resolveCanonicalLocale } from 'gt-next/server';

export async function generateMetadata({
params,
}: {
params: { locale: string };
}): Promise<Metadata> {
const gtInstance = getGTClass();
const locales = ['en-US', 'cn', 'ja', 'zh-Hant'];

// Build alternates with canonical BCP 47 codes as keys
const languages: Record<string, string> = {};
for (const locale of locales) {
const canonical = gtInstance.resolveCanonicalLocale(locale);
const canonical = resolveCanonicalLocale(locale);
languages[canonical] = `https://example.com/${locale}`;
}

Expand Down Expand Up @@ -149,10 +146,9 @@ If you use a [dynamic sitemap](https://nextjs.org/docs/app/api-reference/file-co

```ts title="app/sitemap.ts"
import type { MetadataRoute } from 'next';
import { getGTClass } from 'gt-next/server';
import { resolveCanonicalLocale } from 'gt-next/server';

export default function sitemap(): MetadataRoute.Sitemap {
const gtInstance = getGTClass();
const locales = ['en-US', 'cn', 'ja', 'zh-Hant'];
const baseUrl = 'https://example.com';

Expand All @@ -162,7 +158,7 @@ export default function sitemap(): MetadataRoute.Sitemap {
// Build language alternates with canonical codes
const languages: Record<string, string> = {};
for (const locale of locales) {
const canonical = gtInstance.resolveCanonicalLocale(locale);
const canonical = resolveCanonicalLocale(locale);
languages[canonical] = `${baseUrl}/${locale}${page}`;
}

Expand Down
Loading