個別のインストール
パッケージをインストールする
Yamada UIのコアやユーティリティをインストールします。
ターミナルで次のコマンドのいずれかを実行します。
pnpm add @yamada-ui/core @yamada-ui/theme @yamada-ui/utils
次に、プロジェクトに使用したいコンポーネントやフックをインストールしていきます。
ここでは、Box
などを含んでいる@yamada-ui/layouts
をインストールしてみましょう。
pnpm add @yamada-ui/layouts
コンポーネントやフックのパッケージ名は、各ドキュメントページに記載されています。
ThemeProvider
を追加する
コアやコンポーネントをインストール後、アプリケーションのルートにThemeProvider
, ResetStyle
, GlobalStyle
を追加し、@yamada-ui/theme
からデフォルトのテーマとデフォルトのコンフィグを渡します。もし、あなたのテーマやコンフィグがある場合は、そちらを渡します。
import { ThemeProvider, ResetStyle, GlobalStyle } from "@yamada-ui/core"import { defaultTheme, defaultConfig } from "@yamada-ui/theme"const App = () => {return (<ThemeProvider theme={defaultTheme} config={defaultConfig}><ResetStyle /><GlobalStyle /><YourApplication /></ThemeProvider>)}
ダークモードを対応させたい場合は、ColorModeProvider
も追加します。
import {ThemeProvider,ColorModeProvider,ResetStyle,GlobalStyle,} from "@yamada-ui/core"import { defaultTheme, defaultConfig } from "@yamada-ui/theme"const App = () => {return (<ThemeProvider theme={defaultTheme} config={defaultConfig}><ColorModeProvider config={defaultConfig}><ResetStyle /><GlobalStyle /><YourApplication /></ColorModeProvider></ThemeProvider>)}
テーマやコンフィグをカスタマイズしたい場合は、テーマをカスタマイズするとコンフィグをカスタマイズするをご覧ください。
theme
やconfig
をThemeProvider
に渡さない場合、コンポーネントのスタイルやトークンは反映されません。
コンポーネントを使用する
アプリケーション内でコンポーネントを呼び出します。
import { Box } from "@yamada-ui/layouts"const Demo = () => {return <Box>This is Box</Box>}
これで、Yamada UIのセットアップは完了です!
学習を開始する
Yamada UIを知るために、基本やテーマを学んでみませんか?😎
基本を学ぶ
3分間のチュートリアルを読んで、Yamada UIのテーマ・スタイル・レスポンシブ・ダークモード・アニメーションの基本を学ぶ。
テーマについて学ぶ
Yamada UIのデフォルトのテーマを知り、色・フォント・その他のテーマの値を作成・変更する方法を学ぶ。
コンポーネントを探索する
Yamada UIは、100以上の柔軟性が高いコンポーネントを提供しています。すべてのコンポーネントは、アニメーション・ダークモードをサポートしています。
ソースコードを探索する
Yamada UIのパッケージ・ドキュメントサイトはオープンソースです。Yamada UIを気に入ったら、スターを付けてください。
GitHubでこのページを編集する