Zephora UI

Määritykset

Globaalit asetukset jokaiselle Zephora-komponentille — kääri sovelluksesi kerran ZephoraConfigProvider-komponentilla ja määritä locale, overlay-kerrosten z-indeksit, portal-kontaineri ja headless-oletus.

Käyttöönotto

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

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

Määritysten lukeminen

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-kerrokset

Komponentit ottavat pinoamisjärjestyksensä CSS-muuttujista, joilla on sisäänrakennetut varasoivat arvot, joten sekä provider että pelkkä CSS voivat säätää niitä uudelleen:

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

Tumma tila

@zephora/theme sisältää automaattiset tumman tilan apurit. useColorScheme-hook ratkaisee skeeman (mode: "system" -asetuksella se seuraa käyttöjärjestelmän asetusta livenä) ja soveltaa oletuksena ratkaistun teeman globaalisti:

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

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

Myös matalamman tason primitiivit on viety ulos:

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-vapaa SSR

Palvelinrenderöintiä varten colorSchemeCss(light?, dark?) rakentaa staattisen tyylitiedoston, joka vaihtaa teemat käyttöjärjestelmän asetuksen mukaan — ei väärän teeman välähdystä, ei JavaScriptiä ennen piirtoa. data-zephora-scheme-attribuutin asettaminen <html>-elementtiin ohittaa media-kyselyn (kytke se käyttäjän vaihtimeen):

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

Monislottiset komponentit (Dialog, Sheet, Tabs, Card, Popover, Tooltip…) tarjoavat slottikohtaisen luokkasopimuksen: juuri hyväksyy classNames-propin, joka on tyypitetty muotoon Partial<Record<<Name>Slot, string>> (slottinimien unionit kuten DialogSlot on viety ulos). Slot-luokat lisätään moduuliluokkien jälkeen eikä niitä rajoita unstyled — ne toimivat sekä styled- että unstyled-tilassa; unstyled-tilassa ne ovat ainoat luokat. classNames.root sulautuu olemassa olevan className-propin rinnalle, joka kohdistuu edelleen juureen ja lisätään viimeisenä. Yhdistelmäkomponenteissa classNames asetetaan kerran juureen ja välitetään osiin kontekstin kautta.

Palvelinkomponentit

Julkaistu @zephora/react-paketti toimitetaan "use client"-direktiivillä, joten voit tuoda komponentteja suoraan React Server Component -puihin (Next.js app router) lisäämättä direktiiviä itse — jokainen Zephora-komponentti on client-komponentti.