# @0xsquid/ui 中文文档

规范地址：https://npmcn.com/package/%400xsquid/ui/

版本：3\.8\.0
npm 元数据更新时间：2026-10-15T16:35:31.582Z
中文译文更新时间：2026-11-06T23:20:52.509Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%400xsquid/ui
原文对照：https://npmcn.com/package/%400xsquid/ui/?lang=original
项目主页：https://github.com/0xsquid/squid-ui#readme
源码仓库：https://github.com/0xsquid/squid-ui

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：6.7 MB，475 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：11 个
- peer 依赖：react ^16\.0\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0，react-dom ^16\.0\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0
- 首次发布：2024-04-30T19:54:14.440Z
- 最新版本发布：2026-10-15T16:35:31.317Z
- 近 30 天下载量：2181（2026-10-04 至 2026-11-02，npm 官方下载统计）
- 已发布版本数：251（近 12 个月 24 个）

## 中文简介

Squid的UI组件

## 安装

```sh
npm install @0xsquid/ui
```

也可以使用：`pnpm add @0xsquid/ui`、`yarn add @0xsquid/ui`、`bun add @0xsquid/ui`

## README

# 鱿鱼UI

Squid V2 的反应组件库

## 包的安装和使用

安装软件包 :

```bash
yarn add @0xsquid/ui
```

导入输入点中的样式 :

```jsx
// src/main.tsx | src/pages/_app.tsx | etc...
import "@0xsquid/ui/dist/index.css";
```

用我们的主题提供者包起您的应用程序 `<ThemeProvider />` 并指定您的主题 :

```jsx
import { ThemeProvider, Button } from "@0xsquid/ui";

function App() {
  return (
    <ThemeProvider theme={yourTheme}>
      <Button label="Hello world" variant="primary" size="md" />
    </ThemeProvider>
  );
}
```

## 发展

### 安装依赖关系

```bash
yarn install
```

### 启动 Storybook dev 服务器

```bash
yarn storybook
```

### 构建软件包

要使用 Rollup 构建软件包, 请运行 :

```bash
yarn build
```

此命令将 :

1.  将 Tailwind CSS 类编译为 `src/styles/compiled-tailwind.css`
2.  捆绑源代码及其类型声明 `dist/` 文件夹
3.  复制 `src/styles/compiled-tailwind.css` 改为 `dist/index.css`

### 缩写和格式

要格式化并插入代码, 运行 :

```bash
yarn format:fix
```

```bash
yarn lint:fix
```

### 文件夹结构

```
- src
  - index.ts <- barrel file
  - components
    - index.ts <- barrel file
    - buttons
      - index.ts <- barrel file
      - Button.tsx
    - lists
      - index.ts <- barrel file
      - HistoryItem.tsx
  - stories
    - buttons
      - Button.stories.tsx
    - lists
      - HistoryItem.stories.tsx
```

当创建新组件时, 不要忘记更新桶文件, 导出您的组件 `index.ts` 在相应的组件文件夹中存档。 您也可以安装 [自动Barrel VSCode 扩展](https://marketplace.visualstudio.com/items?itemName=imgildev.vscode-auto-barrel)。 。 。 .

### 图像

如果您需要添加到某个需要包含在最后捆绑中的地方, 把它们转换成基数64 .

示例

```diff
.my-image {
-  background-image: url('my-image.png');
+  background-image: url('data:image/png;base64,iVBORw0....');
}
```

或者在反应组件中:

```diff
-  <img src="my-image.png" />
+  <img src="data:image/png;base64,iVBORw0..." />
```

## 常见问题

### @0xsquid/ui 是什么？

Squid的UI组件

### 如何安装 @0xsquid/ui？

在项目目录运行 npm install @0xsquid/ui，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^16\.0\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0）、react-dom（^16\.0\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @0xsquid/ui 支持 TypeScript 吗？

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

### @0xsquid/ui 支持 ESM 还是 CommonJS？

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

### @0xsquid/ui 可以商用吗？

@0xsquid/ui 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @0xsquid/ui 的下载量有多少？

根据 npm 官方下载统计，@0xsquid/ui 在 2026/10/04 – 2026/11/02 这 30 天内被下载 2,181 次，日均约 73 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @0xsquid/ui 还在维护吗？

最新版本 3\.8\.0 发布于 2026/10/16（23 天前）；至今共发布 251 个版本，其中过去 12 个月发布了 24 个；首次发布于 2024/05/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。