StoryPageView class - story_page_view library

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, void onPageChanged(int)?, Color indicatorVisitedColor = Colors.white, Color indicatorUnvisitedColor = Colors.grey, double indicatorHeight = 2, bool showShadow = false})

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
indicatorHeight → double: Width of indicator
final
indicatorPadding → EdgeInsetsGeometry: padding of _Indicators
final
indicatorUnvisitedColor → Color: unvisited color of _Indicators
final
indicatorVisitedColor → Color: visited color 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
onPageChanged → void Function(int)?: Called whenever the page in the center of the viewport changes.
final
onPageLimitReached → VoidCallback?: Called when the very last story is finished.
final
pageLength → int: length of StoryPageView
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
showShadow → bool: Whether to show shadow near indicator
final
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