官方套件 · 框架

Craft CMS 的編輯中提示與即時條目

Craft CMS 5 外掛:編輯者能看到還有誰開著同一個條目,有人儲存時會收到重新載入提示;條目變更時頁面會自己更新;Craft Commerce 的訂單頁會即時跟上狀態變化。

  • 控制台的條目頁會顯示所有開著同一條目的人,其中一人儲存的當下,其他人會收到提醒。
  • 儲存已上線的條目時,會在 craft-entry-{id} 送出 entry-updated,並在 craft-section-{handle} 送出 entry-saved,模板不必輪詢就能更新。
  • Craft Commerce:顧客能即時看到訂單狀態,控制台在新訂單進來時立刻顯示。
  • craft.hibira.trigger() 可從模板送出自己的事件,actions/hibira/auth 負責簽署私人與 presence 頻道。
兩位編輯打開同一篇 Craft 條目:控制台顯示還有誰在編輯,條目一儲存就會通知另一位編輯。
兩位編輯打開同一篇 Craft 條目:控制台顯示還有誰在編輯,條目一儲存就會通知另一位編輯。

登入後,範例程式碼會自動帶入您的叢集主機。 登入

  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' }) %}

開始之前

  • 應用程式的密鑰只會在建立應用程式或輪替密鑰時顯示一次。請只放在伺服器上,不要放進瀏覽器或遊戲的建置檔。
  • 把網站的網址加到 app 的允許來源;控制台網址不同的話也一併加入。

請使用儀表板中的應用程式 Key;Secret 只放在你的伺服器上。頻道、事件與授權端點的用法和 Pusher 完全相同。 免費建立帳號 →