# @axos-web-dev/shared-components 中文文档

规范地址：https://npmcn.com/package/%40axos-web-dev/shared-components/

版本：2\.0\.0-dev\.39
npm 元数据更新时间：2026-11-06T22:00:37.380Z
中文译文更新时间：2026-11-07T20:10:19.517Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40axos-web-dev/shared-components
原文对照：https://npmcn.com/package/%40axos-web-dev/shared-components/?lang=original

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

- 包体积（解压后）：2.8 MB，980 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：32 个
- peer 依赖：zod ^3\.24\.1，next ^14\.1\.4 \|\| ^15\.0\.0 \|\| ^16\.0\.0，react ^18\.2\.0 \|\| ^19\.0\.0，react-dom ^18\.2\.0 \|\| ^19\.0\.0，react-slick ^0\.30\.2，slick-carousel ^1\.8\.1，react-date-range ^2\.0\.1，@vanilla-extract/recipes ^0\.5\.1 \|\| ^0\.5\.5，@vanilla-extract/css-utils ^0\.1\.3 \|\| ^0\.1\.4，@vanilla-extract/vite-plugin ^4\.0\.3 \|\| ^4\.0\.18
- 首次发布：2024-03-01T15:57:21.016Z
- 最新版本发布：2026-11-06T22:00:37.171Z
- 近 30 天下载量：2699（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：800（近 12 个月 354 个）

## 中文简介

Axos 为网络共享组件库.

## 安装

```sh
npm install @axos-web-dev/shared-components
```

也可以使用：`pnpm add @axos-web-dev/shared-components`、`yarn add @axos-web-dev/shared-components`、`bun add @axos-web-dev/shared-components`

## README

# 安装

使用 npm :

```shell
$ npm install @axos-web-dev/shared-components
```

导入组件 在节点.js中:

```js
// Import Components
import {
  AlertBanner,
  CallToActionBar,
  DownloadTile,
  ImageBillboard,
  SecondaryFooter,
} from "@axos-web-dev/shared-components";

// Import Types/Interfaces

import { AlertBannerInterface } from "@axos-web-dev/shared-components/dist/AlertBanner/AlertBanner.interface";
```

在 cs 文件内 :

```css
/*** Import styles ***/

@import "@axos-web-dev/shared-components/dist/assets/AlertBanner/AlertBanner.css";
```

# 共享组件

这个项目是利用 `React + TypeScript + Vite + Storybook + Vanilla-extract` 用于构建内部使用的自定义组件.

## 如何添加新组件

添加新组件时使用 `src/lib` 文件夹,并为组件创建文件夹。 在此之后,您应该注册导出 `src/lib/main.ts` 文档.

您还需要为新组件创建 storie 。 转到 `src/stories` 并创建新文件或文件夹.

```shell
git clone bofaz@vs-ssh.visualstudio.com:v3/bofaz/Axos%20Marketing%20Cloud/Shared%20Components shared-components

cd shared-components

npm install

# for using storybook
npm run storybook

# for build
npm run build

# for testing in other projects
npm run build

npm link

```

为了出版,我们需要 涂抹我们使用的版本 [语义版本](https://semver.org/)

```
Given a version number MAJOR.MINOR.PATCH, increment the:

    MAJOR version when you make incompatible API changes
    MINOR version when you add functionality in a backward compatible manner
    PATCH version when you make backward compatible bug fixes

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
```

我们可以使用以下命令更新版本:

```shell
# bumps the patch number like 0.0.0 -> 0.0.1
npm version patch

# bumps the patch number like 0.0.0 -> 0.1.0
npm version minor

# bumps the patch number like 0.0.0 -> 1.0.0
npm version major



```

## 如何发布 npm 的新库版本

如前所述,第一次更新版本

```shell
npm version [...]
```

然后,您需要登录 npm 来完成此写:

```shell
npm login --scope=@my-org
```

最后您要发布新版本 :

```shell
npm publish
```

## 常见问题

### @axos-web-dev/shared-components 是什么？

Axos 为网络共享组件库\.

### 如何安装 @axos-web-dev/shared-components？

在项目目录运行 npm install @axos-web-dev/shared-components，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^3\.24\.1）、next（^14\.1\.4 \|\| ^15\.0\.0 \|\| ^16\.0\.0）、react（^18\.2\.0 \|\| ^19\.0\.0）、react-dom（^18\.2\.0 \|\| ^19\.0\.0）、react-slick（^0\.30\.2）、slick-carousel（^1\.8\.1）、react-date-range（^2\.0\.1）、@vanilla-extract/recipes（^0\.5\.1 \|\| ^0\.5\.5）、@vanilla-extract/css-utils（^0\.1\.3 \|\| ^0\.1\.4）、@vanilla-extract/vite-plugin（^4\.0\.3 \|\| ^4\.0\.18）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @axos-web-dev/shared-components 支持 TypeScript 吗？

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

### @axos-web-dev/shared-components 支持 ESM 还是 CommonJS？

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

### @axos-web-dev/shared-components 可以商用吗？

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

### @axos-web-dev/shared-components 的下载量有多少？

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

### @axos-web-dev/shared-components 还在维护吗？

最新版本 2\.0\.0-dev\.39 发布于 2026/11/07（今天）；至今共发布 800 个版本，其中过去 12 个月发布了 354 个；首次发布于 2024/03/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。