Skip to content

docs: expand i18n README #1565

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

Draft
Himavarshit18 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: expand i18n README #1565

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
1 change: 0 additions & 1 deletion frontend/docs/development/i18n.md
View file
Open in desktop

This file was deleted.

21 changes: 19 additions & 2 deletions frontend/src/i18n/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
# i18n Internationalization / Localization

We try and keep all the i18n related things in here.
Nebraska frontend uses [i18next](https://www.i18next.com/) for internationalization. Translation files are organized by namespace in `locales/en/` (`common.json`, `applications.json`, `groups.json`, etc.).

See the [i18n docs](../../docs/development/i18n.md) for full details.
## Using Translations

```typescript
import { useTranslation } from 'react-i18next';

function MyComponent() {
const { t } = useTranslation();
return <div>{t('common|confirmation_prompt')}</div>;
}
```

## Extracting Translation Keys

```bash
npm run i18n
```

This scans source files and updates translation JSON files.