Skip to content

Installation

Voraussetzungen

Pakete

PaketBeschreibung
urcolorDie Farb-Engine allein, unter unskopiertem Namen. Re-exportiert @urcolor/core
@urcolor/coreFarblogik und Barrierefreiheits-Utilities
@urcolor/sharedFrameworkunabhängiges Verhalten, WebGL-Rendering und Grid-Sampler, die alle Bindings teilen
@urcolor/vueVue-3-Komponenten und Composables
@urcolor/reactReact-Komponenten und Hooks
@urcolor/preactDie React-Komponenten und -Hooks, gegen preact/compat kompiliert
@urcolor/svelteSvelte-5-Komponenten und Rune-Hooks
@urcolor/angularAngular-Direktiven und Signal-Stores
@urcolor/relativeOptionale relative Farbsyntax aus CSS Color 5
@urcolor/i18nMehrsprachige Farbnamen und Kanalbezeichnungen

Installieren

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

Preact

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

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

Jedes Framework-Paket hängt von @urcolor/core und @urcolor/shared ab – beide werden also mitinstalliert. Das Vue-Paket zieht zusätzlich Reka UI mit, das React-Paket Base UI; die Svelte- und Angular-Pakete haben keine weiteren Laufzeitabhängigkeiten.

Nur der Kern

Wenn du nur die Farb-Utilities ohne Framework-Binding brauchst, installiere urcolor, den unskopierten Namen derselben Engine:

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

urcolor enthält keinen eigenen Code. Es re-exportiert @urcolor/core und hängt in derselben Version davon ab wie die Framework-Pakete, du bekommst also so oder so eine Kopie der Engine und eine Color-Klasse. Nimm den Namen, der dir lieber ist: @urcolor/core ist ohnehin da, wenn du ein Framework-Binding installiert hast, und beide Namen in einem Projekt zu mischen ist unbedenklich.

Optionale Pakete

@urcolor/relative ergänzt die relative Farbsyntax aus CSS Color 5, @urcolor/i18n die mehrsprachige Farbbenennung:

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