Skip to content

インストール

前提条件

パッケージ

パッケージ説明
urcolorカラーエンジン単体。スコープなしの名前で @urcolor/core を再エクスポートします
@urcolor/coreコアのカラーロジックとアクセシビリティユーティリティ
@urcolor/sharedすべてのバインディングが共有するフレームワーク非依存の振る舞い、WebGL 描画、グリッドサンプラー
@urcolor/vueVue 3 のコンポーネントとコンポーザブル
@urcolor/reactReact のコンポーネントとフック
@urcolor/svelteSvelte 5 のコンポーネントと rune ベースのフック
@urcolor/angularAngular のディレクティブと signal ストア
@urcolor/relativeオプトイン型の CSS Color 5 相対カラー構文
@urcolor/i18n多言語のカラー名とチャンネルラベル

インストール

Vue

sh
bun add @urcolor/vue
sh
npm install @urcolor/vue
sh
pnpm add @urcolor/vue
sh
yarn add @urcolor/vue

React

sh
bun add @urcolor/react
sh
npm install @urcolor/react
sh
pnpm add @urcolor/react
sh
yarn add @urcolor/react

Svelte

sh
bun add @urcolor/svelte
sh
npm install @urcolor/svelte
sh
pnpm add @urcolor/svelte
sh
yarn add @urcolor/svelte

Angular

sh
bun add @urcolor/angular
sh
npm install @urcolor/angular
sh
pnpm add @urcolor/angular
sh
yarn add @urcolor/angular

どのフレームワーク用パッケージも @urcolor/core@urcolor/shared に依存しているため、両方が一緒にインストールされます。さらに Vue パッケージは Reka UI、React パッケージは Base UI を取り込みます。Svelte と Angular のパッケージにはそれ以外のランタイム依存はありません。

コアのみ

フレームワークバインディングなしでカラーユーティリティだけが必要なら、同じエンジンのスコープなし名 urcolor をインストールします。

sh
bun add urcolor
sh
npm install urcolor
sh
pnpm add urcolor
sh
yarn add urcolor
ts
import { Color } from "urcolor";

urcolor 自体にコードはありません。@urcolor/core を再エクスポートし、フレームワークパッケージと同じバージョン範囲で依存しているため、どちらを選んでもエンジンと Color クラスは 1 つだけです。好きな名前を使ってください。フレームワークバインディングを入れていれば @urcolor/core はすでに存在し、1 つのプロジェクトで両方の名前を混ぜても問題ありません。

オプションのパッケージ

@urcolor/relative は CSS Color 5 の相対カラー構文を、@urcolor/i18n は多言語のカラーネーミングを追加します:

sh
bun add @urcolor/relative @urcolor/i18n
sh
npm install @urcolor/relative @urcolor/i18n
sh
pnpm add @urcolor/relative @urcolor/i18n
sh
yarn add @urcolor/relative @urcolor/i18n