Iframe teme

Chastify šalje informacije o temi iframe ekstenzijama kako bi vaše korisničko sučelje moglo odgovarati zaključanoj stranici na koju su ugrađene.

Nemojte pretpostavljati da korisnik koristi tamnu temu. Vaše proširenje može se otvoriti u svijetlim, tamnim, prilagođenim, prozirnim i temama visokog kontrasta.

tip

Najsigurnija zadana vrijednost je tretirati iframe ui korisni teret kao izvor istine za pozadinu stranice, boju teksta i boju obruba, a zatim izvesti vlastite čitljive panele i značke iz ui.isDark.

Teret teme

Kada Chastify otvori vaš iframe, dodaje URI-kodirani JSON korisni teret location.hash.

Korisni teret uključuje 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"
  }
}

Značenja polja:

• ui.isDark: koristi li host stranica trenutno tamnu temu.
• ui.bg: pozadina stranice/površine s hosta. To može biti boja ili složena CSS pozadina.
• ui.text: primarna boja čitljivog teksta.
• ui.border: boja obruba koja odgovara temi hosta.

caution

ui.bg može biti puni CSS niz pozadine, ne samo heksadecimalna boja. Koristite ga kao CSS background vrijednost, a ne kao vrijednost koju ručno parsirate.

Analiziraj hash

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

Pretvorite korisni teret u CSS varijable prilikom pokretanja:

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

Koristite te varijable u svojoj ljusci aplikacije:

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

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

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

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

Uzorak vjetra u leđa

Ako koristite Tailwind, granajte se od ui.isDark za svaku površinu koja sadrži 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";

Koristite odabrane klase gdje se tekst prikazuje:

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

Ažuriranja tema uživo

Roditelj može slati ažuriranja teme uživo dok je vaš iframe otvoren:

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

Osluškujte tu poruku i provjerite 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);
});

Uobičajene pogreške

• Hardkodiranje text-white ili blijedi text-*-100 unutar kartica bez alternative svijetle teme.
• Stiliziranje pozadine stranice, ali zaboravljanje ugniježđenih kartica, znački, prstenova napretka i rezultata.
• Tretira ui.bg kao jednostavnu heksadecimalnu boju. Može biti gradijent ili CSS niz pozadine normaliziran preglednikom.
• Korištenje izvornih kontrola obrasca bez postavljanja boje pozadine i teksta. Odabir opcija može postati nečitljiv u tamnim temama.
• Pod pretpostavkom da je potrebno ponovno učitavanje iframea za promjene teme. Osluškujte chastify:ext:ui ako želite ažuriranja uživo.

warning

Podaci teme su samo podaci za prezentaciju. Nemojte ih koristiti za autorizaciju, odluke o povjerenju, logiku otključavanja, nagrade, kazne ili identitet pozadinske sesije.

Kontrolni popis

Prije objavljivanja iframe ekstenzije:

• Testna svijetla tema.
• Testiraj tamnu temu.
• Testirajte prilagođenu temu ako je dostupna.
• Provjerite imaju li sve kartice, gumbi, značke, kontrole obrazaca, prstenovi napretka i poruke s rezultatima čitljiv kontrast.
• Provjerite odgovara li tekst mobitelu.
• Provjerite automatski li se veličina iframea mijenja nakon promjene teme ili sadržaja.

Sljedeće: Brzi početak za Iframe ili Primjeri API-ja.