Configuração

Definições globais para todos os componentes Zephora — envolva a sua app uma vez com ZephoraConfigProvider e configure a locale, as camadas z-index dos overlays, o contentor do portal e o predefinido headless.

Configuração

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	Tipo	Predefinição	Descrição
`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.

Ler a configuração

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")} />;
}

Camadas z-index

Os componentes obtêm a sua ordem de empilhamento a partir de variáveis CSS com fallbacks integrados, por isso tanto o provider como o CSS simples as podem reajustar:

: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;
}

Modo escuro

@zephora/theme inclui helpers automáticos de modo escuro. O hook useColorScheme resolve um esquema (com mode: "system" segue a preferência do SO em tempo real) e, por predefinição, aplica o tema resolvido globalmente:

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	Tipo	Predefinição	Descrição
`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.

As primitivas de mais baixo nível também são exportadas:

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 sem FOUC

Para renderização no servidor, colorSchemeCss(light?, dark?) cria uma folha de estilos estática que troca de tema conforme a preferência do SO — sem flash do tema errado, sem necessidade de JavaScript antes do paint. Definir data-zephora-scheme no <html> substitui a media query (ligue-o a um interruptor do utilizador):

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>
  );
}

classNames de slot

Os componentes multi-slot (Dialog, Sheet, Tabs, Card, Popover, Tooltip…) expõem um contrato de classe por slot: a raiz aceita classNames tipado como Partial<Record<<Name>Slot, string>> (as uniões de nome de slot como DialogSlot são exportadas). As classes de slot são acrescentadas depois das classes do módulo e não dependem de unstyled — funcionam tanto no modo estilizado como no não estilizado; no modo não estilizado são as únicas classes. classNames.root combina-se com a prop className existente, que continua a apontar para a raiz e é aplicada por último. Nos componentes compostos, classNames é definido uma vez na raiz e transportado para as partes através do context.

Componentes de servidor

O bundle publicado do @zephora/react vem com uma diretiva "use client", por isso pode importar componentes diretamente dentro de árvores de React Server Component (app router do Next.js) sem adicionar a diretiva manualmente — cada componente Zephora é um componente de cliente.