Zephora UI

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

Әр Zephora компоненті үшін жаһандық параметрлер — қолданбаңызды бір рет ZephoraConfigProvider арқылы орап, locale, overlay z-index қабаттарын, portal контейнерін және 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

PropТүріӘдепкіСипаттама
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 айнымалыларынан алады, сондықтан оларды provider да, қарапайым 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 hook схеманы шешеді (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

PropТүріӘдепкіСипаттама
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();

FOUC-сыз SSR

Сервер рендерингі үшін colorSchemeCss(light?, dark?) тақырыптарды ОЖ баптауымен ауыстыратын статикалық стиль файлын құрады — қате тақырыптың жарқылы жоқ, бояудан бұрын JavaScript қажет емес. <html> элементінде data-zephora-scheme орнату media query-ді қайта анықтайды (оны пайдаланушы ауыстырғышына жалғаңыз):

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

Көп slot-ты компоненттер (Dialog, Sheet, Tabs, Card, Popover, Tooltip…) slot басына класс келісімін ұсынады: root Partial<Record<<Name>Slot, string>> ретінде типтелген classNames-ті қабылдайды (DialogSlot сияқты slot-атауы union-дары экспортталады). Slot кластары модуль кластарынан кейін қосылады және unstyled-қа тәуелді емес — олар стильденген де, стильсіз де режимде жұмыс істейді; стильсіз режимде олар жалғыз кластар. classNames.root бар className prop-пен қатар біріктіріледі; className root-ты нысанаға алуын жалғастырады және ең соңында қолданылады. Құрама компоненттерде classNames root-та бір рет орнатылып, context арқылы бөліктерге тасымалданады.

Сервер компоненттері

Жарияланған @zephora/react bundle-і "use client" директивасымен жеткізіледі, сондықтан компоненттерді React Server Component ағаштарына (Next.js app router) директиваны өзіңіз қоспай-ақ тікелей импорттай аласыз — әр Zephora компоненті клиенттік компонент.