Laboperator Schema Docs
Edit on GitHub

Button

A schema that is used to validate a part of Laboperator workflow templates.

labelrequired
string

The displayed label of the button.

color
string
default: primary

The color of the button. The value must be an accepted CSS color keyword or defined via the rgb() or hsl() functional notations. The organization theme colors can be referenced with primary and secondary. The color may also include an alpha-channel transparency value.

Examples:
secondary

hotpink

"#FF69B4"

rgb(100%, 41%, 71%)

hsl(330, 100%, 71%)
variant
string
one of: contained outlined text
default: contained

The button variant. Contained buttons are high-emphasis, distinguished by their use of elevation and fill. They contain actions that are primary to their context. Outlined buttons are medium-emphasis buttons. Text buttons are typically used for less-pronounced actions.

keyrequired
reference
Member Name

A unique reference passed to a manual trigger that can be used in a behaviors definition to react to this button being clicked.

The key can be used as a button id if it is unique in the current context and id is not defined. For example, use the key to display the button inside markdown in the format {{button|myKey}}.

id
reference
Member Name

Can be used to render the button inside markdown text. For example, when id is defined as print, the text may look like:

Use this view to print the weight {{button|print}}.
placement
string
one of: manual default
default: default

Buttons defined globally or at the step level of the template always have to be placed manually. Their placement setting is always considered to be manual.

Substep buttons with a setting of default will be automatically displayed at the very bottom of a substep in the order in which they are defined. When set to manual, a substep button has to be referenced inside the description markdown to be displayed.

Where is this used?
Other schemas that have a reference ($ref) to this schema.