FLUTTER ECOSYSTEM

ertgrulll/advstory

一个功能强大的 Flutter 故事查看器。支持图片、视频、自定义小部件内容、手势操作、拦截器、监听器、操纵器等众多功能。

advstory 项目封面
Stars
44
Forks
35
最近推送(UTC)
2023年11月15日
项目状态
未归档
Ertuğrul Yakın GitHub avatar
GITHUB User

Ertuğrul Yakın ↗

I'm a software engineer and mobile developer who loves to create unique things.

Turkey
语言DartRubySwiftKotlinObjective-C

技术话题

此仓库发布的插件

使用的依赖

依赖清单 7 项

原始 README

以下为英文项目原文快照,最新内容请访问 GitHub。

展开 / 收起项目 README
https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLZoq1vLHUTwBd2vqtB84%2Fuploads%2FanFNgKBQRGFKJQ7HK2It%2Fanimated_tray_cover.gif?alt=media&token=7e42ec27-fcec-48d5-8d97-6250d60b5b23

"Buy Me A Coffee" pub package GitHub issues-closed

AdvStory 📸

Quite simple & Quite advanced

🚀 Advanced Story viewer for Flutter. Create and customize slideshow presentations similar to Instagram, TikTok and Snapchat stories. Supports image, video and custom story contents. Full control over stories for developer and smooth experience for users.

Features

➡️ High performance, minimum delays, preload and cache enabled. Works using builders, provides flexibility and lazy loading.

➡️ Story view can be in any shape, size and position or full-screen.

➡️ Predefined story types for images, videos and simple contents. But not limited to these types, allows you to use base class of predefined widgets. This literally makes the options endless.

➡️ Gestures for skip story, skip content, pause, resume and close.

➡️ Interceptors that block events and manipulate the story flow without being noticed by the app user.

➡️ A functional controller for listening interactions and skip stories/contents, pause, play and more...

➡️ Predefined highly customizable story tray. But you are not limited to that, you can create your own non-animated or animated trays, AdvStory handles animation.

➡️ Header and footer areas for predefined stories with customization option specific to a predefined story content.

➡️ Object based, you can create as many story views as you want within the same application.

➡️ Well documented, go to docs:


What can I do using AdvStory?

  • Quite simple: when you don't need much customization, a fully functional story view is just 8 lines of code.
AdvStory(
  storyCount: 5,
  storyBuilder: (storyIndex) => Story(
    contentCount: 10,
    contentBuilder: (contentIndex) => const ImageContent(url: ""),
  ),
  trayBuilder: (index) => AdvStoryTray(url: ""),
);
  • Quite advanced: when you need more you can,
    • create stories asynchronously in storyBuilder, send some requests to your server!
    • create different story trays and tray animations for each story, trays can be any widget you want.
    • create different footer & header areas for each story contents.
    • create contents with different skip durations.
    • create your own contents, AdvStory provides ways to you for caching media and handling story logic.
    • disable gestures, jump to a position, hide and show header/footer areas, pause and resume story via controller.
    • block events and call your own callbacks instead default story flow actions via interceptor.
    • create story view using AdvStory.player to define opening animations, custom shape, size...
    • customize tray list, story progress indicator, loading screen.

If you find AdvStory useful, you can hit the like button and give a star to project on Github to motivate me or treat me with coffee to help me take time to develop this package.


🤝🏼 Supporters & Sponsors

Roadmap
Status Goal
🚀 Custom advanced contents
❌ Custom gestures
🚀 Decouple trays & player
❌ Web & Windows & MacOs & Linux support

Some screenshots:

https://github.com/ertgrulll/advstory/blob/master/github_images/story_view_demo.gif?raw=true https://github.com/ertgrulll/advstory/blob/master/github_images/adv_story_tray_customizations.gif?raw=true