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 ფენები

კომპონენტები დაწყობის რიგს ჩაშენებული fallback-ების მქონე 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"-ით ის ცოცხლად მიჰყვება OS-ის პარამეტრს) და ნაგულისხმევად წყვეტილ თემას გლობალურად ავრცელებს:

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?) აშენებს სტატიკურ სტილების ფაილს, რომელიც თემებს OS-ის პარამეტრით ცვლის — არასწორი თემის ციმციმის გარეშე, დახატვამდე 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 იღებს classNames-ს, ტიპით Partial<Record<<Name>Slot, string>> (slot-სახელის union-ები, როგორიცაა DialogSlot, ექსპორტირებულია). Slot-ის კლასები მოდულის კლასების შემდეგ ემატება და unstyled-ით არ იზღუდება — ისინი მუშაობს როგორც სტილიზებულ, ისე სტილის გარეშე რეჟიმში; სტილის გარეშე რეჟიმში ისინი ერთადერთი კლასებია. classNames.root მოქმედ className prop-ის გვერდით ერწყმის, რომელიც root-ს კვლავ მიზნად ინარჩუნებს და ბოლოს გამოიყენება. კომპოზიტური კომპონენტებისთვის classNames root-ზე ერთხელ ინიშნება და context-ის მეშვეობით ნაწილებს გადაეცემა.

სერვერის კომპონენტები

გამოქვეყნებული @zephora/react bundle მოდის "use client" დირექტივით, ამიტომ კომპონენტების პირდაპირ იმპორტი შეგიძლიათ React Server Component-ის ხეებში (Next.js app router) დირექტივის თავად დამატების გარეშე — ყველა Zephora კომპონენტი კლიენტის კომპონენტია.