iframe-temaer

Chastify sender temainformasjon til iframe-utvidelser slik at brukergrensesnittet ditt kan matche låsesiden der det er innebygd.

Ikke anta at brukeren bruker et mørkt tema. Utvidelsen din kan åpnes i lyse, mørke, tilpassede, gjennomskinnelige og høykontrast-temaer.

tip

Den sikreste standardinnstillingen er å behandle iframe-nyttelasten ui som sannhetskilden for sidebakgrunn, tekstfarge og kantfarge, og deretter utlede dine egne lesbare paneler og merker fra ui.isDark.

Tema nyttelast

Når Chastify åpner iframe-en din, legger den til en URI-kodet JSON-nyttelast i location.hash.

Nyttelasten inkluderer 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"
  }
}

Feltbetydninger:

• ui.isDark: om vertssiden for øyeblikket bruker et mørkt tema.
• ui.bg: side-/overflatebakgrunn fra verten. Dette kan være en farge eller en kompleks CSS-bakgrunn.
• ui.text: primær lesbar tekstfarge.
• ui.border: kantfarge som samsvarer med vertstemaet.

caution

ui.bg kan være en fullstendig CSS-bakgrunnsstreng, ikke bare en heksadesimal farge. Bruk den som en CSS background-verdi, ikke som en verdi du analyserer manuelt.

Analyser hashen

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

Minimale CSS-variabler

Konverter nyttelasten til CSS-variabler ved oppstart:

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

Bruk disse variablene i app-skallet ditt:

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

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

Medvindsmønster

Hvis du bruker Tailwind, forgren deg fra ui.isDark for hver overflate som inneholder 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";

Bruk de valgte klassene der teksten gjengis:

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

Live-temaoppdateringer

Forelderen kan sende live temaoppdateringer mens iframe-en din er åpen:

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

Lytt etter meldingen og bekreft noncen:

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

Vanlige feil

• Hardkoding av text-white eller bleke text-*-100 inni kort uten et lyst temaalternativ.
• Styling av sidebakgrunnen, men glem nestede kort, merker, fremdriftsringer og resultatfeeder.
• Behandler ui.bg som en enkel heksadesimal farge. Det kan være en gradient eller nettlesernormalisert CSS-bakgrunnsstreng.
• Bruker innebygde skjemakontroller uten å angi både bakgrunns- og tekstfarge. Valgalternativer kan bli uleselige i mørke temaer.
• Forutsatt at en iframe-innlasting er nødvendig for temaendringer. Lytt etter chastify:ext:ui hvis du vil ha liveoppdateringer.

warning

Temadata er kun presentasjonsdata. Ikke bruk dem til autorisasjon, tillitsbeslutninger, opplåsingslogikk, belønninger, straffer eller identitet for backend-økter.

Sjekkliste

Før du publiserer iframe-utvidelsen din:

• Test lystema.
• Test mørkt tema.
• Test et tilpasset tema hvis tilgjengelig.
• Kontroller at alle kort, knapper, merker, skjemakontroller, fremdriftsringer og resultatmeldinger har lesbar kontrast.
• Bekreft at teksten fortsatt passer på mobilen.
• Bekreft at iframe-størrelsen automatisk endres etter endringer i tema eller innhold.

Neste: Iframe-hurtigstart eller API-eksempler.