solui
  • Getting Started
  • Docs
  • Github
  • Twitter
  • Telegram

Panels

Panels are user interfaces which perform execution tasks.

A panel display a single button to execute all the tasks and obtain the result. It may also have user input fields to pass input arguments to the execution tasks.

Structure

{
  ...,
  "panels": [
    {
      "id": "...",
      "title": "...",
      "inputs": [ ... ],
      "execs": [ ... ],
      "outputs": [ ... ]
    }
  ]
}

Reference

id

This should be a human-readable and identifier for the panel, e.g. deploy-token. The supported characters are: A-Z, a-z, 0-9 and -. It must be between 3 and 32 characters in length.

This id must be unique amongst all the other panels in the spec.

Example:

{
  "id": "create-token",
}

title

A user-friendly title for the panel. It must be between 3 and 256 characters in length.

Example:

{
  "title": "Create new token",
}

inputs (optional)

User input fields which define input arguments to pass to the execution tasks.

{
  "inputs": [
    { ... },
    { ... },
    ...,
  ]
}

execs

The execution tasks to perform the when the panel gets executed.

The tasks are executed in sequence, one after another. This allows for earlier tasks' outputs to be re-used as later tasks' inputs.

{
  "execs": [
    { ... },
    { ... },
    ...,
  ]
}

outputs (optional)

The outputs to display to the user once panel tasks are successfully executed.

Each output refers to the result of an execution task.

{
  "outputs": [
    { ... },
    { ... },
    ...,
  ]
}