# @oods/component-contracts 中文文档

规范地址：https://npmcn.com/package/%40oods/component-contracts/

版本：0\.11\.3
npm 元数据更新时间：2026-11-02T02:10:05.483Z
中文译文更新时间：2026-11-02T02:17:19.781Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40oods/component-contracts
原文对照：https://npmcn.com/package/%40oods/component-contracts/?lang=original
项目主页：https://oods-foundry.com/
源码仓库：https://github.com/kneelinghorse/OODS-Foundry

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

- 包体积（解压后）：3.8 MB，20 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：0 个
- 首次发布：2026-09-26T12:20:30.384Z
- 最新版本发布：2026-11-02T02:10:05.231Z
- 已发布版本数：25（近 12 个月 25 个）

## 中文简介

OODS Foundry的组件契约：每个组件的标识、道具、事件、状态、令牌角色和可访问性义务，以及共享的格式化助手。

## 安装

```sh
npm install @oods/component-contracts
```

也可以使用：`pnpm add @oods/component-contracts`、`yarn add @oods/component-contracts`、`bun add @oods/component-contracts`

## README

# @oods /构件

用于OODS的独立于框架的组件契约和共享格式化帮助程序。契约列出了组件的标识、道具、插槽、事件、状态、令牌角色和可访问性义务。该包包含数据和帮助程序；它不呈现UI。

## 安装

```sh
npm install @oods/component-contracts
```

## 第一个结果

在ES模块中运行：

```js
import { componentContracts } from '@oods/component-contracts';
console.log(componentContracts.Button.id); // Button
console.log(componentContracts.Button.events);
console.log(componentContracts.Button.accessibility);
```

在编写组件适配器时使用契约。这个 `componentCapabilityBaseline` 出口和 `@oods/component-contracts/registry/capabilities` 包含保留的能力分类账。其证据范围限于记录的组成部分情景；声明的义务并不是任意实现满足义务的证据。

OODS铸造厂的映射组件报告区分满足、未满足和未检查的义务。在使用报告作为证据之前，先阅读他们的理由和来源身份。该包不认证应用程序、第三方库或每个可能的组件状态。

## 限制

生成的应用锁定生成它们的OODS版本；要升级，请重新生成应用程序或将所有四个引脚移到一起。这些包与本地MCP服务器是分开的， `@oods/foundry`.

## 许可证

Apache License 2.0。看到 [许可证](https://cdn.jsdelivr.net/npm/@oods/component-contracts@0.11.3/LICENSE) 和 [请注意](https://cdn.jsdelivr.net/npm/@oods/component-contracts@0.11.3/NOTICE)． 生成的输出属于其用户；已安装的包依赖项保留其自己的许可证。

## 常见问题

### @oods/component-contracts 是什么？

OODS Foundry的组件契约：每个组件的标识、道具、事件、状态、令牌角色和可访问性义务，以及共享的格式化助手。

### 如何安装 @oods/component-contracts？

在项目目录运行 npm install @oods/component-contracts，或使用 pnpm add / yarn add / bun add。

### @oods/component-contracts 支持 TypeScript 吗？

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

### @oods/component-contracts 支持 ESM 还是 CommonJS？

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

### @oods/component-contracts 需要什么版本的 Node\.js？

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

### @oods/component-contracts 可以商用吗？

@oods/component-contracts 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @oods/component-contracts 还在维护吗？

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

