Skip to content

chore(wiki): document Lingui plugin i18n #8

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

Open
NewtTheWolf wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −2
Open

chore(wiki): document Lingui plugin i18n #8

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
24 changes: 23 additions & 1 deletion content/wiki/building-plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,31 @@ Every hook is a thin, typed wrapper over the runtime `window.__TABULARIS_API__`:
| `usePluginSetting(pluginId)` | typed `getSetting<T>`, `setSetting`, `setSettings` |
| `usePluginModal()` | `openModal({ title, content, size })`, `closeModal` |
| `usePluginTheme()` | `themeId`, `isDark`, full `ThemeColors` token set |
| `usePluginTranslation(pluginId)` | i18next-compatible translator |
| `usePluginTranslation(pluginId)` | translator for your plugin's `locales/<lang>.json` (ICU `{var}` placeholders) |
| `openUrl(url)` | launches the **system** browser (not the Tauri webview) |

### Translating your plugin

The host app is localized with [Lingui](https://lingui.dev), and your plugin's UI can be too. The `--with-ui` scaffold ships a `locales/` folder — drop one JSON file per language beside your bundle and the host loads them automatically:

```
my-driver/
├── manifest.json
├── locales/
│ ├── en.json # { "preview.title": "Geometry preview" }
│ └── de.json # { "preview.title": "Geometrie-Vorschau" }
└── ui/…
```

Read them in a slot component with `usePluginTranslation`:

```tsx
const t = usePluginTranslation("my-driver");
return <h3>{t("preview.title")}</h3>;
```

Author keys ICU-style (`{var}`); legacy i18next `{{var}}` placeholders still resolve, so existing plugins keep working. Untranslated keys fall back to your `en.json`, then to the key itself — so a missing translation never breaks the UI.

### Multiple slots in one plugin

Plugins that touch more than one slot need more than one IIFE bundle (one per slot). The scaffold's `--with-ui` generates a single-entry Vite config; when you need two, duplicate the config file, change `entry` and `fileName`, and wire them through `package.json`:
Expand Down
2 changes: 1 addition & 1 deletion content/wiki/plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ Slot components can import hooks from `@tabularis/plugin-api`:
| `usePluginModal()` | Open host-managed modals with custom content |
| `usePluginSetting(pluginId)` | Read and write plugin-specific settings |
| `usePluginTheme()` | Access theme information (dark/light, colors) |
| `usePluginTranslation(pluginId)` | Access plugin-specific i18n translations |
| `usePluginTranslation(pluginId)` | Translate from the plugin's `locales/<lang>.json` (ICU `{var}`; `{{var}}` still supported) |
| `openUrl(url)` | Open a URL in the system browser |

### Error Isolation
Expand Down