一个 Flutter 包,使开发者能够在其应用中创建类似 Instagram 的故事界面。它提供可自定义的故事组件,如可滑动卡片、计时器和交互元素,模仿流行社交媒体故事的外观和感觉。该包支持 Android、iOS、Web、macOS、Windows 和 Linux 等多个平台,非常适合跨平台应用。通过简单的 API,它可以轻松集成图像和视频播放、进度指示器以及用户交互等功能。
适合场景
社交媒体应用
交互式教程
用户入门流程
内容共享功能
以参与度驱动的用户界面
主要特点
可滑动的故事卡片
内置故事计时器
跨平台支持
可自定义的 UI 组件
媒体播放(图像/视频)
互动故事元素
适合对象
开发社交应用的开发者
创建引人入胜的用户体验的团队
需要限时内容展示的应用程序
具有多平台部署需求的项目
希望实现原生故事界面的设计师
使用建议
需要仔细处理媒体资产
可能需要额外的样式以保持品牌一致性
有限的内置分析功能
未针对超长故事序列进行优化
依赖外部依赖项以实现高级功能
原始 README
以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。
This package allows you to create a storyboard like Instagram
For now it's just an early release with a lot of useful functionality missing
but it's already usable with some minor tweaks
Features
Present:
A list of story buttons that can be marked as "watched" automatically
3D page view list view in Instagram
Custom navigation
Default story scaffold
Missing yet:
Button preloaders that allow the stories to be requested from the backend before opening
Lazy loaders that preload visible the stories from the backend in the background
Getting started
The easiest way to get started is to use a built-in StoryListView to create story buttons
It accepts a list of StoryButtonData objects. These objects contain all the settings for each story including the list of pages, the timing for each page and many other settings. The pages can be completely custom, they're just widgets.
Usage
Here's the completely working example:
class_StoryExamplePageStateextendsState<StoryExamplePage> {
Widget_createDummyPage({
requiredString text,
requiredString imageName,
bool addBottomBar = true,
}) {
returnStoryPageScaffold(
bottomNavigationBar: addBottomBar
? SizedBox(
width: double.infinity,
height: kBottomNavigationBarHeight,
child: Padding(
padding: constEdgeInsets.symmetric(
vertical: 8.0,
horizontal: 20.0,
),
child: Row(
children: [
Expanded(
child: Container(
width: double.infinity,
height: double.infinity,
decoration: BoxDecoration(
border: Border.all(
color: Colors.white,
width: 2.0,
),
borderRadius: BorderRadius.circular(
50.0,
),
),
),
),
constPadding(
padding: EdgeInsets.all(8.0),
child: Icon(
Icons.send,
color: Colors.white,
),
),
],
),
),
)
: constSizedBox.shrink(),
body: Container(
width: double.infinity,
height: double.infinity,
decoration: BoxDecoration(
image: DecorationImage(
image: AssetImage(
'assets/images/$imageName.png',
),
fit: BoxFit.cover,
),
),
child: Padding(
padding: constEdgeInsets.all(8.0),
child: Column(
mainAxisSize: MainAxisSize.max,
mainAxisAlignment: MainAxisAlignment.end,
children: [
Text(
text,
style: constTextStyle(
color: Colors.white,
fontSize: 30.0,
fontWeight: FontWeight.bold,
),
)
],
),
),
),
);
}
Widget_buildButtonText(String text) {
returnPadding(
padding: constEdgeInsets.all(5.0),
child: Column(
mainAxisSize: MainAxisSize.max,
mainAxisAlignment: MainAxisAlignment.end,
children: [
Text(
text,
style: constTextStyle(
color: Colors.white,
fontWeight: FontWeight.bold,
),
),
],
),
);
}
BoxDecoration_buildButtonDecoration(
String imageName,
) {
returnBoxDecoration(
image: DecorationImage(
image: AssetImage(
'assets/images/$imageName.png',
),
fit: BoxFit.cover,
),
);
}
BoxDecoration_buildBorderDecoration(Color color) {
returnBoxDecoration(
borderRadius: constBorderRadius.all(
Radius.circular(15.0),
),
border: Border.fromBorderSide(
BorderSide(
color: color,
width: 1.5,
),
),
);
}
@overrideWidgetbuild(BuildContext context) {
returnScaffold(
appBar: AppBar(
elevation: 0.0,
title: constText('Story Example'),
),
body: Column(
children: [
StoryListView(
pageTransform: constStoryPage3DTransform(),
buttonDatas: [
StoryButtonData(
timelineBackgroundColor: Colors.red,
buttonDecoration: _buildButtonDecoration('car'),
child: _buildButtonText('Want a new car?'),
borderDecoration: _buildBorderDecoration(Colors.red),
storyPages: [
_createDummyPage(
text:
'Want to buy a new car? Get our loan for the rest of your life!',
imageName: 'car',
),
_createDummyPage(
text:
'Can\'t return the loan? Don\'t worry, we\'ll take your soul as a collateral ;-)',
imageName: 'car',
),
],
segmentDuration: constDuration(seconds: 3),
),
StoryButtonData(
timelineBackgroundColor: Colors.blue,
buttonDecoration: _buildButtonDecoration('travel_1'),
borderDecoration:
_buildBorderDecoration(constColor.fromARGB(255, 134, 119, 95)),
child: _buildButtonText('Travel whereever'),
storyPages: [
_createDummyPage(
text: 'Get a loan',
imageName: 'travel_1',
addBottomBar: false,
),
_createDummyPage(
text: 'Select a place where you want to go',
imageName: 'travel_2',
addBottomBar: false,
),
_createDummyPage(
text: 'Dream about the place and pay our interest',
imageName: 'travel_3',
addBottomBar: false,
),
],
segmentDuration: constDuration(seconds: 3),
),
StoryButtonData(
timelineBackgroundColor: Colors.orange,
borderDecoration: _buildBorderDecoration(Colors.orange),
buttonDecoration: _buildButtonDecoration('house'),
child: _buildButtonText('Buy a house anywhere'),
storyPages: [
_createDummyPage(
text: 'You cannot buy a house. Live with it',
imageName: 'house',
),
],
segmentDuration: constDuration(seconds: 5),
),
StoryButtonData(
timelineBackgroundColor: Colors.red,
buttonDecoration: _buildButtonDecoration('car'),
child: _buildButtonText('Want a new car?'),
borderDecoration: _buildBorderDecoration(Colors.red),
storyPages: [
_createDummyPage(
text:
'Want to buy a new car? Get our loan for the rest of your life!',
imageName: 'car',
),
_createDummyPage(
text:
'Can\'t return the loan? Don\'t worry, we\'ll take your soul as a collateral ;-)',
imageName: 'car',
),
],
segmentDuration: constDuration(seconds: 3),
),
StoryButtonData(
buttonDecoration: _buildButtonDecoration('travel_1'),
borderDecoration:
_buildBorderDecoration(constColor.fromARGB(255, 134, 119, 95)),
child: _buildButtonText('Travel whereever'),
storyPages: [
_createDummyPage(
text: 'Get a loan',
imageName: 'travel_1',
addBottomBar: false,
),
_createDummyPage(
text: 'Select a place where you want to go',
imageName: 'travel_2',
addBottomBar: false,
),
_createDummyPage(
text: 'Dream about the place and pay our interest',
imageName: 'travel_3',
addBottomBar: false,
),
],
segmentDuration: constDuration(seconds: 3),
),
StoryButtonData(
timelineBackgroundColor: Colors.orange,
borderDecoration: _buildBorderDecoration(Colors.orange),
buttonDecoration: _buildButtonDecoration('house'),
child: _buildButtonText('Buy a house anywhere'),
storyPages: [
_createDummyPage(
text: 'You cannot buy a house. Live with it',
imageName: 'house',
),
],
segmentDuration: constDuration(seconds: 5),
),
],
),
],
),
);
}
}
Additional information
The package is under lazy construction. It is required in some projects I'm working on but not so much yet so I'm not implementing new features very quickly
If you want to take part in the development, please feel free to make pull requests
but make sure your code corresponds to major Dart language guidelines