コンテンツへスキップ

変換

ブロック変換APIでは、ブロックの変換方法を定義できます。Blockstudioは現在、次の3種類をサポートしています。

  • ブロックからブロックへ: あるブロックを別のブロックに変換
  • Enter: ユーザーがテキストを入力してEnterを押したときにブロックを挿入
  • 接頭辞: ユーザーがテキストを入力してSpaceを押したときにブロックを挿入

ブロックからブロックへ

ブロック間の変換を使うと、あるブロックを別のブロックに変換できます。

JSON
{
  "$schema": "https://blockstudio.dev/schema/block",
  "name": "blockstudio/transforms",
  "title": "Native Transforms",
  "icon": "star-filled",
  "description": "Native Blockstudio Transforms.",
  "blockstudio": {
    "transforms": {
      "from": [
        {
          "type": "block",
          "blocks": [
            "blockstudio/transforms-2",
            "blockstudio/transforms-3"
          ]
        }
      ]
    },
    "attributes": [
      {
        "id": "text",
        "type": "text",
        "label": "Text"
      }
    ]
  }
}

新しいブロックに変換すると、元のブロックの属性が新しいブロックに引き継がれます。上の例では、text属性が新しいブロックに引き継がれます。すべてのInnerBlocksコンテンツも同様です。

変換先と変換元のブロックでは、属性の型が同じでなければならない点に注意してください。たとえば、変換先のブロックにIDがtextで型がnumberの属性がある場合、型が一致せずレンダリングエラーが発生するため、変換リストには表示されません。

2つのブロックの属性数は同じでなくてもかまいません。

入力

Enter変換を使うと、ユーザーが特定の内容を入力してEnterキーを押したときにブロックを挿入できます。

JSON
{
  "blockstudio": {
    "transforms": {
      "from": [
        {
          "type": "enter",
          "regExp": "/^-{3,}$/"
        }
      ]
    }
  }
}

上の例では、ユーザーが3つ以上のダッシュ(-)を入力してからEnterを押すと、ブロックが挿入されます。

接頭辞

接頭辞変換を使うと、ユーザーが特定の内容を入力してSpaceキーを押したときにブロックを挿入できます。

JSON
{
  "blockstudio": {
    "transforms": {
      "from": [
        {
          "type": "prefix",
          "regExp": "???"
        }
      ]
    }
  }
}

上の例では、ユーザーが疑問符を3つ(?)入力してからSpaceを押すと、ブロックが挿入されます。