Motywy iframe

Chastify wysyła informacje o motywie do rozszerzeń iframe, dzięki czemu interfejs użytkownika może być dopasowany do strony blokady, na której jest osadzony.

Nie zakładaj, że użytkownik korzysta z ciemnego motywu. Twoje rozszerzenie może działać w jasnym, ciemnym, niestandardowym, półprzezroczystym i kontrastowym motywie.

wskazówka

Najbezpieczniejszym rozwiązaniem domyślnym jest traktowanie zawartości ramki iframe ui jako źródła informacji o tle strony, kolorze tekstu i kolorze obramowania, a następnie wygenerowanie własnych czytelnych paneli i emblematów na podstawie ui.isDark.

Ładunek motywu

Gdy Chastify otwiera ramkę iframe, dołącza do niej zakodowany w URI ładunek JSON do location.hash.

Ładunek zawiera ui:

{
  "bridge": {
    "v": 1,
    "nonce": "request-nonce",
    "parentOrigin": "https://chastify.net"
  },
  "sessionId": "extension-session-id",
  "lockId": "lock-id",
  "ui": {
    "isDark": true,
    "bg": "rgb(10, 10, 10)",
    "text": "#e5e7eb",
    "border": "#27272a"
  }
}

Znaczenie pól:

• ui.isDark: czy strona hosta używa obecnie ciemnego motywu.
• ui.bg: tło strony/powierzchni z hosta. Może to być kolor lub złożone tło CSS.
• ui.text: podstawowy kolor czytelnego tekstu.
• ui.border: kolor obramowania pasujący do motywu hosta.

uwaga

ui.bg może być pełnym ciągiem tła CSS, a nie tylko kolorem szesnastkowym. Użyj go jako wartości CSS background, a nie jako wartości parsowanej ręcznie.

Przeanalizuj skrót

type ChastifyThemePayload = {
  ui?: {
    isDark?: boolean;
    bg?: string;
    text?: string;
    border?: string;
  };
};

export function parseHashPayload(): ChastifyThemePayload | null {
  const raw = window.location.hash.startsWith("#")
    ? window.location.hash.slice(1)
    : window.location.hash;

  if (!raw) return null;

  try {
    return JSON.parse(decodeURIComponent(raw));
  } catch {
    return null;
  }
}

Minimalne zmienne CSS

Przekonwertuj ładunek na zmienne CSS jednorazowo podczas uruchamiania:

const payload = parseHashPayload();
const ui = payload?.ui ?? {};
const isDark = ui.isDark !== false;

document.documentElement.style.setProperty("--chastify-bg", ui.bg || (isDark ? "#040711" : "#f8fafc"));
document.documentElement.style.setProperty("--chastify-text", ui.text || (isDark ? "#e5e7eb" : "#0f172a"));
document.documentElement.style.setProperty("--chastify-border", ui.border || (isDark ? "#27272a" : "#e2e8f0"));
document.documentElement.dataset.themeMode = isDark ? "dark" : "light";

Użyj tych zmiennych w powłoce aplikacji:

html,
body,
#root {
  min-height: 100%;
  margin: 0;
}

body {
  background: var(--chastify-bg);
  color: var(--chastify-text);
}

.panel {
  border: 1px solid var(--chastify-border);
}

Przykład Reacta

import { useMemo } from "react";

function getTheme(payload: any) {
  const ui = payload?.ui ?? {};
  const isDark = ui.isDark !== false;

  return {
    isDark,
    pageStyle: {
      background: ui.bg || (isDark ? "#040711" : "#f8fafc"),
      color: ui.text || (isDark ? "#e5e7eb" : "#0f172a"),
    } satisfies React.CSSProperties,
    panelClass: isDark
      ? "border-white/10 bg-black/35 text-slate-100"
      : "border-slate-200 bg-white/85 text-slate-950 shadow-sm",
    mutedClass: isDark ? "text-slate-400" : "text-slate-600",
    badgeClass: isDark
      ? "bg-sky-400/15 text-sky-200"
      : "bg-sky-50 text-sky-900 ring-1 ring-sky-200",
  };
}

