Tour QML Type
A guided tour overlay for feature introduction, with a page indicator. More...
| Import Statement: | import FluentUI.Controls 1.0 |
Properties
- backgroundColor : color
- finishText : string
- index : int
- indicator : Component
- maskColor : color
- nextText : string
- offset : int
- offsetX : int
- offsetY : int
- popupItem : var
- previousText : string
- radius : int
- steps : list<QtObject>
Methods
- void open()
Detailed Description
Tour provides an interactive overlay that guides users through the application's features step by step. It highlights target areas with a masked overlay and displays popup bubbles with instructional content. The step indicator defaults to PageIndicator with a smooth caterpillar-like sliding animation.
Property Documentation
backgroundColor : color
The background color of the tour popup bubble.
finishText : string
The text displayed on the finish button of the last tour step.
index : int
The index of the currently displayed step. Defaults to 0. Changing this property programmatically navigates to the specified step.
indicator : Component
A custom component for the step indicator displayed in the tour popup. Defaults to a PageIndicator with a smooth pill-sliding animation. The component receives count and currentIndex properties (as well as the legacy total and current properties for backward compatibility).
maskColor : color
The color of the overlay mask that dims the area outside the highlighted target.
nextText : string
The text displayed on the next step button.
offset : int
The default offset from the target item edges in pixels. Defaults to 5. Used when offsetX or offsetY are not explicitly set.
offsetX : int
The horizontal offset from the target item in pixels. Overrides the offset property for the horizontal axis.
offsetY : int
The vertical offset from the target item in pixels. Overrides the offset property for the vertical axis.
popupItem : var
The popup item instance used to display tour step content. This property is read-only and provides access to the currently active popup.
previousText : string
The text displayed on the previous step button.
radius : int
The corner radius of the highlighted area. Defaults to 4.
steps : list<QtObject>
The list of tour step definitions. Each step typically specifies a target item, title, description, and optional configuration for the popup position and appearance.
Method Documentation
void open()
Opens the tour overlay starting from the first step (index 0).