Files
galaxy-game/ui/docs/README.md
T
Ilia Denisov 8dcaf1c6c6
Tests · UI / test (push) Waiting to run
Tests · UI / test (pull_request) Failing after 7m13s
feat(ui): error & state UX — error surface, view states, map selection, sheet gestures (F4)
- lib/error/: classify any caught error into a stable ErrorKind from the
  transport signal (HTTP status / Connect Code / fetch TypeError /
  navigator.onLine); map to translated error.* messages via reportError
  (sticky Retry toast for retryable kinds) or errorMessageKey (inline).
  Mail compose now surfaces the translated 403/error inline.
- lib/ui/view-state.svelte: shared loading/empty/error placeholder with
  the right live-region role + optional action; entity tables
  (races/sciences/ship-classes) migrated, rest adopt incrementally.
- map/selection-ring.ts: accent ring around the selected planet, fed into
  the map buildExtras alongside the reach circles.
- lib/ui/sheet-dismiss.ts: tap-outside + drag-handle swipe-down dismissal
  for the planet/ship-group bottom-sheets (hand-rolled pointer events).

Tests: error, view-state, selection-ring, sheet-dismiss (761 total).
Docs: ui/docs/error-state-ux.md (+ index); F4 marked done.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-22 13:29:11 +02:00

70 lines
3.0 KiB
Markdown

# UI client — topic docs
Deeper, topic-based documentation for the Galaxy web/cross-platform UI
client, beyond what fits in [`../README.md`](../README.md). Each file
describes how one area works (current state); the staged build history
lives in [`../PLAN.md`](../PLAN.md), the active web finalization in
[`../PLAN-finalize.md`](../PLAN-finalize.md), and deferred work in
[`../ROADMAP.md`](../ROADMAP.md).
## Foundation & platform
- [design-system.md](design-system.md) — the design tokens (colour /
spacing / typography), the light/dark theming mechanism, and the
component migration conventions.
- [a11y.md](a11y.md) — the WCAG 2.2 AA approach: axe + keyboard test
gates, the shared a11y primitives, coverage by area, and the map-canvas
alternative.
- [error-state-ux.md](error-state-ux.md) — the central error surface
(taxonomy → translated/actionable messages), the shared `ViewState`
placeholder, the selected-planet ring, and bottom-sheet dismissal.
- [navigation.md](navigation.md) — routes, the sidebar tabs, and the
state-preservation rules across view/tab switches.
- [storage.md](storage.md) — the `KeyStore` and `Cache` abstractions and
their web (IndexedDB) implementations.
- [game-state.md](game-state.md) — decoding the FlatBuffers report into
`GameReport` and the `GameState` / rendered-report stores.
- [sync-protocol.md](sync-protocol.md) — order-draft sync, turn cutoff,
conflict handling, and auto-pause.
- [events.md](events.md) — the signed push channel and event handling.
- [calc-bridge.md](calc-bridge.md) — the `pkg/calc` → WASM → TypeScript
bridge, with the live function surface and parity rules.
- [wasm-toolchain.md](wasm-toolchain.md) — building `ui/core` to
`core.wasm` with TinyGo.
- [testing.md](testing.md) — the UI test layers (Vitest + Playwright).
## Auth & lobby
- [auth-flow.md](auth-flow.md) — device keypair, email-code login, and
request signing on the client.
- [lobby.md](lobby.md) — the lobby/game-list UI and membership flows.
## Map & active views
- [renderer.md](renderer.md) — the PixiJS map renderer contract (world
model, hit-test, torus / no-wrap).
- [order-composer.md](order-composer.md) — the order tab and the
optimistic order overlay.
- [report-view.md](report-view.md) — the Reports view.
## Tools & inspectors
- [calculator-ux.md](calculator-ux.md) — the ship-class calculator
(design + goal-seek + planet build + reach circles + modernization).
- [science-designer-ux.md](science-designer-ux.md) — the science
designer.
- [ship-group-actions.md](ship-group-actions.md) — ship-group inspector
actions (move, send, upgrade, …).
- [cargo-routes-ux.md](cargo-routes-ux.md) — cargo-route composition and
reach filtering.
## Combat & comms
- [battle-viewer-ux.md](battle-viewer-ux.md) — the battle viewer.
- [diplomail-ui.md](diplomail-ui.md) — the diplomatic-mail view.
## Localisation
- [i18n.md](i18n.md) — the localisation mechanism and translation
bundles.