# @avaya/neo-react 中文文档

规范地址：https://npmcn.com/package/%40avaya/neo-react/

版本：1\.4\.25
npm 元数据更新时间：2026-02-04T12:58:25.534Z
中文译文更新时间：2026-11-07T07:47:35.910Z
软件包许可：SEE LICENSE IN LICENSE\.md

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

原始 npm 页面：https://www.npmjs.com/package/%40avaya/neo-react
原文对照：https://npmcn.com/package/%40avaya/neo-react/?lang=original
项目主页：https://design.avaya.com/docs/setup
源码仓库：https://github.com/avaya-dux/neo-react-library

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

- 包体积（解压后）：3.1 MB，462 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16
- 运行依赖：6 个
- peer 依赖：react 18\.3\.1，downshift 7\.6\.2，react-dom 18\.3\.1，react-table 7\.8\.0，@dnd-kit/core 6\.3\.1，@dnd-kit/sortable 10\.0\.0，@dnd-kit/modifiers 9\.0\.0，@dnd-kit/utilities 3\.2\.2，@tanstack/react-table 8\.21\.2，react-roving-tabindex 3\.2\.0
- 首次发布：2021-11-02T20:36:39.293Z
- 最新版本发布：2025-11-20T18:38:09.414Z
- 近 30 天下载量：2541（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：172（近 12 个月 1 个）

## 中文简介

这是由 Avaya 创建的名为 “ NEO” 共享库的回放版本

## 安装

```sh
npm install @avaya/neo-react
```

也可以使用：`pnpm add @avaya/neo-react`、`yarn add @avaya/neo-react`、`bun add @avaya/neo-react`

## README

[![Netlify Status](https://api.netlify.com/api/v1/badges/825502d6-02db-45a6-88bc-6aed064eb748/deploy-status)](https://app.netlify.com/sites/neo-react-library-storybook/deploys) ![github workflow status](https://github.com/avaya-dux/neo-react-library/actions/workflows/run-yarn.yml/badge.svg) [![npm version](https://badge.fury.io/js/@avaya%2Fneo-react.svg)](https://badge.fury.io/js/@avaya%2Fneo-react) ![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/joe-s-avaya/e90dadd4c95bbcf46094100f6591134e/raw/code-coverage.json)

# Neo React 组件库

> 这是由Avaya 制作的名为"NEO" buit的共享库的回放版本([故事书网站](https://neo-react-library-storybook.netlify.app/)(中文(简体) )

## 安装

```bash
npm i @avaya/neo-react
```

```bash
yarn add @avaya/neo-react
```

```bash
pnpm add @avaya/neo-react
```

## 示例使用

在您的应用程序根部, 导入 CSS 样式 :

```javascript
import "@avaya/neo-react/avaya-neo-react.css";
```

然后,简单地导入您想要使用的组件,看 [文档网站](https://design.avayacloud.com/components/web) 需要更多的实例.

```tsx
import { IconNamesType, NoContent } from "@avaya/neo-react";

export const Example = () => {
  const agentIconName: IconNamesType = "agent";
  return <NoContent icon={agentIconName} text={"Agent has no content"} />;
};
```

注:如果您正在使用 [天体](https://astro.build/)中,将以下内容添加到 `astro.config.mjs` (单位:千美元)[链接到 Astro Docs 上的“为什么”](https://docs.astro.build/en/guides/styling/#import-a-stylesheet-from-an-npm-package):

```javascript
export default defineConfig({
  vite: {
    ssr: {
      noExternal: ["avaya-neo-react"],
    },
  },
});
```

**页:1**:Neo CSS图书馆包含有Neo React图书馆. 如果你安装了 Neo React 库, 你 _别_ 需要从 CSS 库安装或导入.

## 项目建议

### [维特w/ TS](https://vitejs.dev/guide/)

这个团队有经验建设项目(包括应用程序和图书馆) [CRA( 创建- react- app)](https://create-react-app.dev/), (中文(简体) ), [维特](https://vitejs.dev/), (中文(简体) ), [网络软件包](https://webpack.js.org/), (中文(简体) ), [括号](https://parceljs.org/),以及 [滚动](https://www.rollupjs.org/guide/en/)其中,我们建议利用Vite来建立全新的项目。 Vite已经表明自己不仅是一个更快的构建工具,而且由于其出色的文档和智能默认,也成为了更好的DX(Developer eXperience). [见本条](https://blog.logrocket.com/vite-3-vs-create-react-app-comparison-migration-guide/) 关于这些要点的进一步细节.

使用 React+TS 创建 Vite 的示例应用程序 : `pnpm create vite my-react-ts-app --template react-ts`

该团队还与国家防范机制一揽子管理人员建立了经验积累项目, [Yarn (经典)](https://classic.yarnpkg.com/lang/en/docs/install/),以及 [菲律宾](https://pnpm.io/installation)在这三个国家中,我们对Yarn(经典)和PNPM都有良好的经验,并推荐其中任何一个.

## 添加到此库中

如果你愿意为这个项目捐款,你可以从我们开始 [如何进行 dev doc](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/how-to-dev.md)

## 其他读取文件

-   [无障碍准则](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/accessibility-guidelines.md)
-   [编码准则](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/coding-guidelines.md)
-   [如何进行 dev](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/how-to-dev.md)
-   [如何出版](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/how-to-publish.md)
-   [外围技术](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/periphery-tech.md)
-   [pr 最佳做法](https://github.com/avaya-dux/neo-react-library/blob/main/readmes/pr-best-practices.md)

## 许可证

版权所有 2020-2024 Avaya Inc. 所有权利保留.

## 常见问题

### @avaya/neo-react 是什么？

这是由 Avaya 创建的名为 “ NEO” 共享库的回放版本

### 如何安装 @avaya/neo-react？

在项目目录运行 npm install @avaya/neo-react，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（18\.3\.1）、downshift（7\.6\.2）、react-dom（18\.3\.1）、react-table（7\.8\.0）、@dnd-kit/core（6\.3\.1）、@dnd-kit/sortable（10\.0\.0）、@dnd-kit/modifiers（9\.0\.0）、@dnd-kit/utilities（3\.2\.2）、@tanstack/react-table（8\.21\.2）、react-roving-tabindex（3\.2\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @avaya/neo-react 支持 TypeScript 吗？

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

### @avaya/neo-react 支持 ESM 还是 CommonJS？

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

### @avaya/neo-react 需要什么版本的 Node\.js？

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

### @avaya/neo-react 可以商用吗？

@avaya/neo-react 使用 SEE LICENSE IN LICENSE\.md 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @avaya/neo-react 的下载量有多少？

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

### @avaya/neo-react 还在维护吗？

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

