Iframe témák

A Chastify témainformációkat küld az iframe-bővítményeknek, hogy a felhasználói felület illeszkedjen ahhoz a zárolási oldalhoz, ahová be van ágyazva.

Ne feltételezd, hogy a felhasználó sötét témát használ. A bővítményed világos, sötét, egyéni, áttetsző és nagy kontrasztú témákban is megnyitható.

tanács

A legbiztonságosabb alapértelmezés szerint az iframe ui hasznos adatát tekintjük az oldal hátterének, szövegszínének és szegélyszínének igaz forrásának, majd a ui.isDark-ból származtatjuk a saját olvasható paneleket és jelvényeket.

Téma hasznos terhelése

Amikor a Chastify megnyitja az iframe-et, egy URI-kódolású JSON hasznos adatot fűz hozzá a location.hash-hoz.

A hasznos adat tartalmazza a ui kódot:

{
  "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"
  }
}

Mezők jelentése:

• ui.isDark: azt jelzi, hogy a tárhelyoldal jelenleg sötét megjelenésű témát használ-e.
• ui.bg: az oldal/felület háttere a gazdagéptől. Ez lehet egy szín vagy egy összetett CSS háttér.
• ui.text: elsődleges olvasható szövegszín.
• ui.border: a gazda témájához illő szegélyszín.

figyelem

A ui.bg lehet egy teljes CSS háttér karakterlánc, nem csak egy hexadecimális szín. CSS background értékként használd, ne manuálisan elemzett értékként.

A hash elemzése

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;
  }
}

Minimális CSS változók

Alakítsa át a hasznos adatot CSS változókká indításkor:

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";

Használd ezeket a változókat az alkalmazáshéjadban:

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

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

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

React példa

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>
  );
}

Hátszélminta

Ha Tailwind-et használsz, akkor a ui.isDark-tól indulj el minden olyan felületre, amely szöveget tartalmaz.

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";

Használja a kiválasztott osztályokat, ahol a szöveg megjelenik:

<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>

Élő témafrissítések

A szülő élő témafrissítéseket küldhet, amíg az iframe meg van nyitva:

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

Figyelj erre az üzenetre, és ellenőrizd a nonce-t:

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);
});

Gyakori hibák

• text-white vagy halvány text-*-100 kódolás a kártyákon belül, világos témájú alternatíva nélkül.
• Az oldal hátterének stílusának módosítása, de a beágyazott kártyák, jelvények, folyamatjelzők és eredménycsatornák elfelejtése.
• A ui.bg kódot egyszerű hexadecimális színként kezeljük. Lehet színátmenet vagy böngésző által normalizált CSS háttérkarakterlánc.
• Natív űrlapvezérlők használata háttér- és szövegszín beállítása nélkül. A kiválasztott opciók olvashatatlanná válhatnak sötét témákban.
• Feltételezve, hogy a témamódosításokhoz iframe újratöltésre van szükség. Figyelj a chastify:ext:ui kódra, ha élő frissítéseket szeretnél.

vigyázat

A témaadatok csak prezentációs adatok. Ne használd őket hitelesítésre, bizalmi döntésekre, logika feloldására, jutalmazásra, büntetésekre vagy háttér-munkamenet-azonosságra.

Ellenőrzőlista

Az iframe-bővítmény közzététele előtt:

• Tesztelje a világos témát.
• Sötét téma tesztelése.
• Teszteljen egy egyéni témát, ha van ilyen.
• Ellenőrizze, hogy minden kártya, gomb, jelvény, űrlapvezérlő, folyamatgyűrű és eredményüzenet olvasható kontraszttal rendelkezik-e.
• Ellenőrizd, hogy a szöveg még mindig elfér-e mobilon.
• Ellenőrizd, hogy az iframe automatikusan átméreteződik-e a téma vagy a tartalom módosítása után.

Következő: Iframe gyorstalpaló vagy API példák.