Zephora UI

Konfiguration

Globala inställningar för varje Zephora-komponent — svep din app en gång med ZephoraConfigProvider och konfigurera locale, overlay-z-index-lager, portalcontainern och headless-standarden.

Uppsättning

import { ZephoraConfigProvider } from "@zephora/react";

export default function App() {
  return (
    <ZephoraConfigProvider
      locale="tr"
      zIndex={{ modal: 2000, toast: 2100 }}
      appendTo={typeof document !== "undefined" ? document.body : null}
      unstyled={false}
    >
      <YourApp />
    </ZephoraConfigProvider>
  );
}

ZephoraConfigProvider props

PropTypStandardBeskrivning
localestring"en"Active locale for component UI strings. Only "en" is embedded; load others from @zephora/theme/locales/* (module or JSON) and register with addLocale().
zIndex{ dropdown?, overlay?, modal?, popover?, toast?, tooltip?: number }Overrides the layering of floating elements. Written as --z-index-* CSS variables on the root element.
appendToHTMLElement | nulldocument.bodyContainer that Portal-based overlays (Dialog, Select menus, Tooltip…) render into.
unstyledbooleanfalseMakes every component headless by default for Tailwind-first apps. A per-component unstyled prop still wins.

Läsa konfigurationen

import { useZephoraConfig, useLocale } from "@zephora/react";

function MyField() {
  const config = useZephoraConfig(); // { locale, zIndex, appendTo, unstyled }
  const { t, messages, locale } = useLocale();
  return <button aria-label={t("close")} />;
}

z-index-lager

Komponenter hämtar sin stapelordning från CSS-variabler med inbyggda fallbacks, så både providern och vanlig CSS kan justera om dem:

:root {
  --z-index-dropdown: 1000;
  --z-index-overlay: 1040;
  --z-index-modal: 1050;
  --z-index-popover: 1060;
  --z-index-toast: 1070;
  --z-index-tooltip: 1080;
}

Mörkt läge

@zephora/theme levererar automatiska hjälpfunktioner för mörkt läge. Hooken useColorScheme löser upp ett färgschema (med mode: "system" följer den OS-inställningen live) och tillämpar som standard det upplösta temat globalt:

import { useColorScheme } from "@zephora/theme";

function App() {
  // mode: "light" | "dark" | "system" (default "system")
  const { scheme, theme } = useColorScheme({ mode: "system" });
  return <span>Active scheme: {scheme}</span>;
}

useColorScheme(options) props

PropTypStandardBeskrivning
mode"light" | "dark" | "system""system""system" follows the OS preference live; "light"/"dark" force a scheme.
light / darkThemelightTheme / darkThemeTheme objects used for each scheme.
applybooleantrueWrite the resolved theme to document.documentElement via applyTheme.
→ returns{ scheme: "light" | "dark"; theme: Theme }The resolved scheme and the theme object in effect.

Primitiverna på lägre nivå exporteras också:

import { getSystemColorScheme, watchSystemColorScheme } from "@zephora/theme";

// Reads the OS color scheme (SSR-safe; defaults to "light").
const scheme = getSystemColorScheme(); // "light" | "dark"

// Subscribes to OS changes. Returns an unsubscribe function.
const stop = watchSystemColorScheme((next) => console.log(next));
stop();

FOUC-fri SSR

För server-rendering bygger colorSchemeCss(light?, dark?) en statisk stilmall som byter tema med OS-inställningen — ingen blixt av fel tema, ingen JavaScript behövs före paint. Att sätta data-zephora-scheme<html> åsidosätter media-frågan (koppla den till en användarväxel):

import { colorSchemeCss } from "@zephora/theme";

// Next.js app router — app/layout.tsx
export default function RootLayout({ children }: { children: React.ReactNode }) {
  return (
    <html lang="en">
      <head>
        <style dangerouslySetInnerHTML={{ __html: colorSchemeCss() }} />
      </head>
      <body>{children}</body>
    </html>
  );
}

Slot-classNames

Komponenter med flera slots (Dialog, Sheet, Tabs, Card, Popover, Tooltip…) exponerar ett klasskontrakt per slot: roten accepterar classNames typad som Partial<Record<<Name>Slot, string>> (slot-namns-unioner som DialogSlot exporteras). Slot-klasser läggs till efter modulklasserna och styrs inte av unstyled — de fungerar i både stilat och ostilat läge; i ostilat läge är de de enda klasserna. classNames.root slås ihop med den befintliga className-propen, som fortsätter att rikta in sig på roten och tillämpas sist. För sammansatta komponenter sätts classNames en gång på roten och förs vidare till delarna via context.

Serverkomponenter

Den publicerade @zephora/react-bundlen levereras med ett "use client"-direktiv, så du kan importera komponenter direkt inuti React Server Component-träd (Next.js app router) utan att lägga till direktivet själv — varje Zephora-komponent är en klientkomponent.