@serendie/ui
Version:
Adaptive UI component library as part of Serendie Design System by Mitsubishi Electric
40 lines (39 loc) • 1.38 kB
TypeScript
import { ColorMode, ColorTheme } from '../theme/ThemeContext';
export type Language = "ja" | "en";
export declare const LanguageContext: import('react').Context<Language | undefined>;
export interface SerendieProviderProps {
/** 言語設定 */
lang: Language;
/** カラーテーマ(デフォルト: 'konjo') */
colorTheme?: ColorTheme;
/** カラーモード(デフォルト: undefined = ライトモード) */
colorMode?: ColorMode;
children: React.ReactNode;
}
/**
* Serendie UIの設定を提供するProvider
* アプリケーションのルートで使用してください
*
* @example
* ```tsx
* // 基本的な使い方(言語のみ)
* <SerendieProvider lang="ja">
* <App />
* </SerendieProvider>
*
* // カラーモードを指定(OSの設定に従う)
* <SerendieProvider lang="ja" colorMode="system">
* <App />
* </SerendieProvider>
*
* // カラーテーマとモードを指定
* <SerendieProvider lang="ja" colorTheme="asagi" colorMode="system">
* <App />
* </SerendieProvider>
* ```
*/
export declare function SerendieProvider({ lang, colorTheme, colorMode, children, }: SerendieProviderProps): import("react/jsx-runtime").JSX.Element;
/**
* @deprecated LanguageProvider は SerendieProvider にリネームされました
*/
export declare const LanguageProvider: typeof SerendieProvider;