Package selection guidance compiled from public package information, community data, and project usage.
The story package provides an Instagram Stories-inspired UI with smooth animations and high customizability. It enables developers to create interactive, swipeable story cards with customizable transitions, timers, and content layouts. Ideal for apps needing a dynamic storytelling experience, it supports multiple platforms including mobile, web, and desktop. The package is designed for ease of integration with Flutter's widget system and offers extensive styling options for both appearance and behavior.
Use cases
Creating social media-style story feeds
Building interactive tutorials or onboarding flows
Displaying time-limited content updates
Designing engaging marketing campaigns
Implementing user profile story highlights
Key features
Rich, animated story transitions
Customizable story card layouts
Swipe gesture support across platforms
Configurable duration and progress indicators
Extensible theme and styling options
Suitable for
Developers building social features
Apps requiring time-bound content delivery
Designers seeking animated UI components
Cross-platform applications with story-like interfaces
Considerations
Requires careful handling of state during navigation
May impact performance with large story sets
Limited built-in analytics or tracking
Not optimized for very long stories
Depends on external animation libraries for advanced effects
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
Instagram stories like UI with rich animations and customizability.
Usage
StoryPageView requires at least three arguments: itemBuilder, pageLength, and storyLength.
/// Minimum example to explain the usage.returnScaffold(
body: StoryPageView(
itemBuilder: (context, pageIndex, storyIndex) {
returnCenter(
child: Text("Index of PageView: $pageIndex Index of story on each page: $storyIndex"),
);
},
storyLength: (pageIndex) {
return3;
},
pageLength: 4,
);
itemBuilder builds the content of each story and is called with the index of the pageView and
the index of the story on the page.
storyLength decides the length of story for each page. The example above always returns 3, but
it should depend on pageIndex.
pageLength is just the length of StoryPageView
The example above just shows 12 stories by 4 pages, which is not practical.
This one is the proper usage, extracted from example.
Once the instance is passed to StoryPageView, you can stop handle the indicator by the methods
below.
/// To pause the indicator
indicatorAnimationController.value = IndicatorAnimationCommand.pause;
/// To resume the indicator
indicatorAnimationController.value = IndicatorAnimationCommand.resume;