Overlay
Sheet
A modal sheet is an alternative to a menu or a dialog and prevents the user from interacting with the rest of the app.
It navigates to a new page each time.
A closely related widget is a persistent sheet, which shows information that supplements the primary content of the app without preventing the user from interacting with the app.
Column(
mainAxisAlignment: MainAxisAlignment.center,
mainAxisSize: MainAxisSize.min,
spacing: 5,
children: [
FButton(
child: const Text('Left'),
onPress: () => showFSheet(
context: context,
side: FLayout.ltr,
builder: (context) => const Form(side: FLayout.ltr),
),
),
FButton(
child: const Text('Top'),
onPress: () => showFSheet(
context: context,
side: FLayout.ttb,
builder: (context) => const Form(side: FLayout.ttb),
),
),
FButton(
child: const Text('Right'),
onPress: () => showFSheet(
context: context,
side: FLayout.rtl,
builder: (context) => const Form(side: FLayout.rtl),
),
),
FButton(
child: const Text('Bottom'),
onPress: () => showFSheet(
context: context,
side: FLayout.btt,
builder: (context) => const Form(side: FLayout.btt),
),
),
],
);
class Form extends StatelessWidget {
final FLayout side;
const Form({required this.side, super.key});
@override
Widget build(BuildContext context) => Container(
height: double.infinity,
width: double.infinity,
decoration: BoxDecoration(
color: context.theme.colors.background,
border: side.vertical
? Border.symmetric(horizontal: BorderSide(color: context.theme.colors.border))
: Border.symmetric(vertical: BorderSide(color: context.theme.colors.border)),
),
child: Padding(
padding: const EdgeInsets.symmetric(horizontal: 15, vertical: 8.0),
child: Center(
child: Column(
mainAxisSize: MainAxisSize.min,
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Text(
'Account',
style: context.theme.typography.xl2.copyWith(
fontWeight: FontWeight.w600,
color: context.theme.colors.foreground,
height: 1.5,
),
),
Text(
'Make changes to your account here. Click save when you are done.',
style: context.theme.typography.sm.copyWith(color: context.theme.colors.mutedForeground),
),
const SizedBox(height: 8),
SizedBox(
width: 450,
child: Column(
children: [
const FTextField(label: Text('Name'), hint: 'John Renalo'),
const SizedBox(height: 10),
const FTextField(label: Text('Email'), hint: 'john@doe.com'),
const SizedBox(height: 16),
FButton(child: const Text('Save'), onPress: () => Navigator.of(context).pop()),
],
),
),
],
),
),
),
);
}CLI
To generate and customize this style:
dart run forui style create modal-sheetUsage
showFSheet(...)
showFSheet(
context: context,
side: FLayout.ltr,
useRootNavigator: false,
style: (style) => style.copyWith(...),
mainAxisMaxRatio: 9 / 16,
useSafeArea: false,
resizeToAvoidBottomInset: true,
barrierLabel: 'Dismiss',
barrierDismissible: true,
constraints: BoxConstraints(),
draggable: true,
routeSettings: RouteSettings(),
transitionAnimationController: AnimationController(...),
anchorPoint: Offset.zero,
onClosing: () {},
builder: (context) => const Placeholder(),
);Examples
Blurred Barrier
FButton(
child: const Text('Open'),
onPress: () => showFSheet(
style: (style) => style.copyWith(
barrierFilter: (animation) => ImageFilter.compose(
outer: ImageFilter.blur(sigmaX: animation * 5, sigmaY: animation * 5),
inner: ColorFilter.mode(context.theme.colors.barrier, BlendMode.srcOver),
),
),
context: context,
side: FLayout.ltr,
builder: (context) => const Form(side: FLayout.ltr),
),
);
class Form extends StatelessWidget {
final FLayout side;
const Form({required this.side, super.key});
@override
Widget build(BuildContext context) => Container(
height: double.infinity,
width: double.infinity,
decoration: BoxDecoration(
color: context.theme.colors.background,
border: side.vertical
? Border.symmetric(horizontal: BorderSide(color: context.theme.colors.border))
: Border.symmetric(vertical: BorderSide(color: context.theme.colors.border)),
),
child: Padding(
padding: const EdgeInsets.symmetric(horizontal: 15, vertical: 8.0),
child: Center(
child: Column(
mainAxisSize: MainAxisSize.min,
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Text(
'Account',
style: context.theme.typography.xl2.copyWith(
fontWeight: FontWeight.w600,
color: context.theme.colors.foreground,
height: 1.5,
),
),
Text(
'Make changes to your account here. Click save when you are done.',
style: context.theme.typography.sm.copyWith(color: context.theme.colors.mutedForeground),
),
const SizedBox(height: 8),
SizedBox(
width: 450,
child: Column(
children: [
const FTextField(label: Text('Name'), hint: 'John Renalo'),
const SizedBox(height: 10),
const FTextField(label: Text('Email'), hint: 'john@doe.com'),
const SizedBox(height: 16),
FButton(child: const Text('Save'), onPress: () => Navigator.of(context).pop()),
],
),
),
],
),
),
),
);
}With DraggableScrollableSheet
FButton(
child: const Text('Click me'),
onPress: () => showFSheet(
context: context,
side: FLayout.btt,
mainAxisMaxRatio: null,
builder: (context) => DraggableScrollableSheet(
expand: false,
builder: (context, controller) => ScrollConfiguration(
// This is required to enable dragging on desktop.
// See https://github.com/flutter/flutter/issues/101903 for more information.
behavior: ScrollConfiguration.of(context).copyWith(
dragDevices: {PointerDeviceKind.touch, PointerDeviceKind.mouse, PointerDeviceKind.trackpad},
),
child: FTileGroup.builder(
count: 25,
scrollController: controller,
tileBuilder: (context, index) => FTile(title: Text('Tile $index')),
),
),
),
),
);