Skip to content

安装

环境要求

软件包

软件包说明
urcolor仅颜色引擎,使用无作用域名称,重新导出 @urcolor/core
@urcolor/core核心颜色逻辑与无障碍工具
@urcolor/shared所有绑定共用的、与框架无关的行为层、WebGL 渲染与网格采样器
@urcolor/vueVue 3 组件与组合式函数
@urcolor/reactReact 组件与 Hooks
@urcolor/svelteSvelte 5 组件与基于 rune 的 hooks
@urcolor/angularAngular 指令与 signal store
@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 类都只有一份。用你喜欢的名称即可:安装框架绑定时 @urcolor/core 已经存在,在一个项目里混用两个名称也是安全的。

可选包

@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