Skip to main content

Run button inputs

A way for you to control when certain code executes.

For example, Run buttons inputs are useful if you need to wait for user input before writing back to your database or if you have a bunch of debugging code you don't want to always run.

Configure Run button inputs#

When setting up a Run button input you can customize several settings, in addition to the standard label and name.

  • Color: Select the color of the button. Current options are grey, blue, green, orange, & red
  • Icon: Select the icon displayed on the button by typing the name of any icon from the Blueprint icon library
  • Text: Input the text that will display on the button

Usage#

The output of a Run button input is a boolean which evaluates True if a user has pressed the button and False if they haven't. For example, if a user refreshes an app (in the App Builder) or re-runs the project (in Logic View) your button parameters have not explicitly been pressed and so will evaluate False. When a user presses a button a full project run is triggered. During that specific run, the button parameter will be evaluated True. This means that only one button can be actively used at a time.

To connect the code that runs if a button has/hasn't been pressed, use the name of the button parameter in some conditional logic downstream, as show in the gif below.

Run buttons can be great for when you want your app users to be very intentional with a portion of the app - for example, requiring users to click a Run button in order to writeback to your database. Check out this tutorial for an example.