Skip to main content

Output guide

The outputs represent the states & results of the app.

All outputs can be found on the left-hand side of the app editor. There are three kind of outputs:

  • Context and state
  • Component outputs
  • Background runnables outputs

App demo outputs

When a component or a background runnable is selected, the outputs of the component or the background runnable are displayed. You can manually open an output by clicking on the header of the output. Once manually opened, the output will stay open until you close it.

You can search for an output by typing in the search bar. It searches in the output name and in the output object keys, recursively.

Search outputs

Context and state​

App context​

The app context contains the following outputs:

  • summary: the summary of the current app.
  • email: the email of the current user.
  • groups: the groups the user is part of.
  • hash: the hash parameters of the URL.
  • mode: the mode the app is currently in (editor / viewer).
  • query: the query parameters of the URL.
  • username: the username of the current user.
  • workspace: the workspace of the current app.

State​

The app state is a client-side store that can be used to store data. The app state can be manipulated by frontend scripts.

Component outputs​

Each component has its own outputs. The outputs are displayed in a tree structure. The tree structure is collapsible and can be expanded by clicking on the {...} button. Next to the button, you can see the number of outputs.

App outputs collapsed

For example, the Table component has the following outputs:

  • selectedRow: the selected row as an object
  • loading: the loading state of the table
  • result: the result of the table
  • search: the search value of the table
  • selectedRowIndex: the selected row index

App outputs

The outputs are used to quickly visualize the current state of the app.

Containers​

Some components are "containers" and can contain other components.

The components contained in a container have their outputs displayed in the container outputs.

App outputs

Layout (Containers)
Containers can group other components.

Background runnables outputs​

A background runnable is a script or flow that runs in the background and can be used to perform actions that are not related to the UI.

Connecting inputs​

Inputs can be connected to any outputs. When connecting, you can click on the output to connect the input to it. The data source will change to eval. Note that you can select nested outputs, objects and arrays.


Here are the steps to connect an input to an output:

  • Click on the component input you want to connect to an output.
  • Click on the plug icon to open the connection menu, then:
    • either click on the red plug directly next to the component, and pick the output
    • or pick the component directly from the output menu on the left.
  • The input is now connected to the output through an eval.

Alternatively, refer to the component directly through an eval, e.g. a.result.

App outputs

Forcing the value of a component​

You can use a frontend script helper: setValue that is meant to manually set or force the value of a component. This can be convenient in cases where connecting components is not the easiest pattern.

setValue(id: string, value: any)

Note that it's a bad idea to mix dynamic default value and setValue together.

Connecting runnables inputs to resources​

Apps are executed on behalf of publishers and by default cannot access viewer's resources.

If the resource passed here as a reference does not come from a static Resource select component (which will be whitelisted by the auto-generated policy), you need to toggle "Resources from users allowed".

The toggle "Static resource select only / Resources from users allowed" can be found for each runnable input when the source is an eval.

Static resource select only / Resources from users allowed

Editing the id of a component​

You can edit the id of a component by clicking on the id. Component id can only contain letters and numbers.