BrnGuide class
通过阻断式的交互弹框，实现新手交互 支持 强引导：界面变灰，引导框高亮| 弱引导：直接在界面浮现提示框两种
Constructors
- BrnGuide({required GuideMode introMode, required Widget widgetBuilder(StepWidgetParams params), required int stepCount, BorderRadiusGeometry borderRadius = const BorderRadius.all(Radius.circular(4)), EdgeInsets padding = const EdgeInsets.all(10), void onNextClick(int nextIndex)?})
Properties
- borderRadius → BorderRadiusGeometry
-
强提示下的高亮圆角，默认 BorderRadius.all(Radius.circular(4))
final
- currentStepIndex → int
-
当前处于第几步
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- introMode ↔ GuideMode
-
引导交互的模式
getter/setter pair
-
keys
→ List<
GlobalKey< State< >StatefulWidget> > -
no setter
- onNextClick → (void Function(int nextIndex)?)
-
每次点击的下一步的时候的回调
final
- padding → EdgeInsets
-
高亮组件与目标组件的间距，默认是 10
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- stepCount → int
-
步骤数量，必传
final
- widgetBuilder → Widget Function(StepWidgetParams params)
-
每一步的具体引导 Widget
final
Methods
-
dispose(
) → void - Destroy the guide page and release all resources
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setStepConfig(
int stepIndex, {EdgeInsets? padding, BorderRadiusGeometry? borderRadius}) → void - Set the configuration of the specified number of steps
-
setStepsConfig(
List< int> stepsIndex, {EdgeInsets? padding, BorderRadiusGeometry? borderRadius}) → void - Set the configuration of multiple steps
-
start(
BuildContext context) → void -
触发引导操作
context当前环境BuildContext的启动方法 -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited