Skip to main content

Monitors Display

Element type: Dictionary

This component informs the end user about the state of the installation of applications, files, properties... specified in the Monitors array (see Monitoring for further information).
Each row will display:

  • A symbol or a spinner indicates the state of the installation process
  • The app icon (or a generic one)
  • The monitor name
  • The detail text (if any specified)
info

Since Octory 3.1.0, this component can be placed inside a Card, to frame the installation dashboard on its own surface. The card must declare a Height: the list then fills the card and scrolls inside it.

Keys​

NameTypePossible valuesRequired
TypeStringMonitorsDisplayRequired
NameFontConfigurationDictionary (Font)-
DetailFontConfigurationDictionary (Font)-
IsMandatoryBoolean
WaitForApplicationToBeInstalledWarningTextString-
ShowScrollerBool-
MarginsDictionary (Margins)-
BorderDictionary (Border)-
Condition PRODictionary (Condition)-

Detail​

Type Required​

Type: String
Explanation: The type of the component which has to be MonitorsDisplay.

NameFontConfiguration​

Type: Dictionary (Font)
Explanation: The font used to display the name text of the monitor.

DetailFontConfiguration​

Type: Dictionary (Font)
Explanation: The font used to display the detail text of the monitor.

note

Before Octory 3.1.0, only the color of these two font configurations was applied, and the font itself was ignored. Both keys are now fully honored, so a monitors list may render with a different font than before if you had configured one.

IsMandatory​

Type: Boolean
Default: false
Explanation: If set to true, the slide will be invalid until all applications are installed, and an alert will be shown.

WaitForApplicationToBeInstalledWarningText​

Type: String
Explanation: Let you customize the text which will be displayed in the alert when shown, if IsMandatory is set to true.

ShowScroller​

Type: Boolean
Availability: 2.1.0+
Default: false
Explanation: When true, the vertical scroller will be displayed in the list.

Margins​

Type: Dictionary (Margins)
Explanation: Add padding to the component's sides.

Border​

Type: Dictionary (Border)
Explanation: Add a top or bottom border to a component.

Condition PRO​

Type: Dictionary (Condition)
Explanation: Allows to hide or show the component using a boolean expression.

Example​

MonitorsDisplay component with custom warning text, Name font configuration to be "Body" and a text color to be "Main", and a Detail font configuration to be "Body" and a text color to be "Secondary".

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<!-- ... -->
<key>Slides</key>
<array>
<dict>
<key>Containers</key>
<array>
<dict>
<key>Components</key>
<array>
<dict>
<dict>
<key>Type</key>
<string>MonitorsDisplay</string>
<key>NameFontConfiguration</key>
<dict>
<key>Style</key>
<string>Body</string>
<key>Color</key>
<dict>
<key>Style</key>
<string>Main</string>
</dict>
</dict>
<key>DetailFontConfiguration</key>
<dict>
<key>Style</key>
<string>Body</string>
<key>Color</key>
<dict>
<key>Style</key>
<string>Secondary</string>
</dict>
</dict>
<key>WaitForApplicationToBeInstalledWarningText</key>
<string>We are still setting up your computer. Please wait a few more minutes.</string>
</dict>
</array>
</dict>
</array>
</dict>
</array>
<!-- ... -->
</dict>
</plist>