# @apideck/components 中文文档

规范地址：https://npmcn.com/package/%40apideck/components/

版本：0\.13\.3
npm 元数据更新时间：2026-09-17T09:13:33.712Z
中文译文更新时间：2026-11-06T10:01:01.806Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40apideck/components
原文对照：https://npmcn.com/package/%40apideck/components/?lang=original
项目主页：https://github.com/apideck-io/components#readme
源码仓库：https://github.com/apideck-io/components

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

- 包体积（解压后）：666 kB，42 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=10
- 运行依赖：5 个
- peer 依赖：react \>=16，react-dom \>=16
- 首次发布：2021-03-10T10:03:57.007Z
- 最新版本发布：2025-10-06T12:13:03.940Z
- 近 30 天下载量：18365（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：140（近 12 个月 0 个）

## 中文简介

一个开源的UI组件库,用于高效地开发美丽的React应用程序.

## 安装

```sh
npm install @apideck/components
```

也可以使用：`pnpm add @apideck/components`、`yarn add @apideck/components`、`bun add @apideck/components`

## README

# Apideck 组件库

一个开源的UI组件库,用于高效地开发美丽的React应用程序.

转到 [开发者. apideck.com/ 组件](https://developers.apideck.com/components) 用于完整文件.

## 使用量

安装组件库

```sh
yarn add @apideck/components
```

风格被缩小到 `apideck` 类名所以将其添加到顶级父或正体标记中.

```tsx
import { ModalProvider, ToastProvider } from '@apideck/components'
import { AppProps } from 'next/app'

const App = ({ Component, pageProps }: AppProps) => {
  return (
    <div className="apideck">
      <ModalProvider>
        <ToastProvider>{children}</ToastProvider>
      </ModalProvider>
    </div>
  )
}

export default App
```

使用工程中的组件 :

```js
import { Button } from '@apideck/components'

const App = () => {
  return <Button variant="primary" size="large" text="Yo, world!" />
}

export default App
```

如果你是的话 **没有** 在您的项目中使用 Tailwind CSS, 请确保您的项目包含样式 :

```js
import '@apideck/components/dist/styles.css'
```

组件库的样式使用 [尾风 CSS](https://tailwindcss.com/)如果您要在同样使用 Tailwind CSS 的项目中使用,则您不必包含 `styles.css` 文件,但您应当将软件包路径包含在内容路径中 `tailwind.config.js`。 。 。 .

```js
// tailwind.config.js

module.exports = {
  content: ['./node_modules/@apideck/components/**/*.js'],
  ...
}
```

如果想要覆盖主色调, 您可以将您的自定义颜色添加到 `primary` 尾风配置中的颜色选项 :

```js
// tailwind.config.js

module.exports = {
  content: ['./node_modules/@apideck/components/**/*.js'],
  theme: {
    extend: {
      colors: {
        primary: {
          50:  '#faf6f9',
          100: '#fae7f7',
          200: '#f5c4f3',
          300: '#f39dee',
          400: '#f469e7',
          500: '#f53fe1',
          600: '#e909ef',
          700: '#c81ead',
          800: '#9c1a81',
          900: '#7c1762',
        }
      }
    }
  }
  ...
}
```

### 构成部分

-   [按钮](https://developers.apideck.com/components/button)
-   [纸牌](https://developers.apideck.com/components/card)
-   [检查框](https://developers.apideck.com/components/checkbox)
-   [输入日期](https://developers.apideck.com/components/dateinput)
-   [下坠](https://developers.apideck.com/components/dropdown)
-   [模式](https://developers.apideck.com/components/modal)
-   [选择](https://developers.apideck.com/components/select)
-   [文本区](https://developers.apideck.com/components/textarea)
-   [文本输入](https://developers.apideck.com/components/textinput)
-   [土司](https://developers.apideck.com/components/toast)
-   [切换](https://developers.apideck.com/components/toggle)
-   [工具提示](https://developers.apideck.com/components/tooltip)

### 用户

-   `useModal` 财务报告和审定财务报表 `ModalProvider`
-   `useToast` 财务报告和审定财务报表 `ToastProvider`
-   `useOutsideClick`
-   `usePrevious`
-   `useDebounce`

请参看 [Apideck 文档](https://developers.apideck.com/components) 用于完整文件.

## 常见问题

### @apideck/components 是什么？

一个开源的UI组件库,用于高效地开发美丽的React应用程序\.

### 如何安装 @apideck/components？

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

### @apideck/components 支持 TypeScript 吗？

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

### @apideck/components 支持 ESM 还是 CommonJS？

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

### @apideck/components 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=10。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @apideck/components 可以商用吗？

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

### @apideck/components 的下载量有多少？

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

### @apideck/components 还在维护吗？

最新版本 0\.13\.3 发布于 2025/10/06（1\.1 年前）；至今共发布 140 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/03/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。