@caratlogic/design-system

中文文档
0.1.51发布于 2026/11/07ISCTypeScriptESM + CJS近 30 天下载 3659

Carat Logic Design System

原始使用文档
文档目录6 节
  1. Install
  2. Tailwind CSS setup (required for production builds)
  3. Do not rely on runtime CSS injection
  4. Usage
  5. Package exports
  6. Development

@caratlogic/design-system

Carat Logic shared React component library (Tailwind CSS v4 + shadcn/ui).

Install

npm install @caratlogic/design-system

Peer dependencies: react, react-dom, react-router-dom.

Tailwind CSS setup (required for production builds)

Components use Tailwind utility classes. Dev may look fine without this, but production builds will drop most DS styles unless you register the package as a Tailwind content source.

In your app's main CSS file (e.g. src/index.css), after @import "tailwindcss":

@import "tailwindcss";
@import "@caratlogic/design-system/source.css";

source.css tells Tailwind to scan the published JS bundles for class names. Without it, buttons, sidebar, tables, and other DS components render unstyled in production.

Your app must also define the theme tokens (:root / @theme variables). Copy from src/styles/index.css in this repo or keep your existing app theme if already aligned.

Do not rely on runtime CSS injection

Older builds injected a partial Tailwind stylesheet into the JS bundle via styleInject. That is removed as of v0.0.2 — the host app is the single source of compiled utilities.

Usage

import { Button, Sidebar, SidebarProvider } from '@caratlogic/design-system';
import { Input } from '@caratlogic/design-system/ui';

Package exports

ImportDescription
@caratlogic/design-systemAtoms, molecules, organisms, layouts
@caratlogic/design-system/uiRaw shadcn/ui primitives
@caratlogic/design-system/source.cssTailwind @source directives for host apps

Development

yarn install
yarn build
yarn test

版本与发布记录

@caratlogic/design-system 共发布 58 个版本,首次发布于 2026/06/18;过去 12 个月发布了 58 个版本。

版本发布日期距今
0.1.51latest2026/11/072 天前
0.1.502026/11/063 天前
0.1.492026/10/2910 天前
0.1.482026/10/2911 天前
0.1.472026/10/2812 天前
0.1.462026/10/2712 天前

其他发布通道:beta → 0.0.2。

关于 @caratlogic/design-system 的常见问题

@caratlogic/design-system 是什么?

Carat Logic Design System

如何安装 @caratlogic/design-system?

在项目目录运行 npm install @caratlogic/design-system,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(>=18.0.0)、sonner(>=2.0.0)、react-dom(>=18.0.0)、react-router-dom(>=6.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@caratlogic/design-system 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@caratlogic/design-system 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@caratlogic/design-system 可以商用吗?

@caratlogic/design-system 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@caratlogic/design-system 的下载量有多少?

根据 npm 官方下载统计,@caratlogic/design-system 在 2026/10/09 – 2026/11/07 这 30 天内被下载 3,659 次,日均约 122 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@caratlogic/design-system 还在维护吗?

最新版本 0.1.51 发布于 2026/11/07(2 天前);至今共发布 58 个版本,其中过去 12 个月发布了 58 个;首次发布于 2026/06/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。