Zephora UI

Konfigurasi

Tetapan global untuk setiap komponen Zephora — balut aplikasi anda sekali dengan ZephoraConfigProvider dan konfigurasikan locale, lapisan z-index tindanan (overlay), konteks portal dan lalai headless.

Persediaan

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

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

Membaca konfigurasi

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

Lapisan z-index

Komponen mengambil susunan tindanannya daripada pemboleh ubah CSS dengan nilai lalai terbina dalam, jadi kedua-dua provider dan CSS biasa boleh melaraskannya semula:

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

Mod gelap

@zephora/theme hadir dengan pembantu mod gelap automatik. Hook useColorScheme menyelesaikan satu skema (dengan mode: "system" ia mengikut pilihan OS secara langsung) dan secara lalai menggunakan tema yang diselesaikan secara global:

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

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

Primitif peringkat lebih rendah turut dieksport:

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

Untuk pemaparan pelayan, colorSchemeCss(light?, dark?) membina helaian gaya statik yang menukar tema mengikut pilihan OS — tiada kilauan tema yang salah, tiada JavaScript diperlukan sebelum lukisan. Menetapkan data-zephora-scheme pada <html> mengatasi pertanyaan media (sambungkannya ke suis pengguna):

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

Komponen berbilang slot (Dialog, Sheet, Tabs, Card, Popover, Tooltip…) mendedahkan kontrak kelas setiap slot: akar menerima classNames yang ditaip sebagai Partial<Record<<Name>Slot, string>> (union nama slot seperti DialogSlot dieksport). Kelas slot ditambah selepas kelas modul dan tidak terkawal oleh unstyled — ia berfungsi dalam kedua-dua mod bergaya dan tanpa gaya; dalam mod tanpa gaya, ia satu-satunya kelas. classNames.root bergabung bersama prop className sedia ada, yang terus menyasarkan akar dan digunakan terakhir. Untuk komponen sebatian, classNames ditetapkan sekali pada akar dan dibawa ke bahagian-bahagian melalui context.

Komponen pelayan

Bundle @zephora/react yang diterbitkan hadir dengan arahan "use client", jadi anda boleh mengimport komponen secara langsung dalam pokok React Server Component (Next.js app router) tanpa menambah arahan itu sendiri — setiap komponen Zephora ialah komponen klien.