導入
インストール
プロジェクトに Plumeria を追加し、JSX で sx を使えるようにします。
この資料のコマンドでは pnpm を使います。ほかのパッケージマネージャーでも Plumeria は同じように使えます。
自動で設定する
npx @plumeria/init はプロジェクトを調べ、自動で分からないことだけを質問します。その結果をもとにパッケージを追加し、バンドラープラグイン、plumeria.d.ts、ESLint を設定します。
npx @plumeria/init変更前に作業予定が表示されます。予定だけ確認するには --dry-run を付けます。質問と変更対象のファイルは @plumeria/init にすべて載っています。以下では、同じ設定を手動で行う方法も紹介します。
既存のプロジェクトを別のスタイルライブラリから移す場合は、初期設定の後に @plumeria/migrate を実行してください。
手動でパッケージを追加する
core パッケージに入っているのは型定義だけです。ブラウザーで実行するコードはバンドルに追加されません。
pnpm i -D @plumeria/coresx の型を読み込む
@plumeria/core を入れただけでは、スタイル用 prop の型は追加されません。標準の sx を使う場合は、src/plumeria.d.ts から付属の型宣言を参照します。src/ がなければ、プロジェクトのルートにファイルを置いてください。
/// <reference types="@plumeria/core/sx" />ほかの名前を使う場合は、prop の型宣言を参照してください。
ESLint を設定する
まずプラグインをインストールします。
pnpm i -D @plumeria/eslint-plugin@plumeria/eslint-plugin はスタイルのプロパティを並べ替えて整形し、無効な値やセレクターを報告します。リンク先にルールの一覧があります。
import eslint from '@eslint/js';
import tseslint from 'typescript-eslint';
import { defineConfig } from 'eslint/config';
import plumeria from '@plumeria/eslint-plugin';
export default defineConfig(
eslint.configs.recommended,
tseslint.configs.recommended,
plumeria.configs.recommended,
);バンドラープラグインは、標準でビルド時にこれらのルールをチェックします。追加設定なしでも、スタイルに警告やエラーがあればビルドが止まります。esbuild と Bun では、ビルドコマンドの前に plumeria-lint -- を付けてください。prop 名を classStyle に変えた場合は plumeria-lint --style-prop classStyle -- を使います。
バンドラーを設定する
使っているバンドラーに合うプラグインを追加します。
Next.js
pnpm i -D @plumeria/next-pluginTurbopack と Webpack の両方に対応しています。
ソースを変更すると、Next.js がビルドキャッシュを再利用した場合も、プラグインが CSS を更新します。dev や build の前に rimraf を入れたり、.next を削除したりする必要はありません。
import type { NextConfig } from "next";
import { withPlumeria } from "@plumeria/next-plugin";
const nextConfig: NextConfig = {
/* config options here */
};
export default withPlumeria(nextConfig);Vite
pnpm i -D @plumeria/unpluginimport { defineConfig } from 'vite';
import react from '@vitejs/plugin-react-swc';
import plumeria from '@plumeria/unplugin';
export default defineConfig({
plugins: [react(), plumeria.vite()],
});
次に読むページ
最初の項目ができていれば設定は完了です。続けて、基本の使い方も試してみてください。
- バンドラーに Plumeria を登録し、
plumeria.d.tsを置く - 配列の右側のスタイルで上書きする。Plumeria を使う理由
- 関数で定義したスタイルに実行時の値を渡す。スタイルの組み立て方
-
createThemeでテーマを切り替える。値を共有する - ビルドが止まったら、困ったときはでメッセージを探す