# EventRatel

**Repository Path**: ankeji/event-ratel

## Basic Information

- **Project Name**: EventRatel
- **Description**: 一个微前端使用的postmessage消息透传库
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-10-25
- **Last Updated**: 2024-11-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# EventRatel

#### 介绍
一个微前端使用的postmessage消息透传库

#### 软件架构
软件架构说明


#### 安装教程

1.  在 Node.js 中使用 require

    ```
    const EventRatel = require('./EventRatel');
    const eventRatel = EventRatel.getInstance();
    ```

2.  在 ES6 模块中使用 import

    ```
    import EventRatel from './EventRatel';
    const eventRatel = EventRatel.getInstance();
    ```
3.  在 HTML 页面中使用 ``<script>``标签

    ```
    <script src="EventRatel.js"></script>
    <script>
        const eventRatel = EventRatel.getInstance();
        eventRatel.on('someEvent', (data) => {
            console.log('Received:', data);
        });
        eventRatel.emit('someEvent', { message: 'Hello, World!' });
    </script>
    ```

#### 使用说明

1.  发送透传消息
    ```
    eventRatel.emit('someEvent', data)
    eventRatel.emit('someEvent', data, 'iframeId') //指定iframe监听
    eventRatel.emitParent('someEvent', data) // 只给父级窗口发送消息
    eventRatel.on('someEvent', (data) => {
        console.log('Received:', data);
    })
    eventRatel.off('someEvent')

    ```
    这里的`off`事件，需要把`on`监听的方法单独抽离出来，跟`vue`的`bus`监听是一样的用法，例如：
    ```
    created() {
        eventRatel.on("someEvent", this.handleMessage);
    },
    methods: {
        handleMessage(data) {
            console.log(data);
        },
    },
    beforeDestroy() {
        eventRatel.off("someEvent", this.handleMessage);
    },
    ```

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)