Konfigurasjon
Globale innstillinger for hver Zephora-komponent — pakk appen din én gang med ZephoraConfigProvider og konfigurer locale, overlay-z-index-lag, portalcontaineren og headless-standarden.
Oppsett
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 | Type | Standard | Beskrivelse |
|---|---|---|---|
locale | string | "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. |
appendTo | HTMLElement | null | document.body | Container that Portal-based overlays (Dialog, Select menus, Tooltip…) render into. |
unstyled | boolean | false | Makes every component headless by default for Tailwind-first apps. A per-component unstyled prop still wins. |
Lese konfigurasjonen
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-lag
Komponenter henter stablingsrekkefølgen fra CSS-variabler med innebygde fallbacks, så både provideren og vanlig CSS kan finjustere dem:
: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;
}Mørk modus
@zephora/theme leverer automatiske hjelpefunksjoner for mørk modus. Hooken useColorScheme løser opp et fargeskjema (med mode: "system" følger den OS-innstillingen live) og bruker som standard det oppløste temaet globalt:
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 | Type | Standard | Beskrivelse |
|---|---|---|---|
mode | "light" | "dark" | "system" | "system" | "system" follows the OS preference live; "light"/"dark" force a scheme. |
light / dark | Theme | lightTheme / darkTheme | Theme objects used for each scheme. |
apply | boolean | true | Write the resolved theme to document.documentElement via applyTheme. |
→ returns | { scheme: "light" | "dark"; theme: Theme } | — | The resolved scheme and the theme object in effect. |
Primitivene på lavere nivå eksporteres også:
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-fri SSR
For server-rendering bygger colorSchemeCss(light?, dark?) et statisk stilark som bytter tema med OS-innstillingen — ingen glimt av feil tema, ingen JavaScript nødvendig før paint. Å sette data-zephora-scheme på <html> overstyrer media-spørringen (koble den til en brukerbryter):
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
Komponenter med flere slots (Dialog, Sheet, Tabs, Card, Popover, Tooltip…) eksponerer en klassekontrakt per slot: roten aksepterer classNames typet som Partial<Record<<Name>Slot, string>> (slot-navn-unioner som DialogSlot eksporteres). Slot-klasser legges til etter modulklassene og styres ikke av unstyled — de fungerer i både stilt og ustilt modus; i ustilt modus er de de eneste klassene. classNames.root slås sammen med den eksisterende className-propen, som fortsetter å rette seg mot roten og brukes sist. For sammensatte komponenter settes classNames én gang på roten og føres videre til delene via context.
Serverkomponenter
Den publiserte @zephora/react-bundelen leveres med et "use client"-direktiv, så du kan importere komponenter direkte inne i React Server Component-trær (Next.js app router) uten å legge til direktivet selv — hver Zephora-komponent er en klientkomponent.