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 является клиентским.