Skip to main content
Version: 25.2 (main)

Collection Widget

Use the Collection Widget to display collections, such as recipes or active tools, directly inside your Dashboard. Just like on the Collection Page, you can add a Detail view to this widget, allowing operators to expand the items.


Common Properties

Container

Icon

This icon will be displayed next to the element's label on pages that support it, like the Dashboard Page. An Element can make use of the icon to:

  • Provide more context to add meaning
  • Improve recognition and discoverability, especially on larger pages

Label

Provides context and information to operators, guiding them and helping them understand the value of this particular element. A good label instills confidence in operators when making adjustments.

Description

Will be displayed underneath the element. This description provides additional guidance or instructions for operators manipulating the element. It expands on the label by offering supporting details and clarifying what the element represents or how it behaves. It provides an opportunity to offer more detailed context regarding the potential impact of changes or further instructions on the desired input format.
Display Condition

Condition

Determines whether an element or page should be visible or hidden to the current user. The condition can be set to different types of Dynamic Property – as long as the the type returns true or false you're good to go.

Specific Properties

Data Source

PLC

The List property lets you choose a List that should be used as the data source for this Collection.

Database
Early Access

Please note that this feature is currently in early access and it only supports SQLite databases which need to be configured manually within the project.

  • Choose a Database as the source for this collection.
  • Choose a Table within this database that you you want to display using this the collection.

Main Action

Button that will be displayed in the upper right corner of the widget. By pressing it, users can execute an action.

Label

Label that will be used for the action button.

Icon

Icon that will be displayed on the action button.

Example Widget with Main Action and Icon

On click

Action that gets executed when clicking the button. Use it to:

Is disabled

Disable the action by setting this boolean property to true. The action will never execute while it is disabled.

Detail View

Placement

Select whether the overlay should be displayed in the center of the screen or on any side of the display.

Size

Choose how large you want the view to be. Choose between Full, Medium, or Small.

Sorting

Add a default order to the collection to make sure it's arranged in the right sequence. To do that, just choose the property you want to sort by and the order (ascending or descending).