Skip to content

feat: added concealBacklayerOnBackButton option #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daadu merged 4 commits into from
Sep 6, 2023
Merged

feat: added concealBacklayerOnBackButton option #133

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cfdda15
feat: added `concealBacklayerOnBackButton` option
daadu Sep 6, 2023
f3cfc88
not wrapping WillPopScope if opt disabled
daadu Sep 6, 2023
63d6ee2
minor changes
daadu Sep 6, 2023
e06223c
minor changes
daadu Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 59 additions & 49 deletions lib/src/scaffold.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,11 @@ class BackdropScaffold extends StatefulWidget {
/// Defaults to `true`.
final bool maintainBackLayerState;

/// Specifiy whether to conceal [backLayer] when back button pressed.
///
/// Default to `true`.
final bool concealBacklayerOnBackButton;

// ------------- PROPERTIES TAKEN OVER FROM SCAFFOLD ------------- //

/// A key to use when building the [Scaffold].
Expand Down Expand Up @@ -331,6 +336,7 @@ class BackdropScaffold extends StatefulWidget {
this.onBackLayerConcealed,
this.onBackLayerRevealed,
this.maintainBackLayerState = true,
this.concealBacklayerOnBackButton = true,
this.scaffoldKey,
this.appBar,
this.floatingActionButton,
Expand Down Expand Up @@ -600,64 +606,68 @@ class BackdropScaffoldState extends State<BackdropScaffold>
);
}

Future<bool> _willPopCallback(BuildContext context) async {
if (isBackLayerRevealed) {
concealBackLayer();
return false;
}
return true;
}

ColorTween _buildBackLayerScrimColorTween() => ColorTween(
begin: Colors.transparent,
end: widget.backLayerScrim,
);

Widget _buildBody(BuildContext context) {
Widget _wrapWillPopScope(BuildContext context, {required Widget child}) {
if (!widget.concealBacklayerOnBackButton) return child;
return WillPopScope(
onWillPop: () => _willPopCallback(context),
child: Scaffold(
key: scaffoldKey,
appBar: widget.appBar,
body: LayoutBuilder(
builder: (context, constraints) {
return Stack(
fit: StackFit.expand,
children: <Widget>[
_buildBackPanel(),
PositionedTransition(
rect: _getPanelAnimation(context, constraints),
child: _buildFrontPanel(context),
),
],
);
},
),
floatingActionButton: widget.floatingActionButton,
floatingActionButtonLocation: widget.floatingActionButtonLocation,
floatingActionButtonAnimator: widget.floatingActionButtonAnimator,
persistentFooterButtons: widget.persistentFooterButtons,
drawer: widget.drawer,
onDrawerChanged: widget.onDrawerChanged,
endDrawer: widget.endDrawer,
onEndDrawerChanged: widget.onEndDrawerChanged,
bottomNavigationBar: widget.bottomNavigationBar,
bottomSheet: widget.bottomSheet,
backgroundColor: widget.backgroundColor,
resizeToAvoidBottomInset: widget.resizeToAvoidBottomInset,
primary: widget.primary,
drawerDragStartBehavior: widget.drawerDragStartBehavior,
extendBody: widget.extendBody,
extendBodyBehindAppBar: widget.extendBodyBehindAppBar,
drawerScrimColor: widget.drawerScrimColor,
drawerEdgeDragWidth: widget.drawerEdgeDragWidth,
drawerEnableOpenDragGesture: widget.drawerEnableOpenDragGesture,
endDrawerEnableOpenDragGesture: widget.endDrawerEnableOpenDragGesture,
restorationId: widget.restorationId,
),
onWillPop: () async {
if (isBackLayerRevealed) {
concealBackLayer();
return false;
}
return true;
},
child: child,
);
}

Widget _buildBody(BuildContext context) => _wrapWillPopScope(
context,
child: Scaffold(
key: scaffoldKey,
appBar: widget.appBar,
body: LayoutBuilder(
builder: (context, constraints) {
return Stack(
fit: StackFit.expand,
children: <Widget>[
_buildBackPanel(),
PositionedTransition(
rect: _getPanelAnimation(context, constraints),
child: _buildFrontPanel(context),
),
],
);
},
),
floatingActionButton: widget.floatingActionButton,
floatingActionButtonLocation: widget.floatingActionButtonLocation,
floatingActionButtonAnimator: widget.floatingActionButtonAnimator,
persistentFooterButtons: widget.persistentFooterButtons,
drawer: widget.drawer,
onDrawerChanged: widget.onDrawerChanged,
endDrawer: widget.endDrawer,
onEndDrawerChanged: widget.onEndDrawerChanged,
bottomNavigationBar: widget.bottomNavigationBar,
bottomSheet: widget.bottomSheet,
backgroundColor: widget.backgroundColor,
resizeToAvoidBottomInset: widget.resizeToAvoidBottomInset,
primary: widget.primary,
drawerDragStartBehavior: widget.drawerDragStartBehavior,
extendBody: widget.extendBody,
extendBodyBehindAppBar: widget.extendBodyBehindAppBar,
drawerScrimColor: widget.drawerScrimColor,
drawerEdgeDragWidth: widget.drawerEdgeDragWidth,
drawerEnableOpenDragGesture: widget.drawerEnableOpenDragGesture,
endDrawerEnableOpenDragGesture: widget.endDrawerEnableOpenDragGesture,
restorationId: widget.restorationId,
),
);

Container _buildBackLayerScrim() => Container(
color: _backLayerScrimColorTween.evaluate(animationController),
height: _backPanelHeight);
Expand Down