# sei-micro-app

**Repository Path**: gapenne/sei-micro-app

## Basic Information

- **Project Name**: sei-micro-app
- **Description**: 基于京东micro-app微前端扩展的组件库
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-23
- **Last Updated**: 2025-10-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# @sei/micro-app

[![NPM version](https://img.shields.io/npm/v/@sei/micro-app.svg?style=flat)](https://npmjs.org/package/@sei/micro-app)
[![NPM downloads](http://img.shields.io/npm/dm/@sei/micro-app.svg?style=flat)](https://npmjs.org/package/@sei/micro-app)

基于 @micro-zoe/micro-app 的 React 微前端工具库，提供开箱即用的组件、Hooks 和工具函数。

## 特性

- 📦 开箱即用的微应用组件
- 🔗 完整的微前端通信机制
- 🛡️ 完善的错误处理和重试机制
- 💪 强大的 TypeScript 类型支持
- 🎨 丰富的自定义配置选项
- 🚀 基于业界成熟方案 @micro-zoe/micro-app
- ✅ 完全透传所有原生 @micro-zoe/micro-app 的属性

## 安装

```bash
npm install @sei/micro-app
# 或
yarn add @sei/micro-app
# 或
pnpm add @sei/micro-app
```

## 快速开始

### 基础用法

```tsx
import { BasicMicroApp } from '@sei/micro-app';

function App() {
  return <BasicMicroApp name="micro-app" url="http://localhost:3000" />;
}
```

### 使用 Hooks

```tsx
import { useMicroApp } from '@sei/micro-app';

function App() {
  const { mountApp, unmountApp } = useMicroApp();

  useEffect(() => {
    mountApp('micro-app', 'http://localhost:3000');
    return () => unmountApp('micro-app');
  }, []);

  return <div>微应用内容</div>;
}
```

### 增强组件

```tsx
import { EnhancedMicroApp } from '@sei/micro-app';

function App() {
  return (
    <EnhancedMicroApp
      name="micro-app"
      url="http://localhost:3000"
      onMounted={(data) => console.log('挂载完成', data)}
      onError={(error) => console.error('发生错误', error)}
      retryTimes={3}
    />
  );
}
```

## 文档

查看完整文档：[文档地址](http://localhost:8000)

- [组件文档](./docs/components.md)
- [Hooks 文档](./docs/hooks.md)
- [工具函数文档](./docs/utils.md)
- [示例](./docs/examples.md)

## 相关链接

- **基础库**: [@micro-zoe/micro-app](https://github.com/jd-opensource/micro-app)
- **基础库文档**: [https://jd-opensource.github.io/micro-app/](https://jd-opensource.github.io/micro-app/)

## Development

```bash
# install dependencies
$ yarn install

# develop library by docs demo
$ yarn start

# build library source code
$ yarn run build

# build library source code in watch mode
$ yarn run build:watch

# build docs
$ yarn run docs:build

# Locally preview the production build.
$ yarn run docs:preview

# check your project for potential problems
$ yarn run doctor
```

## LICENSE

MIT