# @dnanpm/styleguide 中文文档

规范地址：https://npmcn.com/package/%40dnanpm/styleguide/

版本：4\.0\.14
npm 元数据更新时间：2026-11-12T18:55:05.284Z
中文译文更新时间：2026-11-12T13:20:42.175Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40dnanpm/styleguide
原文对照：https://npmcn.com/package/%40dnanpm/styleguide/?lang=original
源码仓库：https://dnae.ghe.com/dna/dna-styleguide

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

- 包体积（解压后）：1.4 MB，812 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：6 个
- peer 依赖：react \>=17\.x \<=19\.x，react-dom \>=17\.x \<=19\.x，@dnanpm/icons ^2\.x，styled-components 6\.x
- 首次发布：2019-09-20T12:00:01.195Z
- 最新版本发布：2026-09-28T08:41:10.513Z
- 近 30 天下载量：3170（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：88（近 12 个月 15 个）

## 中文简介

DNA Styleguide寄存器提供了各种DNA项目中使用的一组组件和主题对象.

## 安装

```sh
npm install @dnanpm/styleguide
```

也可以使用：`pnpm add @dnanpm/styleguide`、`yarn add @dnanpm/styleguide`、`bun add @dnanpm/styleguide`

## README

DNA Styleguide寄存器提供了各种DNA项目中使用的一组组件和主题对象.

## 安装

在应添加DNA样式指南的仓库中运行安装命令

```shell
npm install @dnanpm/styleguide
```

## 文档

> \[注\] 需要访问DNA Cloud URL!

### 交互式文档和API

见最新版本 [DNA 样式指南](https://styleguide.devkube.kauppa5test.acs.dnacloud.fi/latest/) 用于主题文档、 API 和组件的交互式文档.

### 更改日志

见 [更改日志](https://styleguide.devkube.kauppa5test.acs.dnacloud.fi/latest/#/Changelog) 用于当前主要版本修改,或 [Changelog 归档](https://styleguide.devkube.kauppa5test.acs.dnacloud.fi/latest/#/Changelog%20archive) 对于旧的主要版本的修改.

### 移徙指南

见 [移徙指南](https://styleguide.devkube.kauppa5test.acs.dnacloud.fi/latest/#/Migration%20Guide) 用于了解如何在DNA样式指南的主要版本之间迁移的更多信息.

### 贡献指南

见 [贡献指南](https://styleguide.devkube.kauppa5test.acs.dnacloud.fi/latest/#/Contribution%20guide) 关于如何为DNA样式指南做出贡献的更多信息.

## 用法实例

### 主题

```js
import { theme as defaultTheme } from '@dnanpm/styleguide';

const color = {
    ...defaultTheme.color,
    background: '#000000',
};

const iconSize = {
    default: '0.75em',
    defaultMobile: '2em',
};

const theme = {
    ...defaultTheme,
    colors,
    iconSize,
};

export type ThemeInterface = typeof theme;
export default theme;
```

```js
import theme from './theme';

class MyApp {
    public render() {
        const { Component, pageProps } = this.props;

        return (
            <ThemeProvider theme={theme}>
                <Component {...pageProps} />
            </ThemeProvider>
        );
    }
}
```

### 构成部分

```js
import { ButtonPrimary } from '@dnanpm/styleguide';

interface Props {
    myProp?: string;
}

const MyComponent = ({
    myProp,
}: Props) => {
    return (
        <ButtonPrimary>{myProp || 'Lorem Ipsum'}</ButtonPrimary>
    );
};

export default MyComponent;
```

## 常见问题

### @dnanpm/styleguide 是什么？

DNA Styleguide寄存器提供了各种DNA项目中使用的一组组件和主题对象\.

### 如何安装 @dnanpm/styleguide？

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

### @dnanpm/styleguide 支持 TypeScript 吗？

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

### @dnanpm/styleguide 支持 ESM 还是 CommonJS？

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

### @dnanpm/styleguide 需要什么版本的 Node\.js？

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

### @dnanpm/styleguide 可以商用吗？

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

### @dnanpm/styleguide 的下载量有多少？

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

### @dnanpm/styleguide 还在维护吗？

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