Skip to content

docs(i18n): compile the i18n README's 8 blocks and drop its ledger entry #7988

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
baozhoutao merged 1 commit into from
Sep 6, 2026
+35 −9
Merged

docs(i18n): compile the i18n README's 8 blocks and drop its ledger entry #7988

Show file tree
Hide file tree
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
42 changes: 35 additions & 7 deletions packages/i18n/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,15 @@ function MyComponent() {
Wraps your application with i18n context:

```tsx
import type { ReactNode } from 'react';
import { I18nProvider } from '@object-ui/i18n';

// Your app supplies the tree being wrapped.
declare const App: () => ReactNode;

<I18nProvider config={{ defaultLanguage: 'en', fallbackLanguage: 'en' }}>
<App />
</I18nProvider>
</I18nProvider>;
```

#### Language persistence
Expand All @@ -75,11 +81,16 @@ app no longer offers (not a built-in pack, not in `config.resources`) is ignored
translations.

```tsx
import type { ReactNode } from 'react';
import { I18nProvider } from '@object-ui/i18n';

declare const Preview: () => ReactNode;

// Fixed-language surfaces (previews, demos, screenshot harnesses) opt out —
// they neither restore nor write the preference.
<I18nProvider config={{ defaultLanguage: 'en' }} persistLanguage={false}>
<Preview />
</I18nProvider>
</I18nProvider>;
```

Bringing your own `instance`? Then its bootstrap language is yours to choose —
Expand All @@ -91,7 +102,18 @@ Switching through such an instance is still persisted.
Hook for translations and language management:

```tsx
const { t, language, changeLanguage, direction } = useObjectTranslation();
import { useObjectTranslation } from '@object-ui/i18n';

function LanguageBar() {
const { t, language, changeLanguage, direction } = useObjectTranslation();

return (
<div dir={direction}>
{t('common.save')} — {language}
<button onClick={() => changeLanguage('zh')}>中文</button>
</div>
);
}
```

### createI18n
Expand All @@ -109,13 +131,19 @@ i18n.t('common.cancel'); // "Abbrechen"

Locale-aware formatting functions:

Each formatter takes the value first and an **options object** second; the
locale is a field on that object (`DateFormatOptions`, `CurrencyFormatOptions`,
`NumberFormatOptions`), never a positional argument. `formatRelativeTime` is the
one exception: it takes the locale directly, and derives the unit from how far
the date is from now.

```tsx
import { formatDate, formatCurrency, formatNumber, formatRelativeTime } from '@object-ui/i18n';

formatDate(new Date(), 'en'); // "Jan 1, 2025"
formatCurrency(99.99, 'USD', 'en'); // "$99.99"
formatNumber(1234567, 'de'); // "1.234.567"
formatRelativeTime(-3, 'days', 'en'); // "3 days ago"
formatDate(new Date(2025, 0, 1), { locale: 'en' }); // "Jan 1, 2025"
formatCurrency(99.99, { currency: 'USD', locale: 'en' }); // "$99.99"
formatNumber(1234567, { locale: 'de' }); // "1.234.567"
formatRelativeTime(Date.now() - 3 * 86_400_000, 'en'); // "3 days ago"
```

### Built-in Locales
Expand Down
2 changes: 0 additions & 2 deletions scripts/check-doc-snippet-types.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -719,8 +719,6 @@ const UNGATED_DOCS = {
'self-contained or declared, plus a way to declare a block whose rejection IS the point.',
'packages/fields/README.md':
'2 undefined-name diagnostic(s) — blocks continue an earlier block, or use ambient names the page never defines; 1 unresolved-module diagnostic(s)',
'packages/i18n/README.md':
'7 undefined-name diagnostic(s) — blocks continue an earlier block, or use ambient names the page never defines; plus TS2554x2 TS2559x2 — candidate real defects, un-triaged',
'packages/layout/README.md':
'3 undefined-name diagnostic(s) — blocks continue an earlier block, or use ambient names the page never defines; 3 unresolved-module diagnostic(s)',
'packages/permissions/README.md':
Expand Down
Loading