コンテンツへスキップ

HTMLユーティリティ

属性値をCSSやJSファイルで使う必要がある場合があります。Blockstudioには、属性をデータ属性またはCSS変数として出力するヘルパー関数があります。

ブロックの例

次の属性を持つブロックを考えてみましょう。

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "message",
        "type": "text",
        "label": "My message"
      },
      {
        "id": "color",
        "type": "color",
        "label": "My color"
      }
    ]
  }
}

データ属性

bs_render_attributes関数は属性をデータ属性として出力します。

PHP

PHP
<h1 <?php bs_render_attributes($a); ?>>
  <?php echo $a['message']; ?>
</h1>

Twig

Twig
<h1 {{ fn('bs_render_attributes', a) }}>
  {{ a.message }}
</h1>

出力:

HTML
<h1 data-message="Hello" data-color="#7C3AED">
  Hello
</h1>

属性のフィルタリング

2つ目のパラメーターを渡すと、出力する属性を指定できます。

PHP

PHP
<h1 <?php bs_render_attributes($a, ['color']); ?>>
  <?php echo $a['message']; ?>
</h1>

Twig

Twig
<h1 {{ fn('bs_render_attributes', a, ['color']) }}>
  {{ a.message }}
</h1>

出力:

HTML
<h1 data-color="#7C3AED">
  Hello
</h1>

出力せずに値を返す

出力せずに文字列を取得するにはbs_attributesを使います。

PHP
<?php $attrs = bs_attributes($a); ?>

CSS変数

bs_render_variables関数は属性をCSS変数として出力します。

PHP

PHP
<h1 style="<?php bs_render_variables($a); ?>">
  <?php echo $a['message']; ?>
</h1>

Twig

Twig
<h1 style="{{ fn('bs_render_variables', a) }}">
  {{ a.message }}
</h1>

出力:

HTML
<h1 style="--message: Hello; --color: #7C3AED;">
  Hello
</h1>

変数のフィルタリング

PHP
<h1 style="<?php bs_render_variables($a, ['color']); ?>">

出力:

HTML
<h1 style="--color: #7C3AED;">
  Hello
</h1>

出力せずに値を返す

出力せずに文字列を取得するにはbs_variablesを使います。

PHP
<?php $vars = bs_variables($a); ?>

文字列への変換

どちらの関数も属性IDをケバブケースに変換します。

入力 出力
myAttribute my-attribute
my_attribute my-attribute
backgroundColor background-color

CSSでの使用

CSS
.my-block h1 {
  color: var(--color);
}

JavaScriptでの使用

JavaScript
const block = document.querySelector('.my-block h1');
const color = block.dataset.color;
const message = block.dataset.message;