export function ExtensionApp({ payload }: { payload: any }) {
  const theme = useMemo(() => getTheme(payload), [payload]);

  return (
    <main style={theme.pageStyle} className="min-h-screen p-4">
      <section className={`rounded-2xl border p-4 ${theme.panelClass}`}>
        <h1 className="text-xl font-bold">My Extension</h1>
        <p className={`mt-2 text-sm ${theme.mutedClass}`}>
          This text stays readable on light and dark Chastify themes.
        </p>
        <span className={`mt-3 inline-flex rounded-full px-3 py-1 text-xs font-semibold ${theme.badgeClass}`}>
          Connected
        </span>
      </section>
    </main>
  );
}

Wzór wiatru tylnego

Jeśli używasz Tailwind, rozgałęzij się od ui.isDark dla każdej powierzchni zawierającej tekst.

const isDarkTheme = payload?.ui?.isDark !== false;

const panelClass = isDarkTheme
  ? "border-white/10 bg-black/30 text-slate-100"
  : "border-slate-200 bg-white/85 text-slate-950 shadow-sm";

const successClass = isDarkTheme
  ? "border-emerald-300/20 bg-emerald-400/10 text-emerald-100"
  : "border-emerald-500/25 bg-emerald-50 text-emerald-950";

const errorClass = isDarkTheme
  ? "border-rose-300/20 bg-rose-400/10 text-rose-100"
  : "border-rose-500/25 bg-rose-50 text-rose-950";

Użyj wybranych klas, w których renderowany jest tekst:

<div className={`rounded-xl border px-3 py-2 text-sm ${result.ok ? successClass : errorClass}`}>
  <div className="font-semibold">{result.title}</div>
  <div className="mt-1 opacity-85">{result.message}</div>
</div>

Aktualizacje motywu na żywo

Rodzic może wysyłać aktualizacje motywu na żywo, gdy Twoja ramka iframe jest otwarta:

type UiUpdateMessage = {
  type: "chastify:ext:ui";
  v: 1;
  nonce: string;
  ui: {
    isDark?: boolean;
    bg?: string;
    text?: string;
    border?: string;
  };
};

Odczekaj na tę wiadomość i zweryfikuj nonce:

const nonce = payload.bridge.nonce;
const parentOrigin = payload.bridge.parentOrigin;

window.addEventListener("message", (event) => {
  if (event.origin !== parentOrigin) return;

  const msg = event.data as Partial<UiUpdateMessage>;
  if (msg.type !== "chastify:ext:ui" || msg.v !== 1) return;
  if (msg.nonce !== nonce) return;

  applyTheme(msg.ui);
});

Typowe błędy

• Na stałe zakoduj text-white lub blady text-*-100 wewnątrz kart bez alternatywy w postaci jasnego motywu.
• Stylizowanie tła strony, ale zapominanie o zagnieżdżonych kartach, odznakach, pierścieniach postępu i kanałach wyników.
• Traktujemy ui.bg jako prosty kolor szesnastkowy. Może to być gradient lub ciąg tła CSS znormalizowany przez przeglądarkę.
• Korzystanie z natywnych kontrolek formularza bez ustawienia koloru tła i tekstu. Wybrane opcje mogą stać się nieczytelne w ciemnych motywach.
• Zakładając, że zmiany w motywie wymagają przeładowania ramki iframe, należy oczekiwać komunikatu chastify:ext:ui, jeśli chcesz otrzymywać aktualizacje na żywo.

ostrzeżenie

Dane motywu to wyłącznie dane prezentacyjne. Nie należy ich używać do autoryzacji, decyzji o zaufaniu, logiki odblokowywania, nagród, kar ani identyfikacji sesji zaplecza.

Lista kontrolna

Przed opublikowaniem rozszerzenia iframe:

• Przetestuj jasny motyw.
• Przetestuj ciemny motyw.
• Jeśli jest dostępny, przetestuj niestandardowy motyw.
• Sprawdź, czy wszystkie karty, przyciski, odznaki, kontrolki formularzy, pierścienie postępu i komunikaty o wynikach mają czytelny kontrast.
• Sprawdź, czy tekst nadal wyświetla się na urządzeniu mobilnym.
• Sprawdź, czy rozmiar ramki iframe zmienia się automatycznie po zmianie motywu lub treści.

Dalej: Szybki start iframe lub Przykłady API.