IntroductionOptions class

Constructors

IntroductionOptions({IntroductionTranslations introductionTranslations = const IntroductionTranslations(), IntroductionButtonTextstyles introductionButtonTextstyles = const IntroductionButtonTextstyles(), IndicatorMode indicatorMode = IndicatorMode.dot, Widget indicatorBuilder(BuildContext, PageController, int, int)?, IntroductionLayoutStyle layoutStyle = IntroductionLayoutStyle.imageCenter, List<IntroductionPage> pages = defaultIntroductionPages, IntroductionScreenButtonMode buttonMode = IntroductionScreenButtonMode.text, bool tapEnabled = false, IntroductionScreenMode mode = IntroductionScreenMode.showNever, TextAlign textAlign = TextAlign.center, IntroductionDisplayMode displayMode = IntroductionDisplayMode.multiPageHorizontal, bool skippable = false, Widget buttonBuilder(BuildContext, VoidCallback , Widget, IntroductionButtonType)?, IntroductionControlMode controlMode = IntroductionControlMode.previousNextButton})
const

Properties

buttonBuilder → (Widget Function(BuildContext, VoidCallback , Widget, IntroductionButtonType)?)
A builder that can be used to replace the default text buttons when IntroductionScreenButtonMode.text is provided to buttonMode
final
buttonMode → IntroductionScreenButtonMode
Determines what kind of buttons are used to navigate to the next introduction screen. Introduction screens can always be navigated by swiping (or tapping if tapEnabled is enabled).
final
controlMode → IntroductionControlMode
When IntroductionDisplayMode.multiPageHorizontal is selected multiple controlMode can be selected.
final
displayMode → IntroductionDisplayMode
IntroductionDisplayMode.multiPageHorizontal Configured introduction pages will be shown on seperate screens and can be navigated using using buttons (if enabled) or swiping.
final
hashCode → int
The hash code for this object.
no setterinherited
indicatorBuilder → (Widget Function(BuildContext, PageController, int, int)?)
Builder that is called when indicatorMode is set to IndicatorMode.custom
final
indicatorMode → IndicatorMode
Determines the style of the page indicator shown at the bottom on the introduction pages.
final
introductionButtonTextstyles → IntroductionButtonTextstyles
The textstyles for all buttons on the introductionpages
final
introductionTranslations → IntroductionTranslations
The translations for all buttons on the introductionpages
final
layoutStyle → IntroductionLayoutStyle
Determines the position of the provided images or icons that are set using pages. Every introduction page provided with a image or icon will use the same layout setting.
final
mode → IntroductionScreenMode
Determine when the introduction screens needs to be shown.
final
pages → List<IntroductionPage>
List of introduction pages to set the text, icons or images for the introduction screens.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
skippable → bool
Determines whether the user can skip the introduction pages using a button in the header
final
tapEnabled → bool
Determines whether the user can tap the screen to go to the next introduction screen.
final
textAlign → TextAlign
Determines whether the introduction screens should be shown in a single
final

Methods

copyWith({IntroductionScreenMode? mode, List<IntroductionPage>? pages, bool? tapEnabled, IntroductionScreenButtonMode? buttonMode, IntroductionLayoutStyle? layoutStyle, IndicatorMode? indicatorMode, Widget indicatorBuilder(BuildContext, PageController, int, int)?, bool? skippable, TextAlign? textAlign, IntroductionDisplayMode? displayMode, IntroductionControlMode? controlMode, Widget buttonBuilder(BuildContext, VoidCallback , Widget, IntroductionButtonType)?, IntroductionTranslations? introductionTranslations, IntroductionButtonTextstyles? introductionButtonTextstyles}) → IntroductionOptions
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited