orbit/orbit-client-docs
orbit/orbit-client-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: cover orbit.modal() and pinned messages

Browse source
This commit is contained in:
orbit-docs 2026-07-04 03:38:53 +00:00
parent f06cc502f0
commit 44771bcdee
No known key found for this signature in database
2 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/overview.md
View file

@ -24,6 +24,8 @@ network** and **rebranded** from a single `config.json`, without recompiling.
closed. closed.
- **Rich messages.** Image, audio and YouTube links expand inline, and `||spoiler||` text stays - **Rich messages.** Image, audio and YouTube links expand inline, and `||spoiler||` text stays
hidden until you click it. hidden until you click it.
- **Pinned messages.** Pin the lines that matter; a per-channel list in the header jumps you
straight back to any of them.
- **Speaks 10 languages.** The UI, system messages, and the bundled plugins are fully translated - **Speaks 10 languages.** The UI, system messages, and the bundled plugins are fully translated
and auto-detected (English, French, German, Spanish, Italian, Turkish, Russian, Nepali, and and auto-detected (English, French, German, Spanish, Italian, Turkish, Russian, Nepali, and
Brazilian + European Portuguese). Pin a default with `defaults.lang`. Brazilian + European Portuguese). Pin a default with `defaults.lang`.

1
docs/plugins.md
View file

@ -92,6 +92,7 @@ instead. See **[Compiled plugins](https://orbit.tchatou.fr/docs/compiled-plugins
| `orbit.addShortcut(combo, run)` | register a keyboard shortcut, e.g. `"mod+shift+k"` (mod = Cmd/Ctrl) | | `orbit.addShortcut(combo, run)` | register a keyboard shortcut, e.g. `"mod+shift+k"` (mod = Cmd/Ctrl) |
| `orbit.addTheme(id, {name, vars, css?, icon?, color?})` | register a runtime theme; shows in Settings → Appearance | | `orbit.addTheme(id, {name, vars, css?, icon?, color?})` | register a runtime theme; shows in Settings → Appearance |
| `orbit.notify(title, body?)` | fire a brand-styled desktop notification (asks permission once) | | `orbit.notify(title, body?)` | fire a brand-styled desktop notification (asks permission once) |
| `orbit.modal(render, {title?, wide?})` | open a modal dialog (core owns the shell); returns a close function |
| `orbit.h / orbit.html` | render helpers | | `orbit.h / orbit.html` | render helpers |
| `log(…)` | namespaced console logger | | `log(…)` | namespaced console logger |