@filigran/design-system

中文文档
1.5.1发布于 2026/11/12Apache-2.0TypeScriptESM + CJS近 30 天下载 15.9万

AI-first design system for Filigran products

原始使用文档
文档目录6 节
  1. Install
  2. Usage
  3. Styles
  4. Fonts are not shipped
  5. Documentation contract
  6. License

@filigran/design-system

The Filigran Design System: accessible, token-driven React components shared by OpenCTI, OpenAEV, XTM CRQ, XTM One and XTM Hub.

This README is the package's registry page. Contributor documentation lives in the repository root.

Install

npm install @filigran/design-system

react and react-dom (v19) are peer dependencies and are not bundled.

Usage

import { Button } from "@filigran/design-system";
import "@filigran/design-system/dist/index.css";

export const Example = () => <Button>Save</Button>;

Styles

Import exactly one of the two CSS distributions:

EntryUse it when
@filigran/design-system/dist/index.cssThe host has no Tailwind v4 pipeline. Pre-compiled, ships no preflight, so it will not reset the host's own styles.
@filigran/design-system/tokens/theme.cssThe host compiles Tailwind v4 itself. Exposes the design tokens as an @theme source so host utilities and component styles share one token set.

@filigran/design-system/styles/gradient-helpers.css is an optional add-on for the gradient utilities.

Fonts are not shipped

The typography tokens reference Geologica and IBM Plex Sans. The host application must load both. Without them browsers fall back to system fonts silently: no error, but the typography diverges from the design language.

Documentation contract

@filigran/design-system/meta exposes machine-readable ComponentMeta objects (props, examples, accessibility notes) for tooling and AI agents. It is a separate entry point on purpose: documentation prose is never pulled into the runtime bundle a product ships.

License

Apache-2.0.

版本与发布记录

@filigran/design-system 共发布 7 个版本,首次发布于 2026/08/28;过去 12 个月发布了 7 个版本。

版本发布日期距今
1.5.1latest2026/11/122 天前
1.5.02026/11/113 天前
1.4.02026/11/0411 天前
1.3.02026/10/2124 天前
1.2.02026/10/011 个月前
1.1.02026/09/042 个月前

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

@filigran/design-system 是什么?

AI-first design system for Filigran products

如何安装 @filigran/design-system?

在项目目录运行 npm install @filigran/design-system,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^19.0.0)、react-dom(^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 filigran-design-system,可以用 npx filigran-design-system 直接运行。

@filigran/design-system 支持 TypeScript 吗?

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

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

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

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

@filigran/design-system 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

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

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

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

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