導入方法

Composer で入れて、ui:install で配線して、ビルドする。3 ステップで全コンポーネントと 37 テーマ × 11 チューンが使えるようになる。

前提条件

  • PHP 8.2 以上
  • Laravel 11 / 12 / 13
  • Tailwind CSS v4(Laravel 11+ の Vite 標準構成)
  • Node.js(Vite ビルド用)

1. パッケージを追加

bash
composer require sparrowhawk-labs/pinion-ui

アイコンパッケージ(pinion-icons)は依存として自動で入るので、個別にインストールする必要はありません。

2. ui:install で配線

bash
php artisan ui:install --ai

このコマンドが必要な配線をすべて行います:

  • npm 依存を追加 — daisyui ^5 / alpinejs ^3 / @alpinejs/focus / @alpinejs/collapse
  • resources/css/app.css に pinion-ui プリセットの @import を 1 行追加(テーマ・チューン・@source グロブを一括ロード)
  • resources/js/app.js に Alpine とプラグインの起動コードを配線
  • レイアウトの <html> に data-theme 属性をパッチ
  • --ai を付けると、プロジェクトの CLAUDE.md に AGENTS.md への参照を追記(AI エージェントが正しい使い方を読める状態にする)

3. ビルド

bash
npm install && npm run build

これで完了です。Blade テンプレートで <x-button> などのコンポーネントがそのまま使えます。

テーマとチューンを選ぶ

見た目は <html> の属性 2 つで決まります。data-theme が配色(37 パレット × ライト / ダーク)、data-tune が形・余白・書体(11 プリセット)。両者は直交していて自由に組み合わせられます。

html
<html data-theme="pinion" data-tune="default">

ナビバー右上の Theme / Tune スイッチャーで、このページ自体を含めて実際に切り替えながら選べます。

最初のコンポーネント

<x-button color="primary" icon="rocket">Hello Pinion</x-button>
<button class="inline-flex items-center justify-center whitespace-nowrap font-medium tracking-wide transition-colors focus:outline-none focus-visible:ring-2 focus-visible:ring-offset-2 rounded-[var(--radius-field)] border-[length:var(--border)] h-[var(--h-field-md)] px-[var(--px-field-md)] text-[length:var(--text-field-md)] gap-2 bg-primary text-primary-content border-primary hover:bg-primary/90 focus-visible:ring-primary cursor-pointer"><svg class="w-4 h-4" viewbox="0 0 24 24">
<path fill="currentColor" fill-rule="evenodd" d="m14.447 16.377l5.847-5.83c.842-.839 1.263-1.259 1.484-1.792S22 7.627 22 6.44v-.567c0-1.826 0-2.739-.569-3.306S19.947 2 18.116 2h-.57c-1.19 0-1.785 0-2.32.221c-.536.221-.957.641-1.8 1.48L7.58 9.531c-.984.98-1.594 1.589-1.83 2.176a1.5 1.5 0 0 0-.112.562c0 .802.647 1.448 1.942 2.739l.174.173l2.038-2.069a.75.75 0 1 1 1.069 1.053L8.816 16.24l.137.137c1.295 1.29 1.943 1.936 2.747 1.936c.178 0 .348-.031.519-.094c.603-.222 1.219-.836 2.228-1.842m2.747-6.846a1.946 1.946 0 0 1-2.747 0a1.93 1.93 0 0 1 0-2.738a1.946 1.946 0 0 1 2.747 0a1.93 1.93 0 0 1 0 2.738" clip-rule="evenodd"></path>
<path fill="currentColor" d="M9.034 5.963L6.491 8.5c-.467.466-.896.893-1.235 1.28a6 6 0 0 0-.619.82l-.024-.025l-.095-.094a4.9 4.9 0 0 0-1.532-1.004l-.123-.05l-.379-.15a.764.764 0 0 1-.259-1.252C3.345 6.907 4.69 5.566 5.34 5.297a3.4 3.4 0 0 1 1.788-.229c.546.081 1.063.362 1.907.895m4.342 13.35c.205.208.34.355.464.512q.243.311.434.658c.142.26.253.537.474 1.092a.69.69 0 0 0 1.126.224l.084-.083c1.12-1.117 2.465-2.458 2.735-3.105a3.35 3.35 0 0 0 .229-1.782c-.081-.545-.362-1.06-.897-1.902l-2.552 2.544c-.478.477-.916.914-1.313 1.256c-.237.206-.497.41-.784.586" opacity=".3"></path></svg> Hello Pinion</button>

動作確認はボタン 1 個で十分です。コンポーネント一覧から各コンポーネントの使い方ページに飛べます。 コンポーネントカタログ →

AI エージェントと使う

pinion-ui は AI コーディングを前提に設計されています。ui:install --ai が配線する AGENTS.md には、呼び出し規約・落とし穴・クラス語彙のルールがまとまっており、Claude Code などのエージェントはこれを読んで正しいコードを書きます。Blade 編集後に ui:lint を自動実行する Claude Code フックも同時にインストールされます(--skip-hooks で省略可)。