Zephora UI

Configuració

Configuració global per a cada component de Zephora — embolcalla la teva aplicació un sol cop amb ZephoraConfigProvider i configura la locale, les capes de z-index dels overlays, el contenidor del portal i el valor per defecte de headless.

Configuració

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

PropTipusPer defecteDescripció
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.

Llegir la configuració

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

Capes de z-index

Els components prenen el seu ordre d'apilament de variables CSS amb valors de reserva integrats, de manera que tant el provider com el CSS pla poden reajustar-los:

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

Mode fosc

@zephora/theme inclou helpers automàtics de mode fosc. El hook useColorScheme resol un esquema (amb mode: "system" segueix la preferència del sistema operatiu en directe) i, per defecte, aplica el tema resolt globalment:

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

PropTipusPer defecteDescripció
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.

Els primitius de més baix nivell també s'exporten:

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

SSR sense FOUC

Per al renderitzat al servidor, colorSchemeCss(light?, dark?) construeix un full d'estils estàtic que canvia de tema segons la preferència del sistema operatiu — sense flaix del tema incorrecte, sense necessitat de JavaScript abans del pintat. Establir data-zephora-scheme a <html> sobreescriu la media query (connecta-ho a un interruptor de l'usuari):

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

classNames de slot

Els components multi-slot (Dialog, Sheet, Tabs, Card, Popover, Tooltip…) exposen un contracte de classes per slot: l'arrel accepta classNames tipat com a Partial<Record<<Name>Slot, string>> (s'exporten unions de noms de slot com ara DialogSlot). Les classes de slot s'afegeixen després de les classes del mòdul i no depenen de unstyled — funcionen tant en mode amb estil com sense estil; en mode sense estil són les úniques classes. classNames.root es fusiona al costat del prop className existent, que continua apuntant a l'arrel i s'aplica en darrer lloc. Per als components compostos, classNames s'estableix un sol cop a l'arrel i es transporta a les parts a través del context.

Components de servidor

El bundle publicat de @zephora/react inclou una directiva "use client", de manera que pots importar els components directament dins d'arbres de React Server Component (Next.js app router) sense afegir-hi la directiva tu mateix — cada component de Zephora és un component de client.