官方包 · 实时功能组件

实时光标、头像与编辑锁

建立在 presence 频道上的协作:谁在线、在哪里、实时光标、避免两人同时编辑同一字段的组件锁,以及演示用的跟随模式。

  • 每个成员都有个人资料和所在位置,例如正在看的页面或幻灯片。
  • 光标坐标每秒发送五次,并按原来的节奏回放,移动看起来很流畅。
  • 别人持有的字段,lock() 会失败;成员离开时,其持有的锁会自动释放。

登录后,示例代码会自动填入您的集群主机。 登录

  1. 安装

    npm install @hibira-io/spaces pusher-js
  2. 使用

    import { Space } from '@hibira-io/spaces';
    
    const pusher = new Pusher('YOUR_APP_KEY', {
      cluster: 'hkg',
      wsHost: 'ws.hibira.io',
      channelAuthorization: { endpoint: '/spaces/auth' },
    });
    const space = Space.enter(pusher, 'presence-space-doc-42', { profile: { color: '#e5484d' } });
    space.on('members', ({ members }) => renderAvatars(members));
    space.on('cursor', ({ id, member, x, y }) => drawCursor(id, member, x, y));

开始之前

  • 在应用设置中开启“允许客户端事件”,玩家之间才能互相发送操作和点击。
  • 私有频道和 presence 频道需要后端提供授权端点,用应用密钥签名订阅,做法与 pusher-js 相同。

请使用控制台中应用的 Key;Secret 只放在你的服务器上。频道、事件与授权端点的用法与 Pusher 完全相同。 免费创建账号 →