Zephora UI

Konfiguration

Globale indstillinger for hver Zephora-komponent — ombryd din app én gang med ZephoraConfigProvider og konfigurér locale, overlay-z-index-lag, portalcontaineren og headless-standarden.

Opsætning

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

PropTypeStandardBeskrivelse
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æse 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-lag

Komponenter henter deres stablingsrækkefølge fra CSS-variabler med indbyggede fallbacks, så både provideren og almindelig CSS kan finjustere 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ørk tilstand

@zephora/theme leverer automatiske hjælpefunktioner til mørk tilstand. Hook'et useColorScheme udleder et farveskema (med mode: "system" følger det OS-indstillingen live) og anvender som standard det udledte tema 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

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

Primitiverne på lavere niveau eksporteres også:

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

Til server-rendering bygger colorSchemeCss(light?, dark?) et statisk stilark, der skifter tema med OS-indstillingen — intet glimt af det forkerte tema, ingen JavaScript nødvendig før paint. At sætte data-zephora-scheme<html> tilsidesætter media-forespørgslen (kobl den til en brugerkontakt):

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 flere slots (Dialog, Sheet, Tabs, Card, Popover, Tooltip…) eksponerer en klassekontrakt pr. slot: roden accepterer classNames typet som Partial<Record<<Name>Slot, string>> (slot-navn-unioner som DialogSlot eksporteres). Slot-klasser tilføjes efter modulklasserne og styres ikke af unstyled — de fungerer i både stylet og ustylet tilstand; i ustylet tilstand er de de eneste klasser. classNames.root flettes sammen med den eksisterende className-prop, som fortsat retter sig mod roden og anvendes sidst. For sammensatte komponenter sættes classNames én gang på roden og føres videre til delene via context.

Serverkomponenter

Den publicerede @zephora/react-bundle leveres med et "use client"-direktiv, så du kan importere komponenter direkte inde i React Server Component-træer (Next.js app router) uden selv at tilføje direktivet — hver Zephora-komponent er en klientkomponent.