Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Proposal document for v1.0

未关闭
  • 哪里不对？
#5 7 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
20/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
停滞
技术栈
dart
领域
frontend

调研方向

审查 v1.0 milestone 和 project，然后检查剩余的 README/tutorial 任务 (#8) 和自动化测试任务 (#78)。完成的要求是解决未完成的目标，并记录或实现已达成一致的 API 和 release 工作，但此提案没有确定单一入口点或范围明确的变更。

由索引模型根据 Issue 内容生成。

描述

epic

This is the proposal document for 1.0 version of the package intended to discuss and finalise the APIs of the package.

List of Objectives

  1. provide easy and quick way to implement all the use cases of backdrop component as defined in Material Design Guideline
  2. implementations should assume defaults but be configurable and extendable by the user for any custom behaviour
  3. code examples of various use-cases should be provided
  4. proper API documentation should be added

APIs

To achieve the above-mentioned objectives following are the public classes that need to be implemented:

  • 1. Backdrop extends InheritedWidget : This class exposes BackdropScaffoldState for any widget down the tree using the convenient Backdrop.of(context). The BackdropScaffoldState in itself exposes some helper methods like fling, showBackLayer, showFrontLayer, underlying Scaffold widget, AnimationController etc.

  • 2. BackdropScaffold extends StatefulWidget : It is the backdrop equivalent to Scaffold widget. This is the main layout widget that implements the core behaviour of the backdrop. It should act as the entry point to implementing backdrop with the most basic use cases as default. Additional behaviours could be added to it using other widgets just like how appBar, drawer, bottomNavigationBar are added with Scaffold.

  • #6 3. BackdropAppBar extends StatefulWidget: It is the backdrop equivalent to AppBar widget. This widget should provide APIs to define the behaviour of the app bar of the backdrop - icon, title, actions, etc. Various app bar uses cases mentioned in the guideline should be configured using this widget.

  • 4. BackdropToggleButtonextends StatelessWidget : A convenient widget to drop in to fling the backdrop back and forth. This could be used in actions in BackdropAppBar to fling backdrop from the right side of the app bar.

  • 5. BackdropNavigationBackLayer extends StatefulWidget : It is the backdrop equivalent of BottomNavigationBar. A convenient widget to implement navigation pattern with the backdrop - using backLayer to display a list of items, tapping on which would display the corresponding widget in frontLayer. BackdropNavigationItem could be used to encapsulate the widget that needs to be displayed, just like how BottomNavigationBarItem is used. However, unlike BottomNavigationBar the UI of a list of items should be configurable by the user.

Other Tasks

  • API documentation of all Classes, Properties and Methods using Effective Dart: Documentation Guide.
  • #26 add SubHeader to Backdrop Front Layer as specified in the MDG.
  • #7 Demo app that demonstrates all use-cases of Backdrop as mentioned in the Material Design Guideline.
  • #8 Proper README and additional tutorial guides (optional) to make easier for user to get started with package.
  • deprecate attributes and widgets
  • ci-cd tooling (preferably Github Action) to update github pages when master is updated.
  • #78 automatic testing with ci-cd

Quick Links

主要语言
Dart
星标
347
派生
36
30 天内没有已合并 PR

环境准备

我们还没有检查这个项目的环境配置文件。先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

fluttercommunity/backdrop 的其他 Issue

查看 fluttercommunity/backdrop 的全部 Issue

相似的 Issue

更多 Dart Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。