StoryView class
Widget to display stories just like Whatsapp and Instagram. Can also be used inline/inside ListView or Column just like Google News app. Comes with gestures to pause, forward and go to previous page.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- StoryView
Constructors
-
StoryView({required List<
StoryItem?> storyItems, required StoryController controller, VoidCallback? onComplete, void onStoryShow(StoryItem storyItem, int index)?, ProgressPosition progressPosition = ProgressPosition.top, bool repeat = false, bool inline = false, dynamic onVerticalSwipeComplete(Direction?)?, Color? indicatorColor, Color? indicatorForegroundColor, IndicatorHeight indicatorHeight = IndicatorHeight.large, EdgeInsetsGeometry indicatorOuterPadding = const EdgeInsets.symmetric(horizontal: 16, vertical: 8)})
Properties
- controller → StoryController
-
Controls the playback of the stories
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- indicatorColor → Color?
-
Indicator Color
final
- indicatorForegroundColor → Color?
-
Indicator Foreground Color
final
- indicatorHeight → IndicatorHeight
-
Determine the height of the indicator
final
- indicatorOuterPadding → EdgeInsetsGeometry
-
Use this if you want to give outer padding to the indicator
final
- inline → bool
-
If you would like to display the story as full-page, then set this to
false. But in case you would display this as part of a page (eg. in a ListView or Column) then set this totrue.final - key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onComplete → VoidCallback?
-
Callback for when a full cycle of story is shown. This will be called
each time the full story completes when repeat is set to
true.final - onStoryShow → void Function(StoryItem storyItem, int index)?
-
Callback for when a story and it index is currently being shown.
final
- onVerticalSwipeComplete → dynamic Function(Direction?)?
-
Callback for when a vertical swipe gesture is detected. If you do not
want to listen to such event, do not provide it. For instance,
for inline stories inside ListViews, it is preferrable to not to
provide this callback so as to enable scroll events on the list view.
final
- progressPosition → ProgressPosition
-
Where the progress indicator should be placed.
final
- repeat → bool
-
Should the story be repeated forever?
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
storyItems
→ List<
StoryItem?> -
The pages to displayed.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< StatefulWidget> -
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