# 标签通讯

**Repository Path**: MacXiang/tab-communication

## Basic Information

- **Project Name**: 标签通讯
- **Description**: 标签页间互相通讯
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-26
- **Last Updated**: 2025-10-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 标签通讯

#### 介绍
标签页间互相通讯

#### 软件架构
无


#### 安装教程

1.  npm i @mac-xiang/tab-communication

#### 使用说明

1.  import { TabCommunicationClient, TabCommunicationService } from '@mac-xiang/tab-communication';
2.  const svr=TabCommunicationService({url:"http://xxx"})
3.  const client=TabCommunicationClient((data)=>{console.log(data); return data})

#### 参与贡献

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


#### 参数说明

    TabCommunicationServiceOptions; 
        handler为 window.open() 所返回的句柄或者iframe；
        url:为将要打开的标签页url
        handler与url参数二选一
        timeout:超时时间;主要是指通过TabCommunicationService({url:"http://xxx"})新建标签页的超时返回时间；默认5秒
        event 为回调函数；当超时、连接成功时、有客户端发送过来消息时，会触发；
    TabCommunicationClientOptions；
        是一个回调函数，当有服务端发送过来消息时，会触发；