@gnist/component-utils

中文文档
3.0.19发布于 2026/11/16TypeScriptES Module近 30 天下载 3690

@gnist/component-utils currently contains a single utility function for easily creating React components from css classes (e.g. created with style(...) from @vanilla-extract/css) or recipes c

原始使用文档
文档目录4 节
  1. Overview
  2. Using a className string
  3. Using a recipe function
  4. Use with other React components

Component utilities for @gnist/design-system

@gnist/component-utils currently contains a single utility function for easily creating React components from css classes (e.g. created with style(...) from @vanilla-extract/css) or recipes created with @vanilla-extract/recipes.

Overview

The function component has two overloads, for use with either a className string or a recipe function.

Using a className string

// Heading.css.ts
import { atoms } from "@gnist/themes/atoms.css.js";
import { style } from "@vanilla-extract/css";

export const heading = style([
    { float: "left" },
    atoms({ margin: "none", typography: "subtitle-small" }),
]);
// Heading.tsx
import { component } from "@gnist/component-utils";
import { bannerHeading } from "./Heading.css.js";

export const Heading = component("Heading", heading, "h2");
//                                   │         │       │
// The display name of the component ┘         │       │
// The className to use for the element ───────┘       │
// The default HTML element or React component to use ─┘

// ...later...

<Heading $as="h4" href="#anchor">
    Now this is a h4
</Heading>;

Using a recipe function

// Box.css.ts
import { recipe } from "@vanilla-extract/recipes";
import { atoms } from "@gnist/themes/atoms.css.js";

export const box = recipe({
    base: atoms({ display: "flex" }),
    variants: {
        density: {
            default: atoms({ padding: "s" }),
            compact: atoms({ padding: "xxs" }),
        },
    },
    defaultVariants: { density: "default" },
});
// Box.tsx
import { component } from "@gnist/component-utils";
import { box } from "./Box.css.js";

export const Box = component("Box", box, "div");
//                             │     │     │
// The display name ───────────┘     │     │
// The recipe function  ─────────────┘     │
// The default element or component ───────┘

// ...later...

<Box $as="span" density="compact">
    Now the box has xxs padding and is a span
</Box>;

Use with other React components

Note that component can be used with any React component that has a className prop, not just HTML elements.

版本与发布记录

@gnist/component-utils 共发布 30 个版本,首次发布于 2024/03/26;过去 12 个月发布了 9 个版本。

版本发布日期距今
3.0.19latest2026/11/16今天
3.0.182026/11/0610 天前
3.0.172026/10/161 个月前
3.0.162026/08/242 个月前
3.0.152026/06/035 个月前
3.0.142026/04/176 个月前

关于 @gnist/component-utils 的常见问题

@gnist/component-utils 是什么?

@gnist/component-utils currently contains a single utility function for easily creating React components from css classes (e.g. created with style(...) from @vanilla-extract/css) or recipes c

如何安装 @gnist/component-utils?

在项目目录运行 npm install @gnist/component-utils,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gnist/component-utils 支持 TypeScript 吗?

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

@gnist/component-utils 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@gnist/component-utils 可以商用吗?

@gnist/component-utils 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@gnist/component-utils 的下载量有多少?

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

@gnist/component-utils 还在维护吗?

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