responsiveness 1.0.4 responsiveness: ^1.0.4 copied to clipboard
A minimal responsive framework for building UI for all screen sizes using the Bootstrap breakpoints.
A minimal, easy to use responsive framework for building UI for all screen sizes using the Boostrap breakpoints.
1. Background #
When I was first given the task to develop a flutter application for all screen sizes I was overwhelmed and clueless. Even though flutter provides widgets like LayoutBuilder
or MediaQuery
to enable responsive UI development, I found making use of those widgets in an easy, readable, predictable manner quite difficult.
Because you still need to figure out:
- What brekpoints you want to use
- How to identify the current breakpoint given the screen width
- How to define a UI based on the current breakpoint in an easy, readable manner
This package is the result of me trying to answer the above mentioned questions and offers thereby an oppionated approach for developing responsive UI using flutter.
2. Breakpoints #
This package uses the Boostrap breakpoints:
short name | long name | minimum width | devices |
---|---|---|---|
xs | extra small | 0 | portrait phones |
sm | small | 576 | landscape phones |
md | medium | 768 | tablets |
lg | large | 992 | destkops |
xl | extra large | 1200 | large destkops |
xxl | xx-large | 1400 | larger destkops |
The minimum widths in the above table are used by default, but you can also customize them, as shown [here](#Getting started).
3. Getting started #
To use this package in your app you need to wrap you widget tree with BreakpointProvider
like so:
class MyApp extends StatelessWidget {
const MyApp({super.key});
@override
Widget build(BuildContext context) {
return MaterialApp(
home: const MyHomePage(),
builder: (context, child) {
return BreakpointProvider(child: child);
},
);
}
}
The BreakpointProvider
identifys the current breakpoint and provides that information to the subtree.
By setting the breakpoints
parameter of the BreakpointProvider
you can customize the minimum widths of the six screen sizes xs, sm, md, lg, xl and xxl.
BreakpointProvider(
breakpoints: Breakpoints(
xs: 0, //has to always remain 0
sm: 577,//default is 576
md: 800,//default is 768
lg: 1000,//default is 992
xl: 1201,//default is 1200
xxl: 1402,//default is 1400
),
child: child,
)
Nevertheless, I advise you to use the default values as they have been well thought through and proven themselves over time.
4. Creating the UI #
The following three Classes can be used to defina a responsive UI in an easy, readable manner.
-
ResponsiveValue #
The
ResponsiveValue
allows you to provide different values based on the curren screen size. The value it provides can be anything from adouble
to aWidget
.Definition:
static const fontSize = ResponsiveValue<double>(xs: 20.0, sm,: 21.0, md: 22.0); static const fontColor = ResponsiveValue<Color>(md: Colors.green, lg: Colors.red);
Usage:
@override Widget build(BuildContext context) { return Text( "Hello World", style: TextStyle( fontSize: fontSize.of(context), color: fontColor.of(context), ), );
Note that you do not need to specify a value for every screen size. You need to only provide at least one, but can also provide more than one or all. If you didn't provide a value for a screen size, the value from the nearest one will be used.
For example consider:
static const fontSize = ResponsiveValue<double>(xs: 20.0, sm,: 21.0, md: 22.0);
In this case only values for the screen sizes xs, sm and md were specified. Nevertheless for the screen sizes lg, xl, and xxl the value from the screen size md will be used as it is the nearest screen size to the three.
Next take a look at:
static const fontSize = ResponsiveValue<double>(xs: 20.0, md: 22.0);
In this case no value is specified for the screen size
sm
which is betweenxs
andmd
. The above mentioned rule of using the value of the nearest screen size would not work in this example as there are two nearest screen sizes. So in that case the value of the smaller screen size will be used. In this example that would be the value of the screen sizexs
. -
ResponsiveChild #
The ResponsiveChild
widget allows you to provide different widgets based on the current screen size. Just like in the case ofResponsiveValue
, you do not need to specify a widget for every single one of the six differnt possible screen sizes. A widget for at least on screen size needs to be given.In code:
@override Widget build(BuildContext context) { return ResponsiveChild( xs: Text("show when screen size is xs"), sm: Text("show when screen size is sm"), md: Text("show when screen size is md"), lg: Text("show when screen size is lg"), xl: Text("show when screen size is xl"), xxl: Text("show when screen size is xxl"), );
-
ResponsiveParent #
The ResponsiveParent
widget allows you to wrap a givenObject
with differentWidget
s based on the current screen size.
To wrap theObject
that you provided using thechild
parameter, you need to specify a callback for at least one of the six different possible screen sizes. This callback receives the givenchild
as a parameter and returns a newWidget
. Inside the callback you can for example wrap thechild
with aColumn
orRow
and return the newly createdWidget
Just like in the case ofResponsiveValue
andResponsiveChild
the callback of the nearest screen size will be used if it is not defined for a particular screen size.In code:
//displays a column or row based on the current scren size @override Widget build(BuildContext context) { return ResponsiveParent<List<Widget>>( xs: (child) => Column(children: child), md: (child) => Row(children: child), child: [], //some children Widgets );