StoryItem class

This is a representation of a story item (or page).

Constructors

StoryItem(Widget view, {Duration duration = const Duration(seconds: 3), bool shown = false})

Properties

duration Duration
Specifies how long the page should be displayed. It should be a reasonable amount of time greater than 0 milliseconds.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shown bool
Has this page been shown already? This is used to indicate that the page has been displayed. If some pages are supposed to be skipped in a story, mark them as shown shown = true.
getter/setter pair
view Widget
The page content
final

Methods

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

Static Methods

pageGif(String? url, {StoryController? controller, BoxFit imageFit = BoxFit.fitWidth, String? caption, bool shown = false, Duration duration = const Duration(seconds: 3), Map<String, dynamic>? requestHeaders, TextStyle? captionTextStyle, EdgeInsets? captionMargin, EdgeInsets? captionPadding}) StoryItem
pageImage(ImageProvider<Object> image, {BoxFit imageFit = BoxFit.fitWidth, String? caption, bool shown = false, Duration duration = const Duration(seconds: 3)}) StoryItem
Shorthand for a full-page image content.
pageVideo(String? url, {StoryController? controller, Duration duration = const Duration(seconds: 10), BoxFit imageFit = BoxFit.fitWidth, bool shown = false, Map<String, dynamic>? requestHeaders, String? caption, TextStyle? captionTextStyle, EdgeInsets? captionMargin, EdgeInsets? captionPadding}) StoryItem
text(String title, Color backgroundColor, {bool shown = false, Duration duration = const Duration(seconds: 3), double fontSize = 18, bool roundedTop = false, bool roundedBottom = false}) StoryItem
Short hand to create text-only page.