StoryPageView class

PageView to implement story like UI

itemBuilder, storyLength, pageLength are required.

Inheritance

Constructors

StoryPageView({Key? key, required StoryItemBuilder itemBuilder, required StoryConfigFunction storyLength, required int pageLength, StoryItemBuilder? gestureItemBuilder, StoryConfigFunction? initialStoryIndex, int initialPage = 0, VoidCallback? onPageLimitReached, Duration indicatorDuration = const Duration(seconds: 5), EdgeInsetsGeometry indicatorPadding = const EdgeInsets.symmetric(vertical: 32, horizontal: 8), Color backgroundColor = Colors.black, ValueNotifier<IndicatorAnimationCommand>? indicatorAnimationController, VoidCallback? onStoryPaused, VoidCallback? onStoryUnpaused, void onPageBack(int newPageIndex)?, void onPageForward(int newPageIndex)?, void onStoryIndexChanged(int newStoryIndex)?})
const

Properties

backgroundColor → Color
Color under the Stories which is visible when the cube transition is in progress
final
gestureItemBuilder → StoryItemBuilder?
Function to build story content Components with gesture actions are expected Placed above the story gestures.
final
hashCode → int
The hash code for this object.
no setterinherited
indicatorAnimationController → ValueNotifier<IndicatorAnimationCommand>?
A stream with IndicatorAnimationCommand to force pause or continue inticator animation Useful when you need to show any popup over the story
final
indicatorDuration → Duration
duration of Indicators
final
indicatorPadding → EdgeInsetsGeometry
padding of Indicators
final
initialPage → int
initial index for StoryPageView
final
initialStoryIndex → StoryConfigFunction?
Initial index of story for each page
final
itemBuilder → StoryItemBuilder
Function to build story content
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onPageBack → (void Function(int newPageIndex)?)
Called whenever the user is going backwards to a new page
final
onPageForward → (void Function(int newPageIndex)?)
Called whenever the user is going forwards to a new page
final
onPageLimitReached → VoidCallback?
Called when the very last story is finished.
final
onStoryIndexChanged → (void Function(int newStoryIndex)?)
Called whenever the user is clicks to go back or forward a story
final
onStoryPaused → VoidCallback?
Called whenever the user holds down a story Useful when displaying a video and you need to pause the video
final
onStoryUnpaused → VoidCallback?
Called whenever the user stops holding down a story Useful when displaying a video and you need to unpause the video
final
pageLength → int
length of StoryPageView
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
storyLength → StoryConfigFunction
decides length of story for each page
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → StoryPageViewState
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

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