Frame

Frame api reference

Frame object

{
  "id": "11111111-2222-2222-3333-444444444444",
  "name": "home",
  "route": "/",
  "isStarter": true,
  "routeArguments": [],
  "variables": [],
  "blocks": [],
  "actions": []
}

id

String

Unique identifier for a frame.

---

name

String

Human readable name of a frame.

---

route

String

A route uniquely identifies a destination and includes any necessary data for it. You can use a route to navigate, as it directs you to a specific destination.

---

isStarter

Boolean

A flag shows which frame is the starting point in a list of frames.

---

routeArguments

String [ ]

Array of specific data to the route, for example the "id" is route argument of the route

route: page/detail/{id}

---

Variables

Variable [ ]

List of variable within each frame that store all the frame's data and make it accessible throughout the entire frame.

---

Blocks

Block [ ]

List of block within each frame represent visual elements like text, button, image and etc.

---

Actions

Action [ ]

List of action within each frame to execute triggers based on events, like navigation between frame or sending API requests.