# @deskpro/deskpro-ui 中文文档

规范地址：https://npmcn.com/package/%40deskpro/deskpro-ui/

版本：10\.0\.3
npm 元数据更新时间：2026-10-27T09:39:05.922Z
中文译文更新时间：2026-11-12T01:24:02.057Z
软件包许可：BSD-3-Clause

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

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

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

- 包体积（解压后）：10.2 MB，919 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 20\.16\.0
- 运行依赖：17 个
- peer 依赖：react ^18 \|\| ^19，react-dom ^18 \|\| ^19，styled-components ^5 \|\| ^6，@typescript/lib-dom npm:@types/web
- 首次发布：2022-02-01T17:02:06.299Z
- 最新版本发布：2026-10-27T09:39:05.263Z
- 近 30 天下载量：5253（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：176（近 12 个月 17 个）

## 中文简介

Deskpro UI 组件

## 安装

```sh
npm install @deskpro/deskpro-ui
```

也可以使用：`pnpm add @deskpro/deskpro-ui`、`yarn add @deskpro/deskpro-ui`、`bun add @deskpro/deskpro-ui`

## README

# `@deskpro/deskpro-ui`

Deskpro UI 组件库

## 文档

-   [故事书](https://deskpro.github.io/deskpro-ui/storybook/?path=/story/component-gallery-1--component-gallery-1)
-   [类型doc](https://deskpro.github.io/deskpro-ui/typedoc)

## 使用量

支持反应 18 和 19 (`react` 编号 : `react-dom` `^18 || ^19`5和6部分 (单位:千美元)`^5 || ^6`. TypeScript消费者需要TypeScript 4.7或更晚.

```shell
# Add deskpro-ui and peer deps
pnpm add @deskpro/deskpro-ui react react-dom styled-components

# Add types
pnpm add -D @typescript/lib-dom@npm:@types/web
# styled-components 5 only (v6 ships its own types)
pnpm add -D @types/styled-components
```

```tsx
// Optional CSS - depending which components are used from dp-ui and whether you have your own reset css
// Either download and save to an assets dir or install modern-normalize and simplebar-react as direct dependencies and reference directly from node modules
import "modern-normalize/modern-normalize.css";
import "simplebar-react/dist/simplebar.min.css";

// Required CSS
import "@deskpro/deskpro-ui/dist/deskpro-ui.css";
import "@deskpro/deskpro-ui/dist/deskpro-custom-icons.css";

import React from "react";

import { Stack, Button, lightTheme } from "@deskpro/deskpro-ui";
import { ThemeProvider } from "styled-components";

export function App() {
  return (
    <ThemeProvider theme={lightTheme}>
      <Stack>
        <Button text="hi" />
      </Stack>
    </ThemeProvider>
  );
}
```

键入 `theme` 在您自己的样式组件中, 增强样式组件' `DefaultTheme`数字 :

```ts
import type { DeskproTheme } from "@deskpro/deskpro-ui";

declare module "styled-components" {
  export interface DefaultTheme extends DeskproTheme {}
}
```

### 型号道具是瞬态的(`$`(中文(简体) )

只样式组件而非 HTML 属性的道具是 `$`\- 前缀 [瞬间道具](https://styled-components.com/docs/api#transient-props),比如说. `<Stack $gap={4} $vertical $align="center">` 财务报告和审定财务报表 `<TSpan type="p_p1" $themeColor="grey100">`。 。 。 . 样式组件从不写 `$` 给DOM的道具,所以桌上的PRO -UI不需要 `StyleSheetManager` 或者说 其他设置在样式的组件 5 或 6 上.

## 常见问题

### @deskpro/deskpro-ui 是什么？

Deskpro UI 组件

### 如何安装 @deskpro/deskpro-ui？

在项目目录运行 npm install @deskpro/deskpro-ui，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18 \|\| ^19）、react-dom（^18 \|\| ^19）、styled-components（^5 \|\| ^6）、@typescript/lib-dom（npm:@types/web）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @deskpro/deskpro-ui 支持 TypeScript 吗？

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

### @deskpro/deskpro-ui 支持 ESM 还是 CommonJS？

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

### @deskpro/deskpro-ui 需要什么版本的 Node\.js？

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

### @deskpro/deskpro-ui 可以商用吗？

@deskpro/deskpro-ui 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### @deskpro/deskpro-ui 的下载量有多少？

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

### @deskpro/deskpro-ui 还在维护吗？

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