コンテンツへスキップ

コードフィールドのアセット

ファイルとして用意する静的なスタイルやスクリプトに加え、Blockstudioはコードフィールドによる動的アセットブロックにも対応しています。用途に応じて、ブロックごとに適用範囲を限定できます。

基本的な使い方

最も基本的な方法は、テンプレート内でコードフィールドの内容を手動でレンダリングすることです。

PHP

PHP
<div useBlockProps>
  <h1>My block</h1>
</div>
<style><?php echo $attributes['css']; ?></style>

Twig

Twig
<div useBlockProps>
  <h1>My block</h1>
</div>
<style>{{ attributes.css }}</style>

適用範囲を限定するセレクター

他のブロックとの競合を避けるには、レンダリングテンプレートでuseBlockPropsとともに、コードフィールド内で%selector%変数を使用できます。

コードフィールドでは、%selector%は個々のブロックインスタンスを対象にします。CSSファイルとSCSSファイルでは、%selector%はブロック共通のスコープ付きクラスを対象にします。

例

先ほどの例にあるh1タグを、コードフィールドから対象にするとします。

CSS
%selector% h1 {
  color: red;
}

すると、Blockstudioは次の3つを行います。

  • そのブロックインスタンスに一意のIDを作成する
  • %selector%を一意のIDに置き換える
  • useBlockPropsが付いた要素に同じセレクターを追加する

最終的な出力は次のようになります。

HTML
<div data-assets="c9abe0d95c2b">
  <h1>My block</h1>
</div>
<style>
  [data-assets='c9abe0d95c2b'] h1 {
    color: red;
  }
</style>

自動レンダリング

毎回styleタグを手動で出力するのは手間がかかります。この処理を簡単にするには、コードフィールド内でasset属性を使用できます。

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "type": "code",
        "id": "code",
        "label": "Custom CSS",
        "language": "css",
        "asset": true
      }
    ]
  }
}

これにより、cssとして指定されたコードブロックに対してstyleタグが自動的に作成され、ドキュメントのheadに移動されます。言語にjavascriptが指定されたフィールドでは、代わりにscriptタグが作成され、bodyの末尾に配置されます。

拡張機能内

拡張機能内でコードフィールドを使う場合、asset属性は不要です。言語がcssまたはjavascriptの場合、Blockstudioがコードフィールドの内容をアセットとして自動的に出力します。

例

JSON
{
  "$schema": "https://blockstudio.dev/schema/extend",
  "name": "core/*",
  "blockstudio": {
    "extend": true,
    "attributes": [
      {
        "id": "customCss",
        "type": "code",
        "label": "Custom css",
        "language": "css"
      }
    ]
  }
}

追加の設定は必要ありません。上記の設定により、サイドバーの各core/*ブロックにコードフィールドが表示され、内容がページのアセットとして自動的に出力されます。

SCSS

コードフィールドはSCSSコンパイルに対応しています。言語をscssに設定すると、Blockstudioが値をScssPhpでコンパイルしてからCSSとして出力します。

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "type": "code",
        "id": "styles",
        "label": "Styles",
        "language": "scss",
        "asset": true
      }
    ]
  }
}

SCSSの変数、ネスト、ミックスインなどの機能もすべて使えます:

Scss
%selector% {
  $primary: #3b82f6;

  h1 {
    color: $primary;
  }

  &:hover {
    background: lighten($primary, 40%);
  }
}

エディターではSCSSがサーバー側でリアルタイムにコンパイルされるため、入力しながら結果を確認できます。フロントエンドではブロックのレンダリング時にコンパイルされます。