はじめる
プロジェクトにYamada UIをインストールして使用する方法。
フレームワークを選択する
Next.js (App)
Next.jsのappディレクトリにYamada UIをインストールして使用するためのガイド。
Next.js (Pages)
Next.jsのpagesディレクトリにYamada UIをインストールして使用するためのガイド。
Vite
Vite.jsのプロジェクトにYamada UIをインストールして使用するためのガイド。
React Router
React RouterのプロジェクトにYamada UIをインストールして使用するためのガイド。
インストール
プロジェクトにYamada UIをインストールするには、CLIでセットアップするか、npmからインストールします。
Yamada UIは、React 19のみ互換性があります。React 18以前を使用している場合は、React 19までアップグレードしてください。
CLI
- 1
セットアップする
コマンドを実行すると、プロジェクトに必要なファイルやフォルダが作成されます。
pnpm dlx @yamada-ui/cli initnpx @yamada-ui/cli inityarn dlx @yamada-ui/cli initbunx @yamada-ui/cli init - 2
パッケージをインストールする
アプリケーションに
@workspaces/uiをインストールします。pnpm add "@workspaces/ui@workspace:*"npm install "@workspaces/ui@workspace:*"yarn add "@workspaces/ui@workspace:*"bun add "@workspaces/ui@workspace:*" - 3
プロバイダーを追加する
インストール後、アプリケーションのルートに
UIProviderを追加します。import { UIProvider } from "@workspaces/ui" const App = () => { return ( <UIProvider> <YourApplication /> </UIProvider> ) } - 4
コンポーネントを使用する
UIProviderを追加したら、アプリケーション内でコンポーネントを使用します。import { Button } from "@workspaces/ui" const App = () => { return <Button>Click me</Button> }これで、Yamada UIのセットアップは完了です!
npm
- 1
パッケージをインストールする
Yamada UIは、
@yamada-ui/reactをインストールするだけで、すべてのコンポーネントやフックを使用できます。pnpm add @yamada-ui/reactnpm install @yamada-ui/reactyarn add @yamada-ui/reactbun add @yamada-ui/react - 2
プロバイダーを追加する
インストール後、アプリケーションのルートに
UIProviderを追加します。import { UIProvider } from "@yamada-ui/react" const App = () => { return ( <UIProvider> <YourApplication /> </UIProvider> ) } - 3
コンポーネントを使用する
UIProviderを追加したら、アプリケーション内でコンポーネントを使用します。import { Button } from "@yamada-ui/react" const App = () => { return <Button>Click me</Button> }これで、Yamada UIのセットアップは完了です!