mirror of
https://github.com/openfrontio/OpenFrontIO.git
synced 2026-07-01 06:43:24 +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
173 lines
5.0 KiB
TypeScript
173 lines
5.0 KiB
TypeScript
import { html } from "lit";
|
|
import { customElement, state } from "lit/decorators.js";
|
|
import { UserMeResponse } from "../../core/ApiSchemas";
|
|
import { getUserMe, hasLinkedAccount } from "../Api";
|
|
import { userAuth } from "../Auth";
|
|
import { translateText } from "../Utils";
|
|
import { BaseModal } from "./BaseModal";
|
|
import { modalHeader } from "./ui/ModalHeader";
|
|
|
|
@customElement("ranked-modal")
|
|
export class RankedModal extends BaseModal {
|
|
protected routerName = "ranked";
|
|
|
|
@state() private elo: number | string = "...";
|
|
@state() private userMeResponse: UserMeResponse | false = false;
|
|
@state() private errorMessage: string | null = null;
|
|
|
|
constructor() {
|
|
super();
|
|
this.id = "page-ranked";
|
|
}
|
|
|
|
connectedCallback() {
|
|
super.connectedCallback();
|
|
document.addEventListener(
|
|
"userMeResponse",
|
|
this.handleUserMeResponse as EventListener,
|
|
);
|
|
}
|
|
|
|
disconnectedCallback() {
|
|
document.removeEventListener(
|
|
"userMeResponse",
|
|
this.handleUserMeResponse as EventListener,
|
|
);
|
|
super.disconnectedCallback();
|
|
}
|
|
|
|
private handleUserMeResponse = (
|
|
event: CustomEvent<UserMeResponse | false>,
|
|
) => {
|
|
this.errorMessage = null;
|
|
this.userMeResponse = event.detail;
|
|
this.updateElo();
|
|
};
|
|
|
|
private updateElo() {
|
|
if (this.errorMessage) {
|
|
this.elo = translateText("map_component.error");
|
|
return;
|
|
}
|
|
|
|
if (hasLinkedAccount(this.userMeResponse)) {
|
|
this.elo =
|
|
this.userMeResponse &&
|
|
this.userMeResponse.player.leaderboard?.oneVone?.elo
|
|
? this.userMeResponse.player.leaderboard.oneVone.elo
|
|
: translateText("matchmaking_modal.no_elo");
|
|
}
|
|
}
|
|
|
|
protected override async onOpen(): Promise<void> {
|
|
this.elo = "...";
|
|
this.errorMessage = null;
|
|
|
|
try {
|
|
const userMe = await getUserMe();
|
|
this.userMeResponse = userMe;
|
|
} catch (error) {
|
|
console.error("Failed to fetch user profile for ranked modal", error);
|
|
this.userMeResponse = false;
|
|
this.errorMessage = translateText("map_component.error");
|
|
this.elo = translateText("map_component.error");
|
|
} finally {
|
|
this.updateElo();
|
|
}
|
|
}
|
|
|
|
createRenderRoot() {
|
|
return this;
|
|
}
|
|
|
|
protected renderHeaderSlot() {
|
|
return modalHeader({
|
|
title: translateText("mode_selector.ranked_title"),
|
|
onBack: () => this.close(),
|
|
ariaLabel: translateText("common.back"),
|
|
});
|
|
}
|
|
|
|
protected renderBody() {
|
|
return html`
|
|
<div class="custom-scrollbar p-6">
|
|
<div class="grid grid-cols-1 sm:grid-cols-2 gap-4">
|
|
${this.renderCard(
|
|
translateText("mode_selector.ranked_1v1_title"),
|
|
this.errorMessage ??
|
|
(hasLinkedAccount(this.userMeResponse)
|
|
? translateText("matchmaking_modal.elo", { elo: this.elo })
|
|
: translateText("mode_selector.ranked_title")),
|
|
() => this.handleRanked(),
|
|
)}
|
|
${this.renderDisabledCard(
|
|
translateText("mode_selector.ranked_2v2_title"),
|
|
translateText("mode_selector.coming_soon"),
|
|
)}
|
|
${this.renderDisabledCard(
|
|
translateText("mode_selector.coming_soon"),
|
|
"",
|
|
)}
|
|
${this.renderDisabledCard(
|
|
translateText("mode_selector.coming_soon"),
|
|
"",
|
|
)}
|
|
</div>
|
|
</div>
|
|
`;
|
|
}
|
|
|
|
private renderCard(title: string, subtitle: string, onClick: () => void) {
|
|
return html`
|
|
<button
|
|
@click=${onClick}
|
|
class="flex flex-col w-full h-28 sm:h-32 rounded-2xl bg-surface border-0 transition-transform hover:scale-[1.02] active:scale-[0.98] p-6 items-center justify-center gap-3"
|
|
>
|
|
<div class="flex flex-col items-center gap-1 text-center">
|
|
<h3
|
|
class="text-lg sm:text-xl font-bold text-white uppercase tracking-widest leading-tight"
|
|
>
|
|
${title}
|
|
</h3>
|
|
<p
|
|
class="text-xs text-white/60 uppercase tracking-wider whitespace-pre-line leading-tight"
|
|
>
|
|
${subtitle}
|
|
</p>
|
|
</div>
|
|
</button>
|
|
`;
|
|
}
|
|
|
|
private renderDisabledCard(title: string, subtitle: string) {
|
|
return html`
|
|
<div
|
|
class="group relative isolate flex flex-col w-full h-28 sm:h-32 overflow-hidden rounded-2xl bg-slate-900/40 backdrop-blur-md border-0 shadow-none p-6 items-center justify-center gap-3 opacity-50 cursor-not-allowed"
|
|
>
|
|
<div class="flex flex-col items-center gap-1 text-center">
|
|
<h3
|
|
class="text-lg sm:text-xl font-bold text-white/60 uppercase tracking-widest leading-tight"
|
|
>
|
|
${title}
|
|
</h3>
|
|
<p
|
|
class="text-xs text-white/40 uppercase tracking-wider whitespace-pre-line leading-tight"
|
|
>
|
|
${subtitle}
|
|
</p>
|
|
</div>
|
|
</div>
|
|
`;
|
|
}
|
|
|
|
private async handleRanked() {
|
|
if ((await userAuth()) === false) {
|
|
this.close();
|
|
window.showPage?.("page-account");
|
|
return;
|
|
}
|
|
|
|
document.dispatchEvent(new CustomEvent("open-matchmaking"));
|
|
}
|
|
}
|