mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-06-21 11:10:42 +00:00
bcc453e8cf
## Description Adds a modal URL router so modals can be opened, deep-linked, and bookmarked via the hash. URLs of the form `#modal=<name>&tab=<key>&...` open the named modal and pass remaining keys as args to `onOpen`. The reverse direction also syncs: opening a modal via the UI updates the URL, closing it clears the hash, and switching tabs updates `&tab=`. Builds on the BaseModal refactor from #3923. ### What's new **`ModalRouter.ts`** — small registry + two-way sync helper. - `register(name, { tag, pageId? })` declares a modal as router-managed - `routeFromHash()` parses `#modal=...` and dispatches to `modal.open(args)` - `syncOpened/syncClosed/syncTab` push state back into the URL via `history.replaceState` (no history entries) - A `routingFromUrl` flag prevents URL→modal→URL feedback loops - Unknown modal names silently strip the hash **`BaseModal`** — opt-in URL sync via a `routerName` property. - When set, BaseModal calls into `modalRouter.syncOpened/syncClosed/syncTab` from `open` / `close` / `setActiveTab` - Modals that own their own URL state (lobby modals) just leave `routerName` undefined **`Main.ts`** — registers all routable modals and wires the router. - `handleUrl()`: adds a `modalRouter.routeFromHash()` branch after the path-based lobby join - `onHashUpdate`: when the hash is router-managed, routes via the router instead of tearing down lobby state ### Routable modals 13 inline modals: store, settings, leaderboard, clan, account, help, news, language, single-player, ranked, troubleshooting, territory-patterns, flag-input. Excluded by design: join-lobby, host-lobby (own URL state via `/game/<id>`), matchmaking (no URL state). ### Example uses - Deep link to store flags tab: `/#modal=store&tab=flags` - Settings keybinds tab: `/#modal=settings&tab=keybinds` - Cosmetics.ts now redirects to `#modal=store&tab=packs` when a hard-currency purchase fails for insufficient plutonium (after the alert), so users can top up directly ### URL behavior - `replaceState` everywhere — no history entries added when modals open / close / switch tabs - Browser back/forward still works for the existing path-based game flow - `hashchange` events are router-aware so external hash changes (back button, manual edit) correctly switch between routed modals without tearing down lobby state ## Please complete the following: - [x] I have added screenshots for all UI updates _(no visual changes; smoke-tested in dev)_ - [x] I process any text displayed to the user through translateText() and I've added it to the en.json file _(no new user-visible strings)_ - [ ] I have added relevant tests to the test directory _(no test coverage; manually tested URL load, UI open, tab switch, close, hashchange, insufficient-plutonium redirect)_ - [x] I confirm I have thoroughly tested these changes and take full responsibility for any bugs introduced ## Please put your Discord username so you can be contacted if a bug or regression is found: DISCORD_USERNAME
98 lines
3.1 KiB
TypeScript
98 lines
3.1 KiB
TypeScript
import { html, LitElement } from "lit";
|
|
import { resolveMarkdown } from "lit-markdown";
|
|
import { customElement, property, query } from "lit/decorators.js";
|
|
import version from "resources/version.txt?raw";
|
|
import { translateText } from "../client/Utils";
|
|
import { assetUrl } from "../core/AssetUrls";
|
|
import { BaseModal } from "./components/BaseModal";
|
|
import { modalHeader } from "./components/ui/ModalHeader";
|
|
import { normalizeNewsMarkdown } from "./NewsMarkdown";
|
|
|
|
@customElement("news-modal")
|
|
export class NewsModal extends BaseModal {
|
|
protected routerName = "news";
|
|
|
|
@property({ type: String }) markdown = "Loading...";
|
|
|
|
private initialized: boolean = false;
|
|
|
|
protected renderHeaderSlot() {
|
|
return modalHeader({
|
|
title: translateText("news.title"),
|
|
onBack: () => this.close(),
|
|
ariaLabel: translateText("common.back"),
|
|
});
|
|
}
|
|
|
|
protected renderBody() {
|
|
return html`
|
|
<div
|
|
class="prose prose-invert prose-sm max-w-none px-6 py-3
|
|
[&_a]:text-blue-400 [&_a:hover]:text-blue-300 transition-colors
|
|
[&_h1]:text-2xl [&_h1]:font-bold [&_h1]:mb-4 [&_h1]:text-white [&_h1]:border-b [&_h1]:border-white/10 [&_h1]:pb-2
|
|
[&_h2]:text-xl [&_h2]:font-bold [&_h2]:mt-6 [&_h2]:mb-3 [&_h2]:text-blue-200
|
|
[&_h3]:text-lg [&_h3]:font-semibold [&_h3]:mt-4 [&_h3]:mb-2 [&_h3]:text-blue-100
|
|
[&_ul]:pl-5 [&_ul]:my-3 [&_ul]:list-disc [&_ul]:space-y-1
|
|
[&_li]:text-gray-300 [&_li]:leading-relaxed
|
|
[&_p]:text-gray-300 [&_p]:mb-3 [&_strong]:text-white [&_strong]:font-bold"
|
|
>
|
|
${resolveMarkdown(this.markdown, {
|
|
includeImages: true,
|
|
includeCodeBlockClassNames: true,
|
|
})}
|
|
</div>
|
|
`;
|
|
}
|
|
|
|
protected onOpen(): void {
|
|
if (!this.initialized) {
|
|
this.initialized = true;
|
|
fetch(assetUrl("changelog.md"))
|
|
.then((response) => (response.ok ? response.text() : "Failed to load"))
|
|
.then((markdown) => normalizeNewsMarkdown(markdown))
|
|
.then((markdown) => (this.markdown = markdown))
|
|
.catch(() => (this.markdown = "Failed to load"));
|
|
}
|
|
}
|
|
}
|
|
|
|
@customElement("news-button")
|
|
export class NewsButton extends LitElement {
|
|
@query("news-modal") private newsModal!: NewsModal;
|
|
|
|
connectedCallback() {
|
|
super.connectedCallback();
|
|
this.checkForNewVersion();
|
|
}
|
|
|
|
private checkForNewVersion() {
|
|
const lastSeenVersion = localStorage.getItem("last-seen-version");
|
|
if (lastSeenVersion !== null && lastSeenVersion !== version) {
|
|
setTimeout(() => {
|
|
this.open();
|
|
}, 500);
|
|
}
|
|
}
|
|
|
|
public open() {
|
|
localStorage.setItem("last-seen-version", version);
|
|
this.newsModal.open();
|
|
}
|
|
|
|
render() {
|
|
return html`
|
|
<button
|
|
class="border p-[4px] rounded-lg flex cursor-pointer border-black/30 dark:border-gray-300/60 bg-white/70 dark:bg-[rgba(55,65,81,0.7)] hidden"
|
|
@click=${this.open}
|
|
>
|
|
<img
|
|
class="size-[48px] dark:invert"
|
|
src="${assetUrl("images/Megaphone.svg")}"
|
|
alt=${translateText("news.title")}
|
|
/>
|
|
</button>
|
|
<news-modal></news-modal>
|
|
`;
|
|
}
|
|
}
|