Slides
A Slide is similar to a slide in presentation software like PowerPoint or Keynote. Users will be able to navigate between slides with Previous and Next buttons. You specify all the slides you want to show to the user in the Slides array in the Plist
. One Slide only can be displayed at a time to the user on the window. A Slide will take the overall space available in the window.
In some cases, only one Slide will be displayed to the user. For instance, when the app appears in the menu bar with the window OnScreen or in another window with the OpenWindow action.
In such cases, the navigation will be hidden (it's also possible to hide the navigation by specifying it in the Navigation section).
Keys
Name | Type | Required |
---|---|---|
Containers | Array(Dictionary) | Required |
ContainersBorderColor | Dictionary (Color) | |
HidePreviousButton | Boolean | |
HideNextButton | Boolean |
Detail
Containers Required
Type: Array (Dictionary)
Explanation: Specify here the containers of the slide. The order of the containers in the array will determine their horizontal order when displayed.
ContainersBorderColor
Type: Dictionary (Color)
Explanation: Default color used for the border of all the containers in the slide.
HidePreviousButton
Type: Boolean
Default: false
Explanation: If true
, the navigation previous button will be hidden when this slide is shown.
HideNextButton
Type: Boolean
Default: false
Explanation: If true
, the navigation next button will be hidden when this slide is shown.
Valid state
A slide can be valid or invalid depending on its containers' components. For example when filling a form and using an InputComponent
or waiting for all applications to be installed with AppMonitoring
component. If a slide is invalid, the user will not be able to navigate to the next slide, or to quit the app. When they will press the next or quit button, informative text will be displayed. You can customize this behavior in the components which offer the validation feature, like the InputComponent
.
Examples
We specify here a slide with a custom default ContainersBorderColor
.
<?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>ContainersBorderColor</key>
<dict>
<key>DarkMode</key>
<string>#819ABE</string>
<key>LightMode</key>
<string>#ED682580</string>
</dict>
<key>Containers</key>
<array>
<!-- The containers go here -->
</array>
</dict>
</array>
<!-- ... -->
</dict>
</plist>