コンテンツへスキップ

キャンバス

キャンバスには、Blockstudioで管理されるすべてのページを俯瞰できる、Figmaのような表示が用意されています。各ページは、横一列に並ぶライブiframeのアートボードとして表示されます。トラックパッドでパンし、ピンチ操作またはCtrl+スクロールでズームします。

有効化

キャンバスは非表示の管理ページとして利用できます。次に移動してください。

コード
/wp-admin/admin.php?page=blockstudio-canvas

ページは、dev.canvas.enabledがtrueであり、現在のユーザーにedit_posts権限がある場合にのみアクセスできます。

設定

テーマのblockstudio.jsonでキャンバスを有効化し、動作を設定します。

JSON
{
  "dev": {
    "canvas": {
      "enabled": true,
      "adminBar": false
    }
  }
}
プロパティ 型 デフォルト 説明
enabled boolean false キャンバス機能を有効にします。
adminBar boolean true アートボードのiframe内にWordPress管理バーを表示します。プレビューをすっきりさせるにはfalseに設定します。

どちらの設定もフィルターとして利用できます。

PHP
add_filter('blockstudio/settings/dev/canvas/enabled', '__return_true');
add_filter('blockstudio/settings/dev/canvas/admin_bar', '__return_false');

ビュー

右上のドロップダウンメニューでビューを切り替えます。

  • ページ: Blockstudioが管理するすべてのページを、1列に並ぶ全幅のアートボードとして表示します。
  • ブロック: 登録済みのBlockstudioブロックをすべてグリッド表示し、それぞれをデフォルト属性値でレンダリングします。

公開インベントリとドキュメントAPI

Canvasは、Blockstudioの検出やレンダリングのロジックを作り直さずに、同じ登録済みコンテンツを必要とするツール向けに、バージョン管理された、利用側に依存しないPHP契約を公開します。

PHP
use Blockstudio\Canvas;

$all = Canvas::inventory();

$changed = Canvas::inventory([
  'blocks' => ['theme/hero'],
  'pages' => ['about'],
]);

$documents = Canvas::documents([
  'patterns' => ['theme/featured'],
  'templates' => ['front-page'],
]);

現在のバージョンはCanvas::SCHEMA_VERSIONとして利用できます。インベントリの結果には次の情報が含まれます。

  • inventory: 正規化されたpages、blocks、patterns、templates、partsと、公開uiファミリーの例
  • order: 型をまたいだ安定した表示順
  • sources: 選択された正確なソースパスと各レコードの由来情報。ページレコードのsourceは安定したソース識別子で、pathは実際のレンダリングテンプレートのパス
  • warningsとerrors: 出力ではなく構造化された問題
  • deleted: 現在は存在しない要求済み識別子
  • selection: 正規化された選択内容と、対象が指定されていたかどうか

Canvas::documents()は、選択したレコードごとに完全なレンダリングドキュメントを1つ追加します。各ドキュメントには、本文、組み立て済みのHTML、依存関係を含むブロック名、正確なCSS、JavaScript、モジュール、インタラクティビティのブートストラップ、バンドルされたUIグローバル、Tailwindの出力が含まれます。ページドキュメントでは、意味に即した<main>コンテンツラッパーを使用します。呼び出し側は、共通のRenderドキュメントオプションでこれを上書きまたは無効にできます。選択した各ページは、復元されたフロントエンドのWordPressコンテキストで個別にレンダリングされます。そのため、クエリ条件、bodyクラスフィルター、ショートコード、レイアウト、リダイレクト、wp_enqueue_scriptsコールバックには、Canvasの結果を要求した管理画面やRESTリクエストではなく、そのページのコンテキストが反映されます。呼び出し側が指定したbodyクラスは、ページのコンテキストクラスと統合され、フロントエンドのenqueueレジストリはドキュメントごとに分離されます。Canvasはライフサイクルのコールバックを公開WordPress関数名で解決するため、BlockstudioがComposer経由で読み込まれる場合や、アプリケーションの名前空間が移動されている場合も、同じコンテキストが維持されます。

選択の厳密な仕様

選択は厳密に処理されます。

  • 認識可能な型キーがない場合、すべての型を読み込みます。
  • true、null、または"*"の場合、その型のすべてのレコードを読み込みます。
  • 文字列またはリストを指定すると、一致するID、名前、スラッグ、パス、ソースパスだけを読み込みます。
  • 空の文字列またはリスト、あるいはfalseの場合、その型のレコードは読み込みません。
  • 型キーを1つでも指定すると、省略された型は検出、同期、レンダリング、コンパイルされません。

この仕様により、大規模なプロジェクトでも変更分だけを対象にしたリクエストを安全に実行できます。既存のブロックとページは、正規のレジストリから解決されます。フロントエンドのリクエストで永続化されたページの投影データだけが読み込まれている場合、Canvasは読み取り専用のソース検出を行い、コンテンツを同期せずに一致する投稿IDとパーマリンクを統合します。論理的な検出元が先にソースベースのレジストリを作成する場合にも同じ識別情報の統合が適用されるため、コンテキストに応じたページレンダリングには、一致する管理対象のWordPress投稿が引き続き使用されます。新しいライブセッションの構成は変更されたディレクトリ周辺のみ検出され、選択されたパターンとSite Editorのテンプレートソースは、選択後にのみコンパイルされます。

REST更新エンドポイントも、既存のblocksおよびpagesクエリパラメーターに同じルールを適用します。たとえば、?blocks=theme/heroはそのブロックだけを返し、ページは返しません。混在した結果を取得するには、両方のパラメーターを使用します。どちらのパラメーターも指定せずにエンドポイントを呼び出すと、従来どおり全件を返します。

ライブモード

ライブモードではServer-Sent Events (SSE)を使ってファイルの変更を検出し、キャンバスをリアルタイムで更新します。ブロックテンプレート、ページテンプレート、スタイルシートを編集すると、影響を受けるアートボードが約1秒以内に自動更新されます。

ドロップダウンメニューからライブモードを切り替えます。有効時は緑色のインジケーターが点滅します。この設定はlocalStorageに保存され、セッションをまたいで保持されます。

ライブモードは、ブロックとページのディレクトリ内にある.php、.json、.css、.scss、.js、.twig、.htmlファイルの変更を追跡します。既知の編集では、登録済みの該当ブロックまたはページだけを更新します。新しいブロックやページが追加された場合は、ディレクトリ単位で構成を1回検出するため、ライブセッション中にコンテンツを作成しても、無関係なソースを再スキャンせずに反映されます。

フォーカスモード

アートボードのラベルをクリックすると、フォーカスモードになります。選択したアートボードがビューポートいっぱいに全幅で表示され、縦方向にスクロールできます。Escapeキーを押すか閉じるボタンをクリックすると、概要に戻ります。

操作

操作 入力
パン スクロール / トラックパッドで2本指ドラッグ
ズーム Ctrl+スクロールまたはピンチ
表示範囲に合わせる ドロップダウンメニュー
100%にズーム ドロップダウンメニュー
アートボードにフォーカス アートボードのラベルをクリック
フォーカスを終了 Escape / 閉じるボタン

セキュリティ

すべての条件を満たす場合にのみ、キャンバスのスクリプトとページデータが読み込まれます。

  • dev.canvas.enabled設定がtrueである。
  • 現在のユーザーにedit_posts権限がある。

一般の訪問者には、キャンバスのスクリプトやページのメタデータは一切表示されません。