Zephora UI

Konfigurace

Globální nastavení pro každou Zephora komponentu — obalte aplikaci jednou pomocí ZephoraConfigProvider a nakonfigurujte locale, z-index vrstvy overlayů, portálový kontejner a headless výchozí nastavení.

Nastavení

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

PropTypVýchozíPopis
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.

Čtení konfigurace

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 vrstvy

Komponenty přebírají pořadí vrstvení z CSS proměnných s vestavěnými zálohami, takže je mohou přeladit jak provider, tak i prosté CSS:

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

Tmavý režim

@zephora/theme přináší automatické pomocníky pro tmavý režim. Hook useColorScheme vyřeší schéma (s mode: "system" živě sleduje předvolbu OS) a ve výchozím stavu aplikuje vyřešený motiv globálně:

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

PropTypVýchozíPopis
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žší úrovně primitiv jsou také exportovány:

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

Pro serverové vykreslování colorSchemeCss(light?, dark?) sestaví statický stylesheet, který přepíná motivy podle předvolby OS — žádný záblesk špatného motivu, žádný JavaScript potřebný před vykreslením. Nastavení data-zephora-scheme na <html> přepíše media query (napojte ho na uživatelský přepínač):

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

Víceslotové komponenty (Dialog, Sheet, Tabs, Card, Popover, Tooltip…) vystavují kontrakt tříd na slot: root přijímá classNames typované jako Partial<Record<<Name>Slot, string>> (uniony názvů slotů jako DialogSlot jsou exportovány). Třídy slotů se připojují za třídy modulu a nejsou omezeny unstyled — fungují ve stylovaném i unstyled režimu; v unstyled režimu jsou jedinými třídami. classNames.root se slučuje vedle stávajícího propu className, který nadále cílí na root a je aplikován jako poslední. U složených komponent se classNames nastavuje jednou na rootu a přenáší se do částí přes context.

Serverové komponenty

Publikovaný bundle @zephora/react se dodává s direktivou "use client", takže můžete komponenty importovat přímo do stromů React Server Component (Next.js app router), aniž byste direktivu přidávali sami — každá Zephora komponenta je klientská komponenta.