Zephora UI

Konfiguracja

Globalne ustawienia dla każdego komponentu Zephora — opakuj aplikację raz w ZephoraConfigProvider i skonfiguruj locale, warstwy z-index nakładek, kontener portalu oraz domyślny tryb headless.

Konfiguracja

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

PropTypDomyślnieOpis
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.

Odczyt konfiguracji

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

Warstwy z-index

Komponenty pobierają kolejność nakładania ze zmiennych CSS z wbudowanymi wartościami zapasowymi, więc zarówno provider, jak i zwykły CSS mogą je dostrajać:

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

Tryb ciemny

@zephora/theme dostarcza automatyczne pomocniki trybu ciemnego. Hook useColorScheme rozwiązuje schemat (z mode: "system" na żywo podąża za preferencją systemu operacyjnego) i domyślnie stosuje rozwiązany motyw globalnie:

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

PropTypDomyślnieOpis
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.

Niższopoziomowe prymitywy są również eksportowane:

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

Dla renderowania po stronie serwera colorSchemeCss(light?, dark?) buduje statyczny arkusz stylów przełączający motywy zgodnie z preferencją systemu operacyjnego — bez błysku niewłaściwego motywu, bez potrzeby JavaScriptu przed pierwszym wyświetleniem. Ustawienie data-zephora-scheme na <html> nadpisuje zapytanie medialne (podłącz je do przełącznika użytkownika):

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 slotów

Komponenty wieloslotowe (Dialog, Sheet, Tabs, Card, Popover, Tooltip…) udostępniają kontrakt klas per slot: root przyjmuje classNames typowane jako Partial<Record<<Name>Slot, string>> (uniony nazw slotów, takie jak DialogSlot, są eksportowane). Klasy slotów dołączane są po klasach modułu i nie są ograniczane przez unstyled — działają zarówno w trybie stylowanym, jak i unstyled; w trybie unstyled są jedynymi klasami. classNames.root łączy się obok istniejącego propa className, który nadal celuje w root i jest stosowany jako ostatni. W komponentach złożonych classNames ustawiane jest raz na root i przenoszone do części przez context.

Komponenty serwerowe

Opublikowany bundle @zephora/react zawiera dyrektywę "use client", więc możesz importować komponenty bezpośrednio wewnątrz drzew React Server Component (Next.js app router) bez samodzielnego dodawania dyrektywy — każdy komponent Zephora jest komponentem klienckim.