Zephora UI

Конфігурація

Глобальні налаштування для кожного компонента Zephora — один раз оберніть застосунок у ZephoraConfigProvider і налаштуйте locale, шари z-index для оверлеїв, контейнер портала та headless-типове значення.

Налаштування

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

ПропТипТиповоОпис
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.

Читання конфігурації

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

Компоненти беруть порядок накладання з CSS-змінних із вбудованими запасними значеннями, тож і провайдер, і звичайний 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;
}

Темний режим

@zephora/theme постачається з автоматичними помічниками темного режиму. Хук useColorScheme розв'язує схему (з mode: "system" він наживо слідує за налаштуванням ОС) і за замовчуванням застосовує розв'язану тему глобально:

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

ПропТипТиповоОпис
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.

Низькорівневі примітиви також експортуються:

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 без FOUC

Для серверного рендерингу colorSchemeCss(light?, dark?) будує статичну таблицю стилів, що перемикає теми за налаштуванням ОС — без спалаху неправильної теми, без потреби в JavaScript до відмалювання. Встановлення data-zephora-scheme на <html> перевизначає медіазапит (прив'яжіть його до користувацького перемикача):

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

Багатослотові компоненти (Dialog, Sheet, Tabs, Card, Popover, Tooltip…) надають контракт класів за слотами: корінь приймає classNames, типізований як Partial<Record<<Name>Slot, string>> (об'єднання імен слотів на кшталт DialogSlot експортуються). Класи слотів додаються після класів модуля й не залежать від unstyled — вони працюють і в стилізованому, і в unstyled-режимі; в unstyled-режимі вони єдині класи. classNames.root об'єднується з наявним пропом className, який далі націлений на корінь і застосовується останнім. Для складених компонентів classNames задається один раз на корені й передається частинам через context.

Server components

Опублікований бандл @zephora/react постачається з директивою "use client", тож ви можете імпортувати компоненти прямо всередині дерев React Server Component (Next.js app router), не додаючи директиву самостійно — кожен компонент Zephora є клієнтським.