官方包 · 框架

Craft CMS 的编辑中提示与实时条目

Craft CMS 5 插件：编辑者能看到还有谁打开着同一个条目，有人保存时会收到重新加载提示；条目变更时页面会自动更新；Craft Commerce 的订单页会实时跟进状态变化。

hibira-io/craft-hibiraPackagist ↗GitHub ↗

• 控制台的条目页会显示所有打开同一条目的人，其中一人保存的瞬间，其他人会收到提醒。
• 保存已上线的条目时，会在 craft-entry-{id} 发送 entry-updated，并在 craft-section-{handle} 发送 entry-saved，模板无需轮询即可更新。
• Craft Commerce：顾客能实时看到订单状态，控制台在新订单进来时立即显示。
• craft.hibira.trigger() 可从模板发送自己的事件，actions/hibira/auth 负责签名私有和 presence 频道。

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

1. 安装

   composer require hibira-io/craft-hibira
   php craft plugin/install hibira

2. 配置

   # .env (Settings → Plugins → Hibira Realtime reads these by default)
   HIBIRA_APP_ID=YOUR_APP_ID
   HIBIRA_APP_KEY=YOUR_APP_KEY
   HIBIRA_APP_SECRET=YOUR_APP_SECRET
   # and set Host to ws.hibira.io in the plugin settings

3. 使用

   {% do craft.hibira.registerScript() %}
   
   {# Readers get a "This page was updated" notice with a Reload button #}
   <article data-hibira-entry="{{ entry.id }}">
     {{ entry.body }}
   </article>
   
   {# Send your own events #}
   {% do craft.hibira.trigger('scores', 'goal', { team: 'home' }) %}

开始之前

• 应用密钥只会在创建应用或轮换密钥时显示一次。请只放在服务器上，不要放进浏览器或游戏的构建包。
• 把网站地址加入应用的允许来源；控制台地址不同的话也一并加入。

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