# @tap-payments/os-micro-frontend-shared 中文文档

规范地址：https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/

版本：0\.3\.265
npm 元数据更新时间：2026-11-02T14:53:22.372Z
中文译文更新时间：2026-11-02T15:36:41.683Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40tap-payments/os-micro-frontend-shared
原文对照：https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/?lang=original

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

- 包体积（解压后）：3.5 MB，1437 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：26 个
- peer 依赖：react ^18，i18next ^22，react-dom ^18，@mui/material ^5，framer-motion ^10，react-i18next ^12，@emotion/react ^11，@emotion/styled ^11，react-router-dom ^7\.7\.0
- 首次发布：2025-05-20T21:16:07.328Z
- 最新版本发布：2026-11-02T14:53:22.192Z
- 已发布版本数：2672（近 12 个月 1383 个）

## 中文简介

Tap Payments微前端的共享组件和实用程序

## 安装

```sh
npm install @tap-payments/os-micro-frontend-shared
```

也可以使用：`pnpm add @tap-payments/os-micro-frontend-shared`、`yarn add @tap-payments/os-micro-frontend-shared`、`bun add @tap-payments/os-micro-frontend-shared`

## README

# os-micro-frontend-shared

> 用于Tap Payments微前端的共享React组件库

[![npm version](https://img.shields.io/npm/v/@tap-payments/os-micro-frontend-shared)](https://www.npmjs.com/package/@tap-payments/os-micro-frontend-shared) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/LICENSE)

## 这是什么？

一个全面的React组件库提供：

-   **100+ UI组件** （按钮、表格、对话框、表单、过滤器）
-   **18个定制钩子** （烤面包，窗口尺寸，主题模式）
-   **47个实用模块** （日期/货币格式，验证）
-   **完整的TypeScript支持** 使用类型定义
-   **MUI-based主题** 具有暗/亮模式和RTL/LTR支持
-   **高性能虚拟表** 对于大型数据集

## 快速入门

```bash
npm install @tap-payments/os-micro-frontend-shared
# or
yarn add @tap-payments/os-micro-frontend-shared
```

```typescript
import { Button, VirtualTable, useToast } from '@tap-payments/os-micro-frontend-shared'

function MyApp() {
  const toast = useToast()

  return (
    <Button variant="primary" onClick={() => toast.success('Hello!')}>
      Click me
    </Button>
  )
}
```

## 文档

📚 **[完整文档→](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/README.md)**

| 文档 | 描述 | 阅读时间 |
| --- | --- | --- |
| **[概述](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/01-overview.md)** | 功能、包规格、特性 | 15分钟 |
| **[设置和堆栈](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/02-setup.md)** | 安装、命令、工作流 | 10分钟 |
| **[体系结构](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/03-architecture.md)** | 布局，导出，模块边界 | 15分钟 |
| **[组件指南](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/04-component-guide.md)** | 用示例对所有组件进行分类 | 参考 |
| **[组件开发](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/05-component-development.md)** | 构建新组件 | 20分钟 |

**为开发人员**按顺序阅读： [概述](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/01-overview.md) → [设置](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/02-setup.md) → [组件指南](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/04-component-guide.md).

## 关键特性

-   ✅ **ESM-only** -现代模块系统与树摇
-   ✅ **同行依赖性** —避免版本冲突
-   ✅ **完整的打印稿** -完全型安全
-   ✅ **100 +组件** -全面的UI库
-   ✅ **虚拟表** -高性能列表
-   ✅ **React Hook表单** -集成表单组件
-   ✅ **主题** -暗/亮模式，RTL/LTR
-   ✅ **memoize的** -优化性能

## 开发

```bash
# Install dependencies
yarn install

# Start dev server
yarn dev

# Build library
yarn build

# Test locally in another project
yarn push:local   # requires yalc
```

看到 [安装指南](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/02-setup.md) 详细说明。

## 出版

### 自动化(推荐)

将PR合并到 `main` 自动:

1.  补丁版本
2.  提交版本变更
3.  构建图书馆
4.  向npm发布

版本提交使用该格式 `chore(release): vX.Y.Z`.

查找已发布版本的提交：

```bash
git log --oneline --grep="release: vX.Y.Z"
```

### 手册

```bash
# Test version (with -test tag)
yarn push:test

# Production
yarn push
```

看到 [出版](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/02-setup.md#publishing) 获取详细信息。

## 贡献

1.  创建特性分支
2.  进行更改 `src/`
3.  运行 `yarn lint:fix` 和 `yarn prettier:fix`
4.  提交（预提交钩子将运行）
5.  推动和创建公关 `main`

看到 [开发](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/02-setup.md#development) 详细指南。

## 项目结构

```
src/
├── components/      # 100+ React components
├── hooks/          # 18 custom React hooks
├── utils/          # 47 utility modules
├── types/          # TypeScript type definitions
├── constants/      # App constants and configs
└── theme/          # MUI theme configuration
```

看到 [文件夹/模块结构](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/03-architecture.md#folder--module-structure) 获取详细信息。

## 技术堆栈

-   React 18 + TypeScript 5
-   MUI（材质- ui） 5 +情感
-   React Hook Form +是的
-   Vite 6（构建+开发）
-   ESLint + Prettier

看到 [技术堆栈](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/01-overview.md#tech-stack) 查看完整的列表。

## 许可证

麻省理工学院© [利用支付](https://tap.company/)

* * *

## 链接

-   [npm包](https://www.npmjs.com/package/@tap-payments/os-micro-frontend-shared)
-   [文档](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/)
-   [利用支付](https://tap.company/)

## 支持

有关问题、问题或贡献，请参阅 [文档](https://npmcn.com/package/%40tap-payments/os-micro-frontend-shared/docs/) 或者制造一个问题。

## 常见问题

### @tap-payments/os-micro-frontend-shared 是什么？

Tap Payments微前端的共享组件和实用程序

### 如何安装 @tap-payments/os-micro-frontend-shared？

在项目目录运行 npm install @tap-payments/os-micro-frontend-shared，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18）、i18next（^22）、react-dom（^18）、@mui/material（^5）、framer-motion（^10）、react-i18next（^12）、@emotion/react（^11）、@emotion/styled（^11）、react-router-dom（^7\.7\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @tap-payments/os-micro-frontend-shared 支持 TypeScript 吗？

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

### @tap-payments/os-micro-frontend-shared 支持 ESM 还是 CommonJS？

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

### @tap-payments/os-micro-frontend-shared 可以商用吗？

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

### @tap-payments/os-micro-frontend-shared 还在维护吗？

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