Logo FluentUI

Tour QML Type

一个用于引导用户完成步骤的提示组件。. More...

Import Statement: import FluentUI.Controls 1.0

Properties

Detailed Description

`Tour` 组件是一个自定义的引导提示框,用于引导用户逐步完成任务或了解应用的不同部分。它通过展示一系列步骤,并在每个步骤中突出显示目标区域,帮助用户更好地理解应用的使用流程。组件支持自定义步骤的文本、按钮文本以及背景颜色。

示例用法:

 Tour {
  steps: [
      {
          title: qsTr("Step 1"),
          description: qsTr("This is the first step of the tour."),
          target: someItem,
          onNextListener: function(tour) { console.log("Step 1 Next clicked") }
      },
      {
          title: qsTr("Step 2"),
          description: qsTr("This is the second step of the tour."),
          target: anotherItem,
          onPreviousListener: function(tour) { console.log("Step 2 Previous clicked") }
      }
  ]
  finishText: qsTr("Complete Tour")
  nextText: qsTr("Next")
  previousText: qsTr("Previous")
 }

Property Documentation

backgroundColor : color

引导提示框的背景颜色。根据应用的主题自动选择深色或浅色。


finishText : string

完成所有步骤后的按钮文本。


index : int

当前步骤的索引,从 0 开始。


nextText : string

“下一步”按钮的文本。


previousText : string

“上一步”按钮的文本。


steps : var

用于引导用户的步骤列表。每个步骤是一个对象,包含以下属性: - `title`: 步骤标题 - `description`: 步骤描述 - `target`: 突出显示的目标项 - `onNextListener`: 点击“下一步”按钮时触发的回调函数 - `onPreviousListener`: 点击“上一步”按钮时触发的回调函数


targetMargins : int

目标项周围的边距,以像素为单位。