IntroductionScreen class
Constructors
IntroductionScreen ({Key ?key , List <PageViewModel ?pages , List <Widget ?rawPages , VoidCallback ?onDone , VoidCallback ?onSkip , ValueChanged <int ?onChange , Widget ?done , Widget ?overrideDone , Widget ?skip , Widget ?overrideSkip , Widget ?next , Widget ?overrideNext , Widget ?back , Widget ?overrideBack , bool showSkipButton = false , bool showNextButton = true , bool showDoneButton = true , bool showBottomPart = true , bool showBackButton = false , Widget ?customProgress , bool isProgress = true , bool hideBottomOnKeyboard = false , bool isProgressTap = true , bool freeze = false , Color ?globalBackgroundColor , DotsDecorator dotsDecorator = const DotsDecorator() , Decoration ?dotsContainerDecorator , int animationDuration = 350 , int ?autoScrollDuration , bool infiniteAutoScroll = false , int initialPage = 0 , int skipOrBackFlex = 1 , int dotsFlex = 1 , int nextFlex = 1 , Curve curve = Curves.easeIn , ButtonStyle ?baseBtnStyle , ButtonStyle ?skipStyle , ButtonStyle ?nextStyle , ButtonStyle ?doneStyle , ButtonStyle ?backStyle , String ?skipSemantic , String ?nextSemantic , String ?doneSemantic , String ?backSemantic , bool resizeToAvoidBottomInset = true , Position controlsPosition = const Position(left: 0, right: 0, bottom: 0) , EdgeInsets controlsMargin = EdgeInsets.zero , EdgeInsets controlsPadding = const EdgeInsets.all(16.0) , EdgeInsets bodyPadding = EdgeInsets.zero , List <ScrollController ? ?scrollControllers , Axis pagesAxis = Axis.horizontal , ScrollPhysics scrollPhysics = const BouncingScrollPhysics() , bool rtl = false , bool allowImplicitScrolling = false , CanProgress canProgress = kDefaultCanProgressFunction , List <bool safeAreaList = const [false, false, false, false]
Properties
allowImplicitScrolling → bool
Corresponds to PageView's parameter of the same name.
More details can be found
here .
final
animationDuration → int
Animation duration in milliseconds
final
autoScrollDuration → int ?
Auto scroll duration in milliseconds
final
back → Widget ?
Back button child for the pre-made TextButton
final
backSemantic → String ?
Back button semantic label
final
backStyle → ButtonStyle ?
Back button style
final
baseBtnStyle → ButtonStyle ?
Base style for all buttons
final
bodyPadding → EdgeInsets
Margin for controls
final
canProgress → CanProgress
A handler to check if the user is allowed to progress to the next page.
If returned value is true, the page will progress to the next page, otherwise the page will not progress.
In order to make it work properly with TextFormField, you should place setState in the onChanged callback of the TextFormField.
final
controlsMargin → EdgeInsets
Margin for controls
final
controlsPadding → EdgeInsets
Padding for controls
final
controlsPosition → Position
Controls position
final
curve → Curve
Type of animation between pages
final
customProgress → Widget ?
If a custom Widget should be used instead of the default progress indicator
final
done → Widget ?
Done button child for the pre-made TextButton
final
doneSemantic → String ?
Done button semantic label
final
doneStyle → ButtonStyle ?
Done button style
final
dotsContainerDecorator → Decoration ?
Decorator to customize the appearance of the progress dots container.
This is useful when the background image is full screen.
final
dotsDecorator → DotsDecorator
Dots decorator to custom dots color, size and spacing
final
dotsFlex → int
Flex ratio of the progress indicator
final
freeze → bool
If the user is allow to change page
final
globalBackgroundColor → Color ?
Global background color (only visible when a page has a transparent background color)
final
A footer widget to be shown on every screen
final
A header widget to be shown on every screen
final
hashCode → int
The hash code for this object.
no setter inherited
hideBottomOnKeyboard → bool
If the bottom part of the page should be displayed when the keyboard is opened
final
infiniteAutoScroll → bool
Defines if the autoScroll should be infinite, returning to the first page after it reaches the last one.
final
initialPage → int
Index of the initial page
final
isProgress → bool
If the progress indicator should be display
final
isProgressTap → bool
Enable or not onTap feature on progress indicator
final
key → Key ?
Controls how one widget replaces another widget in the tree.
final inherited
next → Widget ?
Next button child for the pre-made TextButton
final
nextFlex → int
Flex ratio of the next/done button
final
nextSemantic → String ?
Next button semantic label
final
nextStyle → ButtonStyle ?
Next button style
final
onChange → ValueChanged <int ?
Callback when page change
final
onDone → VoidCallback ?
Callback when Done button is pressed
final
onSkip → VoidCallback ?
Callback when Skip button is pressed
final
overrideBack → Widget ?
Override pre-made back button.
You can what you want (button, text, image, ...)
final
overrideDone → Widget ?
Override pre-made done button.
You can what you want (button, text, image, ...)
final
overrideNext → Widget ?
Override pre-made next button.
You can what you want (button, text, image, ...)
final
overrideSkip → Widget ?
Override pre-made skip button.
You can what you want (button, text, image, ...)
final
pages → List <PageViewModel ?
All pages of the onboarding
final
pagesAxis → Axis
Scroll/Axis direction of pages, can he horizontal or vertical
final
rawPages → List <Widget ?
All pages of the onboarding, as a complete widget instead of a PageViewModel
final
resizeToAvoidBottomInset → bool
Enable or disable content resizing for bottom inset (e.g. keyboard)
final
rtl → bool
If is right to left behaviour
final
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
safeAreaList → List <bool
PageView's bool safe area list.
the list defines if the safe area will be active on left, right, top and bottom, respectively.
final
scrollControllers → List <ScrollController ? ?
ScrollController of vertical SingleChildScrollView for every single page
final
scrollPhysics → ScrollPhysics
PageView scroll physics (only when freeze is set to false)
final
showBackButton → bool
If the Back button should be display
final
showBottomPart → bool
Show the bottom part of the page, that's include skip, next, done buttons
as well as dotsDecorator.
final
showDoneButton → bool
If the 'Done' button should be rendered at all the end
final
showNextButton → bool
Is the Next button should be display
final
showSkipButton → bool
Is the Skip button should be display
final
skip → Widget ?
Skip button child for the pre-made TextButton
final
skipOrBackFlex → int
Flex ratio of the skip or back button
final
skipSemantic → String ?
Skip button semantic label
final
skipStyle → ButtonStyle ?
Skip button style
final
introduction_screen 3.1.14 