設定
すべての Zephora コンポーネント向けのグローバル設定 — アプリを一度 ZephoraConfigProvider でラップして、ロケール、オーバーレイの 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 | 型 | デフォルト | 説明 |
|---|---|---|---|
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. |
設定の読み取り
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 フックはスキームを解決し(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 / 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. |
より低レベルのプリミティブもエクスポートされています:
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 を設定するとメディアクエリを上書きできます(ユーザーのトグルに接続してください):
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…)は、スロットごとのクラス契約を公開します: ルートは Partial<Record<<Name>Slot, string>> として型付けされた classNames を受け取ります(DialogSlot のようなスロット名の union がエクスポートされています)。スロットクラスはモジュールクラスの後に追加され、unstyled に左右されません — スタイル付きモードでもスタイルなしモードでも機能し、スタイルなしモードではそれが唯一のクラスになります。classNames.root は既存の className prop と並んでマージされ、className は引き続きルートを対象とし、最後に適用されます。複合コンポーネントでは、classNames はルートで一度だけ設定され、context を介して各パーツに引き渡されます。
サーバーコンポーネント
公開されている @zephora/react バンドルには "use client" ディレクティブが付属しているため、自分でディレクティブを追加することなく、React Server Component ツリー(Next.js app router)の内部にコンポーネントを直接インポートできます — すべての Zephora コンポーネントはクライアントコンポーネントです。