Block

Block api reference

Block object

{
  "id": "111111111-2222-3333-4444-555555555555",
  "parentId": "",
  "keyType": "ROOT",
  "key": "root",
  "visibilityKey": "root-visibility",
  "slot": "",
  "position": 0,
  "data": [],
  "properties": [],
  "events": [],
  "slots": []
}

id

String

Unique identifier for a block.

---

parentId

String

Indicates a block belongs to another block, and the parent Id must be used for another block's id.

---

keyType

String

Unique key to indicate a block type and it is unique for entire of the platform.

---

key

String

Unique key for a block inside of a frame.

---

visibilityKey

String

Variable key for a block's visibility, the variable type is Boolean.

---

slot

String

Indicate a block is on which parent's slot.

---

position

Int

Position of a block in block's slots hierarchy.

---

data

Data [ ]

Variable list for passing data to a block, like text, image url, and etc.

---

properties

Property [ ]

Property list of a block, like, padding, background, and etc.

---

events

Event [ ]

Event list of a block, an event will trigger based on user interaction, like, onClick, onSwipe, and etc.

---

slots

Slot [ ]

Slot list of a block, show available place for a block's children, like, Content for a list or TralingIcon/LeadingIcon for a button.